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 b0692b120..570e53280 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 @@ -530,6 +530,3174 @@ } } }, + "/agents/repos/{owner}/{repo}/tasks": { + "get": { + "summary": "List tasks for repository", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n\n**Fine-grained access tokens for \"List tasks for repository\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Start a task", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nStarts a new Copilot cloud agent task for a repository.\n\nThis endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription.\n\n**Fine-grained access tokens for \"Start a task\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read and write)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/create-task-in-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#start-a-task" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + } + ], + "requestBody": { + "required": true, + "description": "The task creation parameters, including the user's prompt and optional agent settings.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "prompt" + ], + "properties": { + "prompt": { + "type": "string", + "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`" + }, + "create_pull_request": { + "type": "boolean", + "description": "Whether to create a PR.", + "default": false + }, + "base_ref": { + "type": "string", + "description": "Base ref for new branch/PR" + } + } + }, + "examples": { + "default": { + "value": { + "prompt": "Fix the login button on the homepage", + "base_ref": "main" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Task created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "queued", + "session_count": 1, + "artifacts": [], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "400": { + "description": "Problems parsing JSON", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/repos/{owner}/{repo}/tasks/{task_id}": { + "get": { + "summary": "Get a task by repo", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n\n**Fine-grained access tokens for \"Get a task by repo\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-repo-and-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "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": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks": { + "get": { + "summary": "List tasks", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n\n**Fine-grained access tokens for \"List tasks\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks/{task_id}": { + "get": { + "summary": "Get a task by ID", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n\n**Fine-grained access tokens for \"Get a task by ID\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "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": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, "/app": { "get": { "summary": "Get the authenticated app", @@ -14726,7 +17894,7 @@ "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { "post": { "summary": "Set cluster deployment records", - "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.", + "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.\nNote: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments\narray resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use\nthe artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can\nonly have one name and version.", "tags": [ "orgs" ], @@ -14779,20 +17947,20 @@ "properties": { "name": { "type": "string", - "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", + "description": "The name of the artifact.", "minLength": 1, "maxLength": 256 }, "digest": { "type": "string", - "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", + "description": "The hex encoded digest of the artifact.", "minLength": 71, "maxLength": 71, "pattern": "^sha256:[a-f0-9]{64}$" }, "version": { "type": "string", - "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", + "description": "The artifact version.", "maxLength": 100, "x-multi-segment": true, "examples": [ @@ -28114,7 +31282,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -28199,7 +31367,393 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication.", + "type": "string", + "enum": [ + "token", + "username_password", + "oidc_azure", + "oidc_aws", + "oidc_jfrog", + "oidc_cloudsmith", + "oidc_gcp" + ] + }, + "tenant_id": { + "description": "The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`.", + "type": "string" + }, + "client_id": { + "description": "The client ID of the Azure AD application. Required when `auth_type` is `oidc_azure`.", + "type": "string" + }, + "aws_region": { + "description": "The AWS region. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "account_id": { + "description": "The AWS account ID. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "role_name": { + "description": "The AWS IAM role name. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "domain": { + "description": "The CodeArtifact domain. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "domain_owner": { + "description": "The CodeArtifact domain owner (AWS account ID). Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "jfrog_oidc_provider_name": { + "description": "The JFrog OIDC provider name. Required when `auth_type` is `oidc_jfrog`.", + "type": "string" + }, + "audience": { + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.", + "type": "string" + }, + "identity_mapping_name": { + "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", + "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" + }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). Required when `auth_type` is `oidc_gcp`.", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + } + }, + "required": [ + "registry_type", + "url", + "visibility" + ] + }, + "examples": { + "org-private-registry-with-private-visibility": { + "summary": "Example of a private registry configuration with private visibility", + "value": { + "registry_type": "maven_repository", + "url": "https://maven.pkg.github.com/organization/", + "username": "monalisa", + "replaces_base": true, + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "private" + } + }, + "org-private-registry-with-selected-visibility": { + "summary": "Example of a private registry configuration with selected visibility", + "value": { + "registry_type": "maven_repository", + "url": "https://maven.pkg.github.com/organization/", + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + }, + "org-private-registry-with-oidc-azure": { + "summary": "Example of an OIDC private registry configuration using Azure", + "value": { + "registry_type": "docker_registry", + "url": "https://myregistry.azurecr.io", + "auth_type": "oidc_azure", + "visibility": "all", + "tenant_id": "12345678-1234-1234-1234-123456789012", + "client_id": "abcdef01-2345-6789-abcd-ef0123456789" + } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } + }, + "org-private-registry-with-oidc-gcp": { + "summary": "Example of an OIDC private registry configuration using Google Cloud Artifact Registry", + "value": { + "registry_type": "docker_registry", + "url": "https://us-docker.pkg.dev/my-project/my-repo", + "auth_type": "oidc_gcp", + "visibility": "all", + "workload_identity_provider": "projects/123456789/locations/global/workloadIdentityPools/github-pool/providers/github-provider", + "service_account": "dependabot@my-project.iam.gserviceaccount.com" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "The organization private registry configuration", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-private-registry-configuration-with-selected-repositories" + }, + "examples": { + "org-private-registry-with-selected-visibility": { + "$ref": "#/components/examples/org-private-registry-configuration" + }, + "org-private-registry-with-private-visibility": { + "$ref": "#/components/examples/org-private-registry-configuration-with-selected-repositories" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + } + }, + "/orgs/{org}/private-registries/public-key": { + "get": { + "summary": "Get private registries public key for an organization", + "description": "\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key_id", + "key" + ], + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "examples": [ + "012345678912345678" + ] + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "examples": [ + "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + ] + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/private-registries-public-key" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + } + }, + "/orgs/{org}/private-registries/{secret_name}": { + "get": { + "summary": "Get a private registry for an organization", + "description": "\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/get-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "The specified private registry configuration for the organization", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-private-registry-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-private-registry-configuration" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + }, + "patch": { + "summary": "Update a private registry for an organization", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/update-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "registry_type": { + "description": "The registry type.", + "type": "string", + "enum": [ + "maven_repository", + "nuget_feed", + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" + ] + }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, + "username": { + "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", + "type": [ + "string", + "null" + ] + }, + "replaces_base": { + "description": "Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, + "encrypted_value": { + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "description": "The ID of the key you used to encrypt the secret.", + "type": "string" + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "type": "string", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`.", + "type": "array", + "items": { + "type": "integer" + } + }, + "auth_type": { + "description": "The authentication type for the private registry. This field cannot be changed after creation. If provided, it must match the existing `auth_type` of the configuration. To change the authentication type, delete and recreate the configuration.", "type": "string", "enum": [ "token", @@ -28207,7 +31761,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -28243,7 +31798,7 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { @@ -28261,371 +31816,13 @@ "api_host": { "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", "type": "string" - } - }, - "required": [ - "registry_type", - "url", - "visibility" - ] - }, - "examples": { - "org-private-registry-with-private-visibility": { - "summary": "Example of a private registry configuration with private visibility", - "value": { - "registry_type": "maven_repository", - "url": "https://maven.pkg.github.com/organization/", - "username": "monalisa", - "replaces_base": true, - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "private" - } - }, - "org-private-registry-with-selected-visibility": { - "summary": "Example of a private registry configuration with selected visibility", - "value": { - "registry_type": "maven_repository", - "url": "https://maven.pkg.github.com/organization/", - "username": "monalisa", - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - } - }, - "org-private-registry-with-oidc-azure": { - "summary": "Example of an OIDC private registry configuration using Azure", - "value": { - "registry_type": "docker_registry", - "url": "https://myregistry.azurecr.io", - "auth_type": "oidc_azure", - "visibility": "all", - "tenant_id": "12345678-1234-1234-1234-123456789012", - "client_id": "abcdef01-2345-6789-abcd-ef0123456789" - } - }, - "org-private-registry-with-oidc-cloudsmith": { - "summary": "Example of an OIDC private registry configuration using Cloudsmith", - "value": { - "registry_type": "npm_registry", - "url": "https://npm.cloudsmith.io/my-org/my-repo/", - "auth_type": "oidc_cloudsmith", - "visibility": "all", - "namespace": "my-org", - "service_slug": "my-service-account", - "audience": "https://github.com/my-org" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "The organization private registry configuration", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/org-private-registry-configuration-with-selected-repositories" - }, - "examples": { - "org-private-registry-with-selected-visibility": { - "$ref": "#/components/examples/org-private-registry-configuration" }, - "org-private-registry-with-private-visibility": { - "$ref": "#/components/examples/org-private-registry-configuration-with-selected-repositories" - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "private-registries", - "subcategory": "organization-configurations" - } - } - }, - "/orgs/{org}/private-registries/public-key": { - "get": { - "summary": "Get private registries public key for an organization", - "description": "\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "private-registries" - ], - "operationId": "private-registries/get-org-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "key_id", - "key" - ], - "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "examples": [ - "012345678912345678" - ] - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "examples": [ - "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - ] - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/private-registries-public-key" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "private-registries", - "subcategory": "organization-configurations" - } - } - }, - "/orgs/{org}/private-registries/{secret_name}": { - "get": { - "summary": "Get a private registry for an organization", - "description": "\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "private-registries" - ], - "operationId": "private-registries/get-org-private-registry", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "responses": { - "200": { - "description": "The specified private registry configuration for the organization", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/org-private-registry-configuration" - }, - "examples": { - "default": { - "$ref": "#/components/examples/org-private-registry-configuration" - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "private-registries", - "subcategory": "organization-configurations" - } - }, - "patch": { - "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "private-registries" - ], - "operationId": "private-registries/update-org-private-registry", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "registry_type": { - "description": "The registry type.", - "type": "string", - "enum": [ - "maven_repository", - "nuget_feed", - "goproxy_server", - "npm_registry", - "rubygems_server", - "cargo_registry", - "composer_repository", - "docker_registry", - "git_source", - "helm_registry", - "hex_organization", - "hex_repository", - "pub_repository", - "python_index", - "terraform_registry" - ] - }, - "url": { - "description": "The URL of the private registry.", - "type": "string", - "format": "uri" - }, - "username": { - "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", - "type": [ - "string", - "null" - ] - }, - "replaces_base": { - "description": "Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", - "type": "boolean", - "default": false - }, - "encrypted_value": { - "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", - "type": "string", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "description": "The ID of the key you used to encrypt the secret.", - "type": "string" - }, - "visibility": { - "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", - "type": "string", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`.", - "type": "array", - "items": { - "type": "integer" - } - }, - "auth_type": { - "description": "The authentication type for the private registry. This field cannot be changed after creation. If provided, it must match the existing `auth_type` of the configuration. To change the authentication type, delete and recreate the configuration.", - "type": "string", - "enum": [ - "token", - "username_password", - "oidc_azure", - "oidc_aws", - "oidc_jfrog", - "oidc_cloudsmith" - ] - }, - "tenant_id": { - "description": "The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`.", + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). Required when `auth_type` is `oidc_gcp`.", "type": "string" }, - "client_id": { - "description": "The client ID of the Azure AD application. Required when `auth_type` is `oidc_azure`.", - "type": "string" - }, - "aws_region": { - "description": "The AWS region. Required when `auth_type` is `oidc_aws`.", - "type": "string" - }, - "account_id": { - "description": "The AWS account ID. Required when `auth_type` is `oidc_aws`.", - "type": "string" - }, - "role_name": { - "description": "The AWS IAM role name. Required when `auth_type` is `oidc_aws`.", - "type": "string" - }, - "domain": { - "description": "The CodeArtifact domain. Required when `auth_type` is `oidc_aws`.", - "type": "string" - }, - "domain_owner": { - "description": "The CodeArtifact domain owner (AWS account ID). Required when `auth_type` is `oidc_aws`.", - "type": "string" - }, - "jfrog_oidc_provider_name": { - "description": "The JFrog OIDC provider name. Required when `auth_type` is `oidc_jfrog`.", - "type": "string" - }, - "audience": { - "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", - "type": "string" - }, - "identity_mapping_name": { - "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", - "type": "string" - }, - "namespace": { - "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", - "type": "string" - }, - "service_slug": { - "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", - "type": "string" - }, - "api_host": { - "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "service_account": { + "description": "The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).", "type": "string" } } @@ -31818,6 +35015,9 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-bypassed" } ], "responses": { @@ -35242,6 +38442,139 @@ } } }, + "/repos/{owner}/{repo}/actions/concurrency_groups": { + "get": { + "summary": "List concurrency groups for a repository", + "description": "Lists the active concurrency groups for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-concurrency-groups-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/concurrency-group-list" + }, + "examples": { + "default": { + "$ref": "#/components/examples/concurrency-group-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "concurrency-groups" + } + } + }, + "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}": { + "get": { + "summary": "Get a concurrency group for a repository", + "description": "Gets a specific concurrency group for a repository, including all instances in the group's queue.\nReturns 404 if the group is inactive or does not exist.\n\nOptionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items\nahead of the specified workflow run or job in the queue, plus the specified item itself\n(returned as the last element). This is useful for determining what is blocking a particular\nrun or job. Returns 422 if the specified run or job is not in this concurrency group.\n\nWhen using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow\nleases held on behalf of that run. Job-level leases within the run are not considered to\nblock the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow\nleases on the job's ancestor paths.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/get-concurrency-group-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/concurrency-group-name" + }, + { + "name": "ahead_of_run", + "description": "Filter to items ahead of this workflow run ID in the queue, plus the run itself.\nMatches workflow-level concurrency and reusable-workflow leases held on behalf of\nthe run. Mutually exclusive with `ahead_of_job`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + }, + { + "name": "ahead_of_job", + "description": "Filter to items ahead of this job ID in the queue, plus the job itself.\nMatches job-level concurrency and reusable-workflow leases on the job's\nancestor paths. Mutually exclusive with `ahead_of_run`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/concurrency-group" + }, + "examples": { + "default": { + "$ref": "#/components/examples/concurrency-group" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "concurrency-groups" + } + } + }, "/repos/{owner}/{repo}/actions/jobs/{job_id}": { "get": { "summary": "Get a job for a workflow run", @@ -37655,6 +40988,74 @@ } } }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups": { + "get": { + "summary": "List concurrency groups for a workflow run", + "description": "Lists all concurrency groups associated with a workflow run or its jobs.\n\nThe set of groups is derived from the run's configuration, so a group is\nincluded even when the run no longer has any items currently holding or\nwaiting in it. In that case the `group_members` array will be empty.\n`total_count` reflects the number of groups the run participates in by\nconfiguration, not the number with active items.\n\nThis differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`,\nwhich returns 404 when a group has no active items. That endpoint reports\nthe live state of a group repo-wide, while this endpoint reports the\ngroups associated with a specific run by configuration.\n\nResults are sorted by group name and support cursor-based pagination via\n`before` and `after`. The `after` cursor paginates forward only and does\nnot emit a `rel=\"prev\"` Link; use `before` to page backward from a\nforward page's `next` cursor.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-concurrency-groups-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/concurrency-group-run-list" + }, + "examples": { + "default": { + "$ref": "#/components/examples/concurrency-group-run-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "concurrency-groups" + } + } + }, "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { "post": { "summary": "Review custom deployment protection rules for a workflow run", @@ -66460,6 +69861,9 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-bypassed" } ], "responses": { @@ -123473,7 +126877,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -123558,6 +126963,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -123616,7 +127029,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -123705,6 +127119,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -130867,6 +134289,144 @@ "actions_caches" ] }, + "concurrency-group-list": { + "title": "Concurrency Group List", + "description": "A list of active concurrency groups for a repository.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "last_acquired_at" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "last_acquired_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + } + } + } + } + }, + "concurrency-group": { + "title": "Concurrency Group", + "description": "A concurrency group with the workflow runs and jobs that are either currently holding\nor waiting for the concurrency group lease.", + "type": "object", + "required": [ + "group_name", + "group_url", + "total_count", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "total_count": { + "type": "integer" + }, + "group_members": { + "type": "array", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "job_id": { + "type": "integer", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + }, "job": { "title": "Job", "description": "Information of a job execution in a workflow run", @@ -131798,6 +135358,131 @@ "comment" ] }, + "concurrency-group-run-list": { + "title": "Concurrency Group Run List", + "description": "A list of concurrency groups associated with a workflow run.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer", + "description": "The total number of concurrency groups this workflow run participates in,\nderived from the run's configuration. This count is not filtered by\nwhether the run currently holds or is waiting in each group, so it can\ninclude groups whose `group_members` array is empty (for example, when\nthe run has already released its lease in that group)." + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group. May return 404 if the group\nhas no active items at the time it is requested, since the\nget-by-name endpoint reports the live repo-wide state of a group\nwhile this endpoint lists groups associated with a run by\nconfiguration." + }, + "group_members": { + "type": "array", + "description": "Items belonging to this workflow run that are either currently holding or\nwaiting for the concurrency group lease. May be empty if the run no\nlonger has any active or queued items in this group.", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status", + "position", + "position_url" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "position": { + "type": "integer", + "description": "Queue position. 0 means the item holds the concurrency lease (in_progress), 1 or higher means queued (pending)." + }, + "position_url": { + "type": "string", + "format": "uri", + "description": "API URL to get items ahead of this item in the concurrency group." + }, + "job_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": [ + "string", + "null" + ], + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } + }, "review-custom-gates-comment-required": { "type": "object", "properties": { @@ -312472,6 +316157,57 @@ ] } }, + "concurrency-group-list": { + "value": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "last_acquired_at": "2026-01-15T16:14:23Z" + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "last_acquired_at": "2026-01-15T16:13:55Z" + } + ] + } + }, + "concurrency-group": { + "value": { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "total_count": 3, + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress" + }, + { + "run_id": 30433643, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433643", + "status": "pending" + }, + { + "run_id": 30433644, + "run_name": "Deploy hotfix", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644", + "job_id": 798245260, + "job_name": "deploy", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260", + "status": "pending" + } + ] + } + }, "job": { "value": { "id": 399444496, @@ -313260,6 +316996,47 @@ ] } }, + "concurrency-group-run-list": { + "value": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress", + "position": 0, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642" + } + ] + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "pending", + "position": 2, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260", + "job_id": 798245260, + "job_name": "build", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260" + } + ] + } + ] + } + }, "pending-deployment-items": { "value": [ { @@ -333273,6 +337050,15 @@ "default": false } }, + "secret-scanning-alert-bypassed": { + "name": "is_bypassed", + "in": "query", + "description": "A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.", + "required": false, + "schema": { + "type": "boolean" + } + }, "network-configuration-id": { "name": "network_configuration_id", "description": "Unique identifier of the hosted compute network configuration.", @@ -333406,6 +337192,15 @@ "type": "integer" } }, + "concurrency-group-name": { + "name": "concurrency_group_name", + "description": "The name of the concurrency group.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "job-id": { "name": "job_id", "description": "The unique identifier of the job.", 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 3901c917c..b03133212 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 @@ -343,6 +343,2530 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories + "/agents/repos/{owner}/{repo}/tasks": + get: + summary: List tasks for repository + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for a specific repository + + **Fine-grained access tokens for "List tasks for repository"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/list-tasks-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, + `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived + tasks. When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + - name: creator_id + in: query + schema: + type: integer + description: Filter tasks by creator user ID + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="prev" (when current page > 1), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; + rel="next", ; + rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + post: + summary: Start a task + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Starts a new Copilot cloud agent task for a repository. + + This endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription. + + **Fine-grained access tokens for "Start a task"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read and write) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/create-task-in-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#start-a-task + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + requestBody: + required: true + description: The task creation parameters, including the user's prompt and + optional agent settings. + content: + application/json: + schema: + type: object + required: + - prompt + properties: + prompt: + type: string + 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`' + create_pull_request: + type: boolean + description: Whether to create a PR. + default: false + base_ref: + type: string + description: Base ref for new branch/PR + examples: + default: + value: + prompt: Fix the login button on the homepage + base_ref: main + responses: + '201': + description: Task created successfully + content: + application/json: + schema: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: queued + session_count: 1 + artifacts: [] + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '400': + description: Problems parsing JSON + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/repos/{owner}/{repo}/tasks/{task_id}": + get: + summary: Get a task by repo + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID scoped to an owner/repo path + + **Fine-grained access tokens for "Get a task by repo"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-repo-and-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + allOf: + - type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + 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: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/tasks": + get: + summary: List tasks + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for the authenticated user + + **Fine-grained access tokens for "List tasks"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/list-tasks + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, + `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived + tasks. When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; rel="next", + ; rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/tasks/{task_id}": + get: + summary: Get a task by ID + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID with its associated sessions + + **Fine-grained access tokens for "Get a task by ID"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + allOf: + - type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + 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: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation "/app": get: summary: Get the authenticated app @@ -10653,6 +13177,10 @@ paths: If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. If no existing records match, new records will be created. + Note: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments + array resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use + the artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can + only have one name and version. tags: - orgs operationId: orgs/set-cluster-deployment-records @@ -10695,24 +13223,18 @@ paths: properties: name: type: string - description: | - The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name parameter must also be identical across all entries. + description: The name of the artifact. minLength: 1 maxLength: 256 digest: type: string - description: | - The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name and version parameters must also be identical across all entries. + description: The hex encoded digest of the artifact. minLength: 71 maxLength: 71 pattern: "^sha256:[a-f0-9]{64}$" version: type: string - description: | - The artifact version. Note that if multiple deployments have identical 'digest' parameter values, - the version parameter must also be identical across all entries. + description: The artifact version. maxLength: 100 x-multi-segment: true examples: @@ -20490,7 +23012,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -20584,7 +23106,335 @@ paths: auth_type: description: The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, - or `oidc_cloudsmith` for OIDC authentication. + `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication. + type: string + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + - oidc_cloudsmith + - oidc_gcp + tenant_id: + description: The tenant ID of the Azure AD application. Required + when `auth_type` is `oidc_azure`. + type: string + client_id: + description: The client ID of the Azure AD application. Required + when `auth_type` is `oidc_azure`. + type: string + aws_region: + description: The AWS region. Required when `auth_type` is `oidc_aws`. + type: string + account_id: + description: The AWS account ID. Required when `auth_type` is `oidc_aws`. + type: string + role_name: + description: The AWS IAM role name. Required when `auth_type` is + `oidc_aws`. + type: string + domain: + description: The CodeArtifact domain. Required when `auth_type` + is `oidc_aws`. + type: string + domain_owner: + description: The CodeArtifact domain owner (AWS account ID). Required + when `auth_type` is `oidc_aws`. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. Required when `auth_type` + is `oidc_jfrog`. + type: string + audience: + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and `oidc_gcp`, and required for `oidc_cloudsmith` auth types. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. Optional for `oidc_jfrog` + auth type. + type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + Required when `auth_type` is `oidc_gcp`. + type: string + service_account: + description: The GCP service account email to impersonate. Optional + for `oidc_gcp` auth type. If omitted, the federated token is used + directly (direct WIF). + type: string + required: + - registry_type + - url + - visibility + examples: + org-private-registry-with-private-visibility: + summary: Example of a private registry configuration with private + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + replaces_base: true + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: private + org-private-registry-with-selected-visibility: + summary: Example of a private registry configuration with selected + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + org-private-registry-with-oidc-azure: + summary: Example of an OIDC private registry configuration using Azure + value: + registry_type: docker_registry + url: https://myregistry.azurecr.io + auth_type: oidc_azure + visibility: all + tenant_id: 12345678-1234-1234-1234-123456789012 + client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org + org-private-registry-with-oidc-gcp: + summary: Example of an OIDC private registry configuration using Google + Cloud Artifact Registry + value: + registry_type: docker_registry + url: https://us-docker.pkg.dev/my-project/my-repo + auth_type: oidc_gcp + visibility: all + workload_identity_provider: projects/123456789/locations/global/workloadIdentityPools/github-pool/providers/github-provider + service_account: dependabot@my-project.iam.gserviceaccount.com + responses: + '201': + description: The organization private registry configuration + content: + application/json: + schema: + "$ref": "#/components/schemas/org-private-registry-configuration-with-selected-repositories" + examples: + org-private-registry-with-selected-visibility: + "$ref": "#/components/examples/org-private-registry-configuration" + org-private-registry-with-private-visibility: + "$ref": "#/components/examples/org-private-registry-configuration-with-selected-repositories" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/public-key": + get: + summary: Get private registries public key for an organization + description: |2- + + Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - key_id + - key + properties: + key_id: + description: The identifier for the key. + type: string + examples: + - '012345678912345678' + key: + description: The Base64 encoded public key. + type: string + examples: + - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + examples: + default: + "$ref": "#/components/examples/private-registries-public-key" + headers: + Link: + "$ref": "#/components/headers/link" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/{secret_name}": + get: + summary: Get a private registry for an organization + description: |2- + + Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/secret-name" + responses: + '200': + description: The specified private registry configuration for the organization + content: + application/json: + schema: + "$ref": "#/components/schemas/org-private-registry-configuration" + examples: + default: + "$ref": "#/components/examples/org-private-registry-configuration" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + patch: + summary: Update a private registry for an organization + description: |2- + + Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/update-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/secret-name" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + registry_type: + description: The registry type. + type: string + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the private + registry. This field should be omitted if the private registry + does not require a username for authentication. + type: + - string + - 'null' + replaces_base: + description: Whether this private registry should replace the base + registry (e.g., npmjs.org for npm, rubygems.org for rubygems). + When set to `true`, Dependabot will only use this registry and + will not fall back to the public registry. When set to `false` + (default), Dependabot will use this registry for scoped packages + but may fall back to the public registry for other packages. + type: boolean + default: false + encrypted_value: + description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get private registries + public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + endpoint. + type: string + pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + key_id: + description: The ID of the key you used to encrypt the secret. + type: string + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + type: string + enum: + - all + - private + - selected + selected_repository_ids: + description: An array of repository IDs that can access the organization + private registry. You can only provide a list of repository IDs + when `visibility` is set to `selected`. This field should be omitted + if `visibility` is set to `all` or `private`. + type: array + items: + type: integer + auth_type: + description: The authentication type for the private registry. This + field cannot be changed after creation. If provided, it must match + the existing `auth_type` of the configuration. To change the authentication + type, delete and recreate the configuration. type: string enum: - token @@ -20593,6 +23443,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -20625,7 +23476,7 @@ paths: type: string audience: description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, - and required for `oidc_cloudsmith` auth types. + and `oidc_gcp`, and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` @@ -20643,312 +23494,15 @@ paths: description: The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default. type: string - required: - - registry_type - - url - - visibility - examples: - org-private-registry-with-private-visibility: - summary: Example of a private registry configuration with private - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - replaces_base: true - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: private - org-private-registry-with-selected-visibility: - summary: Example of a private registry configuration with selected - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - org-private-registry-with-oidc-azure: - summary: Example of an OIDC private registry configuration using Azure - value: - registry_type: docker_registry - url: https://myregistry.azurecr.io - auth_type: oidc_azure - visibility: all - tenant_id: 12345678-1234-1234-1234-123456789012 - client_id: abcdef01-2345-6789-abcd-ef0123456789 - org-private-registry-with-oidc-cloudsmith: - summary: Example of an OIDC private registry configuration using Cloudsmith - value: - registry_type: npm_registry - url: https://npm.cloudsmith.io/my-org/my-repo/ - auth_type: oidc_cloudsmith - visibility: all - namespace: my-org - service_slug: my-service-account - audience: https://github.com/my-org - responses: - '201': - description: The organization private registry configuration - content: - application/json: - schema: - "$ref": "#/components/schemas/org-private-registry-configuration-with-selected-repositories" - examples: - org-private-registry-with-selected-visibility: - "$ref": "#/components/examples/org-private-registry-configuration" - org-private-registry-with-private-visibility: - "$ref": "#/components/examples/org-private-registry-configuration-with-selected-repositories" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/public-key": - get: - summary: Get private registries public key for an organization - description: |2- - - Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - key_id - - key - properties: - key_id: - description: The identifier for the key. - type: string - examples: - - '012345678912345678' - key: - description: The Base64 encoded public key. - type: string - examples: - - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - examples: - default: - "$ref": "#/components/examples/private-registries-public-key" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/{secret_name}": - get: - summary: Get a private registry for an organization - description: |2- - - Get the configuration of a single private registry defined for an organization, omitting its encrypted value. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/secret-name" - responses: - '200': - description: The specified private registry configuration for the organization - content: - application/json: - schema: - "$ref": "#/components/schemas/org-private-registry-configuration" - examples: - default: - "$ref": "#/components/examples/org-private-registry-configuration" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - patch: - summary: Update a private registry for an organization - description: |2- - - Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/update-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/secret-name" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - registry_type: - description: The registry type. + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + Required when `auth_type` is `oidc_gcp`. type: string - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with the private - registry. This field should be omitted if the private registry - does not require a username for authentication. - type: - - string - - 'null' - replaces_base: - description: Whether this private registry should replace the base - registry (e.g., npmjs.org for npm, rubygems.org for rubygems). - When set to `true`, Dependabot will only use this registry and - will not fall back to the public registry. When set to `false` - (default), Dependabot will use this registry for scoped packages - but may fall back to the public registry for other packages. - type: boolean - default: false - encrypted_value: - description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get private registries - public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) - endpoint. - type: string - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - description: The ID of the key you used to encrypt the secret. - type: string - visibility: - description: Which type of organization repositories have access - to the private registry. `selected` means only the repositories - specified by `selected_repository_ids` can access the private - registry. - type: string - enum: - - all - - private - - selected - selected_repository_ids: - description: An array of repository IDs that can access the organization - private registry. You can only provide a list of repository IDs - when `visibility` is set to `selected`. This field should be omitted - if `visibility` is set to `all` or `private`. - type: array - items: - type: integer - auth_type: - description: The authentication type for the private registry. This - field cannot be changed after creation. If provided, it must match - the existing `auth_type` of the configuration. To change the authentication - type, delete and recreate the configuration. - type: string - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - - oidc_cloudsmith - tenant_id: - description: The tenant ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - client_id: - description: The client ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - aws_region: - description: The AWS region. Required when `auth_type` is `oidc_aws`. - type: string - account_id: - description: The AWS account ID. Required when `auth_type` is `oidc_aws`. - type: string - role_name: - description: The AWS IAM role name. Required when `auth_type` is - `oidc_aws`. - type: string - domain: - description: The CodeArtifact domain. Required when `auth_type` - is `oidc_aws`. - type: string - domain_owner: - description: The CodeArtifact domain owner (AWS account ID). Required - when `auth_type` is `oidc_aws`. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. Required when `auth_type` - is `oidc_jfrog`. - type: string - audience: - description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, - and required for `oidc_cloudsmith` auth types. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. Optional for `oidc_jfrog` - auth type. - type: string - namespace: - description: The Cloudsmith organization namespace. Required when - `auth_type` is `oidc_cloudsmith`. - type: string - service_slug: - description: The Cloudsmith service account slug. Required when - `auth_type` is `oidc_cloudsmith`. - type: string - api_host: - description: The Cloudsmith API host. Optional for `oidc_cloudsmith` - auth type. If omitted, `api.cloudsmith.io` is used by default. + service_account: + description: The GCP service account email to impersonate. Optional + for `oidc_gcp` auth type. If omitted, the federated token is used + directly (direct WIF). type: string examples: secret-based-update: @@ -23142,6 +25696,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + - "$ref": "#/components/parameters/secret-scanning-alert-bypassed" responses: '200': description: Response @@ -25733,6 +28288,111 @@ paths: enabledForGitHubApps: true category: actions subcategory: cache + "/repos/{owner}/{repo}/actions/concurrency_groups": + get: + summary: List concurrency groups for a repository + description: |- + Lists the active concurrency groups for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-concurrency-groups-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-after" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/concurrency-group-list" + examples: + default: + "$ref": "#/components/examples/concurrency-group-list" + headers: + Link: + "$ref": "#/components/headers/link" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups + "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}": + get: + summary: Get a concurrency group for a repository + description: |- + Gets a specific concurrency group for a repository, including all instances in the group's queue. + Returns 404 if the group is inactive or does not exist. + + Optionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items + ahead of the specified workflow run or job in the queue, plus the specified item itself + (returned as the last element). This is useful for determining what is blocking a particular + run or job. Returns 422 if the specified run or job is not in this concurrency group. + + When using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow + leases held on behalf of that run. Job-level leases within the run are not considered to + block the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow + leases on the job's ancestor paths. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-concurrency-group-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/concurrency-group-name" + - name: ahead_of_run + description: |- + Filter to items ahead of this workflow run ID in the queue, plus the run itself. + Matches workflow-level concurrency and reusable-workflow leases held on behalf of + the run. Mutually exclusive with `ahead_of_job`. + in: query + required: false + schema: + type: integer + minimum: 1 + - name: ahead_of_job + description: |- + Filter to items ahead of this job ID in the queue, plus the job itself. + Matches job-level concurrency and reusable-workflow leases on the job's + ancestor paths. Mutually exclusive with `ahead_of_run`. + in: query + required: false + schema: + type: integer + minimum: 1 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/concurrency-group" + examples: + default: + "$ref": "#/components/examples/concurrency-group" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups "/repos/{owner}/{repo}/actions/jobs/{job_id}": get: summary: Get a job for a workflow run @@ -27435,6 +30095,64 @@ paths: enabledForGitHubApps: true category: actions subcategory: workflow-runs + "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups": + get: + summary: List concurrency groups for a workflow run + description: |- + Lists all concurrency groups associated with a workflow run or its jobs. + + The set of groups is derived from the run's configuration, so a group is + included even when the run no longer has any items currently holding or + waiting in it. In that case the `group_members` array will be empty. + `total_count` reflects the number of groups the run participates in by + configuration, not the number with active items. + + This differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`, + which returns 404 when a group has no active items. That endpoint reports + the live state of a group repo-wide, while this endpoint reports the + groups associated with a specific run by configuration. + + Results are sorted by group name and support cursor-based pagination via + `before` and `after`. The `after` cursor paginates forward only and does + not emit a `rel="prev"` Link; use `before` to page backward from a + forward page's `next` cursor. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-concurrency-groups-for-workflow-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/run-id" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/concurrency-group-run-list" + examples: + default: + "$ref": "#/components/examples/concurrency-group-run-list" + headers: + Link: + "$ref": "#/components/headers/link" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": post: summary: Review custom deployment protection rules for a workflow run @@ -48335,6 +51053,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + - "$ref": "#/components/parameters/secret-scanning-alert-bypassed" responses: '200': description: Response @@ -89719,6 +92438,7 @@ components: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -89786,6 +92506,14 @@ components: api_host: description: The Cloudsmith API host. type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity Provider + (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + type: string + service_account: + description: The GCP service account email to impersonate. If omitted, the + federated token is used directly (direct WIF). + type: string created_at: type: string format: date-time @@ -89836,6 +92564,7 @@ components: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -89908,6 +92637,14 @@ components: api_host: description: The Cloudsmith API host. type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity Provider + (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + type: string + service_account: + description: The GCP service account email to impersonate. If omitted, the + federated token is used directly (direct WIF). + type: string created_at: type: string format: date-time @@ -95139,6 +97876,112 @@ components: required: - total_count - actions_caches + concurrency-group-list: + title: Concurrency Group List + description: A list of active concurrency groups for a repository. + type: object + required: + - total_count + - concurrency_groups + properties: + total_count: + type: integer + concurrency_groups: + type: array + items: + type: object + required: + - group_name + - group_url + - last_acquired_at + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: API URL for this concurrency group. + last_acquired_at: + type: + - string + - 'null' + format: date-time + concurrency-group: + title: Concurrency Group + description: |- + A concurrency group with the workflow runs and jobs that are either currently holding + or waiting for the concurrency group lease. + type: object + required: + - group_name + - group_url + - total_count + - group_members + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: API URL for this concurrency group. + total_count: + type: integer + group_members: + type: array + items: + type: object + required: + - run_id + - run_name + - run_url + - run_html_url + - status + properties: + run_id: + type: integer + description: The ID of the workflow run. + run_name: + type: string + description: The name of the workflow run. + run_url: + type: + - string + - 'null' + format: uri + description: API URL for the workflow run. + run_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the workflow run. + job_id: + type: integer + description: The ID of the job, when the item represents a job-level + or reusable-workflow-level lease. + job_name: + type: string + description: The display name of the job, when the item represents + a job-level or reusable-workflow-level lease. + job_url: + type: + - string + - 'null' + format: uri + description: API URL for the job. + job_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the job. + status: + type: string + enum: + - in_progress + - pending job: title: Job description: Information of a job execution in a workflow run @@ -95842,6 +98685,116 @@ components: - state - user - comment + concurrency-group-run-list: + title: Concurrency Group Run List + description: A list of concurrency groups associated with a workflow run. + type: object + required: + - total_count + - concurrency_groups + properties: + total_count: + type: integer + description: |- + The total number of concurrency groups this workflow run participates in, + derived from the run's configuration. This count is not filtered by + whether the run currently holds or is waiting in each group, so it can + include groups whose `group_members` array is empty (for example, when + the run has already released its lease in that group). + concurrency_groups: + type: array + items: + type: object + required: + - group_name + - group_url + - group_members + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: |- + API URL for this concurrency group. May return 404 if the group + has no active items at the time it is requested, since the + get-by-name endpoint reports the live repo-wide state of a group + while this endpoint lists groups associated with a run by + configuration. + group_members: + type: array + description: |- + Items belonging to this workflow run that are either currently holding or + waiting for the concurrency group lease. May be empty if the run no + longer has any active or queued items in this group. + items: + type: object + required: + - run_id + - run_name + - run_url + - run_html_url + - status + - position + - position_url + properties: + run_id: + type: integer + description: The ID of the workflow run. + run_name: + type: string + description: The name of the workflow run. + run_url: + type: + - string + - 'null' + format: uri + description: API URL for the workflow run. + run_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the workflow run. + position: + type: integer + description: Queue position. 0 means the item holds the concurrency + lease (in_progress), 1 or higher means queued (pending). + position_url: + type: string + format: uri + description: API URL to get items ahead of this item in the + concurrency group. + job_id: + type: + - integer + - 'null' + description: The ID of the job, when the item represents a job-level + or reusable-workflow-level lease. + job_name: + type: + - string + - 'null' + description: The display name of the job, when the item represents + a job-level or reusable-workflow-level lease. + job_url: + type: + - string + - 'null' + format: uri + description: API URL for the job. + job_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the job. + status: + type: string + enum: + - in_progress + - pending review-custom-gates-comment-required: type: object properties: @@ -231365,6 +234318,41 @@ components: last_accessed_at: '2019-01-24T22:45:36.000Z' created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 + concurrency-group-list: + value: + total_count: 2 + concurrency_groups: + - group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + last_acquired_at: '2026-01-15T16:14:23Z' + - group_name: ci-build + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build + last_acquired_at: '2026-01-15T16:13:55Z' + concurrency-group: + value: + group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + total_count: 3 + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: in_progress + - run_id: 30433643 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433643 + status: pending + - run_id: 30433644 + run_name: Deploy hotfix + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433644 + job_id: 798245260 + job_name: deploy + job_url: https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260 + job_html_url: https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260 + status: pending job: value: id: 399444496 @@ -232041,6 +235029,34 @@ components: runner_group_name: my runner group workflow_name: CI head_branch: main + concurrency-group-run-list: + value: + total_count: 2 + concurrency_groups: + - group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: in_progress + position: 0 + position_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642 + - group_name: ci-build + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: pending + position: 2 + position_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260 + job_id: 798245260 + job_name: build + job_url: https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260 + job_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260 pending-deployment-items: value: - environment: @@ -249351,6 +252367,17 @@ components: schema: type: boolean default: false + secret-scanning-alert-bypassed: + name: is_bypassed + in: query + description: A boolean value (`true` or `false`) indicating whether to filter + alerts by their push protection bypass status. When set to `true`, only alerts + that were created because a push protection rule was bypassed will be returned. + When set to `false`, only alerts that were not caused by a push protection + bypass will be returned. + required: false + schema: + type: boolean network-configuration-id: name: network_configuration_id description: Unique identifier of the hosted compute network configuration. @@ -249466,6 +252493,13 @@ components: required: true schema: type: integer + concurrency-group-name: + name: concurrency_group_name + description: The name of the concurrency group. + in: path + required: true + schema: + type: string job-id: name: job_id description: The unique identifier of the job. 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 30dfb1c04..77fc1ecf1 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 @@ -530,6 +530,3174 @@ } } }, + "/agents/repos/{owner}/{repo}/tasks": { + "get": { + "summary": "List tasks for repository", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n\n**Fine-grained access tokens for \"List tasks for repository\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Start a task", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nStarts a new Copilot cloud agent task for a repository.\n\nThis endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription.\n\n**Fine-grained access tokens for \"Start a task\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read and write)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/create-task-in-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#start-a-task" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + } + ], + "requestBody": { + "required": true, + "description": "The task creation parameters, including the user's prompt and optional agent settings.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "prompt" + ], + "properties": { + "prompt": { + "type": "string", + "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`" + }, + "create_pull_request": { + "type": "boolean", + "description": "Whether to create a PR.", + "default": false + }, + "base_ref": { + "type": "string", + "description": "Base ref for new branch/PR" + } + } + }, + "examples": { + "default": { + "value": { + "prompt": "Fix the login button on the homepage", + "base_ref": "main" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Task created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "queued", + "session_count": 1, + "artifacts": [], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "400": { + "description": "Problems parsing JSON", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/repos/{owner}/{repo}/tasks/{task_id}": { + "get": { + "summary": "Get a task by repo", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n\n**Fine-grained access tokens for \"Get a task by repo\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-repo-and-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "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": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks": { + "get": { + "summary": "List tasks", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n\n**Fine-grained access tokens for \"List tasks\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks/{task_id}": { + "get": { + "summary": "Get a task by ID", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n\n**Fine-grained access tokens for \"Get a task by ID\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "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": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, "/app": { "get": { "summary": "Get the authenticated app", @@ -14725,7 +17893,7 @@ "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { "post": { "summary": "Set cluster deployment records", - "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.", + "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.\nNote: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments\narray resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use\nthe artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can\nonly have one name and version.", "tags": [ "orgs" ], @@ -14778,20 +17946,20 @@ "properties": { "name": { "type": "string", - "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", + "description": "The name of the artifact.", "minLength": 1, "maxLength": 256 }, "digest": { "type": "string", - "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", + "description": "The hex encoded digest of the artifact.", "minLength": 71, "maxLength": 71, "pattern": "^sha256:[a-f0-9]{64}$" }, "version": { "type": "string", - "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", + "description": "The artifact version.", "maxLength": 100, "x-multi-segment": true, "examples": [ @@ -28071,7 +31239,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -28156,7 +31324,393 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication.", + "type": "string", + "enum": [ + "token", + "username_password", + "oidc_azure", + "oidc_aws", + "oidc_jfrog", + "oidc_cloudsmith", + "oidc_gcp" + ] + }, + "tenant_id": { + "description": "The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`.", + "type": "string" + }, + "client_id": { + "description": "The client ID of the Azure AD application. Required when `auth_type` is `oidc_azure`.", + "type": "string" + }, + "aws_region": { + "description": "The AWS region. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "account_id": { + "description": "The AWS account ID. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "role_name": { + "description": "The AWS IAM role name. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "domain": { + "description": "The CodeArtifact domain. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "domain_owner": { + "description": "The CodeArtifact domain owner (AWS account ID). Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "jfrog_oidc_provider_name": { + "description": "The JFrog OIDC provider name. Required when `auth_type` is `oidc_jfrog`.", + "type": "string" + }, + "audience": { + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.", + "type": "string" + }, + "identity_mapping_name": { + "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", + "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" + }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). Required when `auth_type` is `oidc_gcp`.", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + } + }, + "required": [ + "registry_type", + "url", + "visibility" + ] + }, + "examples": { + "org-private-registry-with-private-visibility": { + "summary": "Example of a private registry configuration with private visibility", + "value": { + "registry_type": "maven_repository", + "url": "https://maven.pkg.github.com/organization/", + "username": "monalisa", + "replaces_base": true, + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "private" + } + }, + "org-private-registry-with-selected-visibility": { + "summary": "Example of a private registry configuration with selected visibility", + "value": { + "registry_type": "maven_repository", + "url": "https://maven.pkg.github.com/organization/", + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + }, + "org-private-registry-with-oidc-azure": { + "summary": "Example of an OIDC private registry configuration using Azure", + "value": { + "registry_type": "docker_registry", + "url": "https://myregistry.azurecr.io", + "auth_type": "oidc_azure", + "visibility": "all", + "tenant_id": "12345678-1234-1234-1234-123456789012", + "client_id": "abcdef01-2345-6789-abcd-ef0123456789" + } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } + }, + "org-private-registry-with-oidc-gcp": { + "summary": "Example of an OIDC private registry configuration using Google Cloud Artifact Registry", + "value": { + "registry_type": "docker_registry", + "url": "https://us-docker.pkg.dev/my-project/my-repo", + "auth_type": "oidc_gcp", + "visibility": "all", + "workload_identity_provider": "projects/123456789/locations/global/workloadIdentityPools/github-pool/providers/github-provider", + "service_account": "dependabot@my-project.iam.gserviceaccount.com" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "The organization private registry configuration", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-private-registry-configuration-with-selected-repositories" + }, + "examples": { + "org-private-registry-with-selected-visibility": { + "$ref": "#/components/examples/org-private-registry-configuration" + }, + "org-private-registry-with-private-visibility": { + "$ref": "#/components/examples/org-private-registry-configuration-with-selected-repositories" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + } + }, + "/orgs/{org}/private-registries/public-key": { + "get": { + "summary": "Get private registries public key for an organization", + "description": "\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key_id", + "key" + ], + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "examples": [ + "012345678912345678" + ] + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "examples": [ + "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + ] + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/private-registries-public-key" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + } + }, + "/orgs/{org}/private-registries/{secret_name}": { + "get": { + "summary": "Get a private registry for an organization", + "description": "\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/get-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "The specified private registry configuration for the organization", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-private-registry-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-private-registry-configuration" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + }, + "patch": { + "summary": "Update a private registry for an organization", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/update-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "registry_type": { + "description": "The registry type.", + "type": "string", + "enum": [ + "maven_repository", + "nuget_feed", + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" + ] + }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, + "username": { + "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", + "type": [ + "string", + "null" + ] + }, + "replaces_base": { + "description": "Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, + "encrypted_value": { + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "description": "The ID of the key you used to encrypt the secret.", + "type": "string" + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "type": "string", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`.", + "type": "array", + "items": { + "type": "integer" + } + }, + "auth_type": { + "description": "The authentication type for the private registry. This field cannot be changed after creation. If provided, it must match the existing `auth_type` of the configuration. To change the authentication type, delete and recreate the configuration.", "type": "string", "enum": [ "token", @@ -28164,7 +31718,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -28200,7 +31755,7 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { @@ -28218,371 +31773,13 @@ "api_host": { "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", "type": "string" - } - }, - "required": [ - "registry_type", - "url", - "visibility" - ] - }, - "examples": { - "org-private-registry-with-private-visibility": { - "summary": "Example of a private registry configuration with private visibility", - "value": { - "registry_type": "maven_repository", - "url": "https://maven.pkg.github.com/organization/", - "username": "monalisa", - "replaces_base": true, - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "private" - } - }, - "org-private-registry-with-selected-visibility": { - "summary": "Example of a private registry configuration with selected visibility", - "value": { - "registry_type": "maven_repository", - "url": "https://maven.pkg.github.com/organization/", - "username": "monalisa", - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - } - }, - "org-private-registry-with-oidc-azure": { - "summary": "Example of an OIDC private registry configuration using Azure", - "value": { - "registry_type": "docker_registry", - "url": "https://myregistry.azurecr.io", - "auth_type": "oidc_azure", - "visibility": "all", - "tenant_id": "12345678-1234-1234-1234-123456789012", - "client_id": "abcdef01-2345-6789-abcd-ef0123456789" - } - }, - "org-private-registry-with-oidc-cloudsmith": { - "summary": "Example of an OIDC private registry configuration using Cloudsmith", - "value": { - "registry_type": "npm_registry", - "url": "https://npm.cloudsmith.io/my-org/my-repo/", - "auth_type": "oidc_cloudsmith", - "visibility": "all", - "namespace": "my-org", - "service_slug": "my-service-account", - "audience": "https://github.com/my-org" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "The organization private registry configuration", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/org-private-registry-configuration-with-selected-repositories" - }, - "examples": { - "org-private-registry-with-selected-visibility": { - "$ref": "#/components/examples/org-private-registry-configuration" }, - "org-private-registry-with-private-visibility": { - "$ref": "#/components/examples/org-private-registry-configuration-with-selected-repositories" - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "private-registries", - "subcategory": "organization-configurations" - } - } - }, - "/orgs/{org}/private-registries/public-key": { - "get": { - "summary": "Get private registries public key for an organization", - "description": "\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "private-registries" - ], - "operationId": "private-registries/get-org-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "key_id", - "key" - ], - "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "examples": [ - "012345678912345678" - ] - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "examples": [ - "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - ] - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/private-registries-public-key" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "private-registries", - "subcategory": "organization-configurations" - } - } - }, - "/orgs/{org}/private-registries/{secret_name}": { - "get": { - "summary": "Get a private registry for an organization", - "description": "\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "private-registries" - ], - "operationId": "private-registries/get-org-private-registry", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "responses": { - "200": { - "description": "The specified private registry configuration for the organization", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/org-private-registry-configuration" - }, - "examples": { - "default": { - "$ref": "#/components/examples/org-private-registry-configuration" - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "private-registries", - "subcategory": "organization-configurations" - } - }, - "patch": { - "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "private-registries" - ], - "operationId": "private-registries/update-org-private-registry", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "registry_type": { - "description": "The registry type.", - "type": "string", - "enum": [ - "maven_repository", - "nuget_feed", - "goproxy_server", - "npm_registry", - "rubygems_server", - "cargo_registry", - "composer_repository", - "docker_registry", - "git_source", - "helm_registry", - "hex_organization", - "hex_repository", - "pub_repository", - "python_index", - "terraform_registry" - ] - }, - "url": { - "description": "The URL of the private registry.", - "type": "string", - "format": "uri" - }, - "username": { - "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", - "type": [ - "string", - "null" - ] - }, - "replaces_base": { - "description": "Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", - "type": "boolean", - "default": false - }, - "encrypted_value": { - "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", - "type": "string", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "description": "The ID of the key you used to encrypt the secret.", - "type": "string" - }, - "visibility": { - "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", - "type": "string", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`.", - "type": "array", - "items": { - "type": "integer" - } - }, - "auth_type": { - "description": "The authentication type for the private registry. This field cannot be changed after creation. If provided, it must match the existing `auth_type` of the configuration. To change the authentication type, delete and recreate the configuration.", - "type": "string", - "enum": [ - "token", - "username_password", - "oidc_azure", - "oidc_aws", - "oidc_jfrog", - "oidc_cloudsmith" - ] - }, - "tenant_id": { - "description": "The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`.", + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). Required when `auth_type` is `oidc_gcp`.", "type": "string" }, - "client_id": { - "description": "The client ID of the Azure AD application. Required when `auth_type` is `oidc_azure`.", - "type": "string" - }, - "aws_region": { - "description": "The AWS region. Required when `auth_type` is `oidc_aws`.", - "type": "string" - }, - "account_id": { - "description": "The AWS account ID. Required when `auth_type` is `oidc_aws`.", - "type": "string" - }, - "role_name": { - "description": "The AWS IAM role name. Required when `auth_type` is `oidc_aws`.", - "type": "string" - }, - "domain": { - "description": "The CodeArtifact domain. Required when `auth_type` is `oidc_aws`.", - "type": "string" - }, - "domain_owner": { - "description": "The CodeArtifact domain owner (AWS account ID). Required when `auth_type` is `oidc_aws`.", - "type": "string" - }, - "jfrog_oidc_provider_name": { - "description": "The JFrog OIDC provider name. Required when `auth_type` is `oidc_jfrog`.", - "type": "string" - }, - "audience": { - "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", - "type": "string" - }, - "identity_mapping_name": { - "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", - "type": "string" - }, - "namespace": { - "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", - "type": "string" - }, - "service_slug": { - "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", - "type": "string" - }, - "api_host": { - "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "service_account": { + "description": "The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).", "type": "string" } } @@ -31778,6 +34975,9 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-bypassed" } ], "responses": { @@ -35193,6 +38393,139 @@ } } }, + "/repos/{owner}/{repo}/actions/concurrency_groups": { + "get": { + "summary": "List concurrency groups for a repository", + "description": "Lists the active concurrency groups for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-concurrency-groups-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/concurrency-group-list" + }, + "examples": { + "default": { + "$ref": "#/components/examples/concurrency-group-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "concurrency-groups" + } + } + }, + "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}": { + "get": { + "summary": "Get a concurrency group for a repository", + "description": "Gets a specific concurrency group for a repository, including all instances in the group's queue.\nReturns 404 if the group is inactive or does not exist.\n\nOptionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items\nahead of the specified workflow run or job in the queue, plus the specified item itself\n(returned as the last element). This is useful for determining what is blocking a particular\nrun or job. Returns 422 if the specified run or job is not in this concurrency group.\n\nWhen using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow\nleases held on behalf of that run. Job-level leases within the run are not considered to\nblock the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow\nleases on the job's ancestor paths.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/get-concurrency-group-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/concurrency-group-name" + }, + { + "name": "ahead_of_run", + "description": "Filter to items ahead of this workflow run ID in the queue, plus the run itself.\nMatches workflow-level concurrency and reusable-workflow leases held on behalf of\nthe run. Mutually exclusive with `ahead_of_job`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + }, + { + "name": "ahead_of_job", + "description": "Filter to items ahead of this job ID in the queue, plus the job itself.\nMatches job-level concurrency and reusable-workflow leases on the job's\nancestor paths. Mutually exclusive with `ahead_of_run`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/concurrency-group" + }, + "examples": { + "default": { + "$ref": "#/components/examples/concurrency-group" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "concurrency-groups" + } + } + }, "/repos/{owner}/{repo}/actions/jobs/{job_id}": { "get": { "summary": "Get a job for a workflow run", @@ -37606,6 +40939,74 @@ } } }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups": { + "get": { + "summary": "List concurrency groups for a workflow run", + "description": "Lists all concurrency groups associated with a workflow run or its jobs.\n\nThe set of groups is derived from the run's configuration, so a group is\nincluded even when the run no longer has any items currently holding or\nwaiting in it. In that case the `group_members` array will be empty.\n`total_count` reflects the number of groups the run participates in by\nconfiguration, not the number with active items.\n\nThis differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`,\nwhich returns 404 when a group has no active items. That endpoint reports\nthe live state of a group repo-wide, while this endpoint reports the\ngroups associated with a specific run by configuration.\n\nResults are sorted by group name and support cursor-based pagination via\n`before` and `after`. The `after` cursor paginates forward only and does\nnot emit a `rel=\"prev\"` Link; use `before` to page backward from a\nforward page's `next` cursor.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-concurrency-groups-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/concurrency-group-run-list" + }, + "examples": { + "default": { + "$ref": "#/components/examples/concurrency-group-run-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "concurrency-groups" + } + } + }, "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { "post": { "summary": "Review custom deployment protection rules for a workflow run", @@ -66371,6 +69772,9 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-bypassed" } ], "responses": { @@ -122909,7 +126313,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -122994,6 +126399,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -123052,7 +126465,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -123141,6 +126555,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -130227,6 +133649,144 @@ "actions_caches" ] }, + "concurrency-group-list": { + "title": "Concurrency Group List", + "description": "A list of active concurrency groups for a repository.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "last_acquired_at" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "last_acquired_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + } + } + } + } + }, + "concurrency-group": { + "title": "Concurrency Group", + "description": "A concurrency group with the workflow runs and jobs that are either currently holding\nor waiting for the concurrency group lease.", + "type": "object", + "required": [ + "group_name", + "group_url", + "total_count", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "total_count": { + "type": "integer" + }, + "group_members": { + "type": "array", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "job_id": { + "type": "integer", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + }, "job": { "title": "Job", "description": "Information of a job execution in a workflow run", @@ -131158,6 +134718,131 @@ "comment" ] }, + "concurrency-group-run-list": { + "title": "Concurrency Group Run List", + "description": "A list of concurrency groups associated with a workflow run.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer", + "description": "The total number of concurrency groups this workflow run participates in,\nderived from the run's configuration. This count is not filtered by\nwhether the run currently holds or is waiting in each group, so it can\ninclude groups whose `group_members` array is empty (for example, when\nthe run has already released its lease in that group)." + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group. May return 404 if the group\nhas no active items at the time it is requested, since the\nget-by-name endpoint reports the live repo-wide state of a group\nwhile this endpoint lists groups associated with a run by\nconfiguration." + }, + "group_members": { + "type": "array", + "description": "Items belonging to this workflow run that are either currently holding or\nwaiting for the concurrency group lease. May be empty if the run no\nlonger has any active or queued items in this group.", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status", + "position", + "position_url" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "position": { + "type": "integer", + "description": "Queue position. 0 means the item holds the concurrency lease (in_progress), 1 or higher means queued (pending)." + }, + "position_url": { + "type": "string", + "format": "uri", + "description": "API URL to get items ahead of this item in the concurrency group." + }, + "job_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": [ + "string", + "null" + ], + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } + }, "review-custom-gates-comment-required": { "type": "object", "properties": { @@ -311622,6 +315307,57 @@ ] } }, + "concurrency-group-list": { + "value": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "last_acquired_at": "2026-01-15T16:14:23Z" + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "last_acquired_at": "2026-01-15T16:13:55Z" + } + ] + } + }, + "concurrency-group": { + "value": { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "total_count": 3, + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress" + }, + { + "run_id": 30433643, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433643", + "status": "pending" + }, + { + "run_id": 30433644, + "run_name": "Deploy hotfix", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644", + "job_id": 798245260, + "job_name": "deploy", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260", + "status": "pending" + } + ] + } + }, "job": { "value": { "id": 399444496, @@ -312410,6 +316146,47 @@ ] } }, + "concurrency-group-run-list": { + "value": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress", + "position": 0, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642" + } + ] + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "pending", + "position": 2, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260", + "job_id": 798245260, + "job_name": "build", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260" + } + ] + } + ] + } + }, "pending-deployment-items": { "value": [ { @@ -332333,6 +336110,15 @@ "default": false } }, + "secret-scanning-alert-bypassed": { + "name": "is_bypassed", + "in": "query", + "description": "A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.", + "required": false, + "schema": { + "type": "boolean" + } + }, "network-configuration-id": { "name": "network_configuration_id", "description": "Unique identifier of the hosted compute network configuration.", @@ -332466,6 +336252,15 @@ "type": "integer" } }, + "concurrency-group-name": { + "name": "concurrency_group_name", + "description": "The name of the concurrency group.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "job-id": { "name": "job_id", "description": "The unique identifier of the job.", 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 6819017a1..41453d641 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 @@ -343,6 +343,2530 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories + "/agents/repos/{owner}/{repo}/tasks": + get: + summary: List tasks for repository + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for a specific repository + + **Fine-grained access tokens for "List tasks for repository"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/list-tasks-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, + `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived + tasks. When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + - name: creator_id + in: query + schema: + type: integer + description: Filter tasks by creator user ID + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="prev" (when current page > 1), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; + rel="next", ; + rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + post: + summary: Start a task + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Starts a new Copilot cloud agent task for a repository. + + This endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription. + + **Fine-grained access tokens for "Start a task"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read and write) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/create-task-in-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#start-a-task + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + requestBody: + required: true + description: The task creation parameters, including the user's prompt and + optional agent settings. + content: + application/json: + schema: + type: object + required: + - prompt + properties: + prompt: + type: string + 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`' + create_pull_request: + type: boolean + description: Whether to create a PR. + default: false + base_ref: + type: string + description: Base ref for new branch/PR + examples: + default: + value: + prompt: Fix the login button on the homepage + base_ref: main + responses: + '201': + description: Task created successfully + content: + application/json: + schema: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: queued + session_count: 1 + artifacts: [] + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '400': + description: Problems parsing JSON + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/repos/{owner}/{repo}/tasks/{task_id}": + get: + summary: Get a task by repo + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID scoped to an owner/repo path + + **Fine-grained access tokens for "Get a task by repo"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-repo-and-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + allOf: + - type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + 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: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/tasks": + get: + summary: List tasks + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for the authenticated user + + **Fine-grained access tokens for "List tasks"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/list-tasks + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, + `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived + tasks. When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; rel="next", + ; rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/tasks/{task_id}": + get: + summary: Get a task by ID + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID with its associated sessions + + **Fine-grained access tokens for "Get a task by ID"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + allOf: + - type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + 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: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation "/app": get: summary: Get the authenticated app @@ -10651,6 +13175,10 @@ paths: If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. If no existing records match, new records will be created. + Note: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments + array resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use + the artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can + only have one name and version. tags: - orgs operationId: orgs/set-cluster-deployment-records @@ -10693,24 +13221,18 @@ paths: properties: name: type: string - description: | - The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name parameter must also be identical across all entries. + description: The name of the artifact. minLength: 1 maxLength: 256 digest: type: string - description: | - The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name and version parameters must also be identical across all entries. + description: The hex encoded digest of the artifact. minLength: 71 maxLength: 71 pattern: "^sha256:[a-f0-9]{64}$" version: type: string - description: | - The artifact version. Note that if multiple deployments have identical 'digest' parameter values, - the version parameter must also be identical across all entries. + description: The artifact version. maxLength: 100 x-multi-segment: true examples: @@ -20458,7 +22980,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -20552,7 +23074,335 @@ paths: auth_type: description: The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, - or `oidc_cloudsmith` for OIDC authentication. + `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication. + type: string + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + - oidc_cloudsmith + - oidc_gcp + tenant_id: + description: The tenant ID of the Azure AD application. Required + when `auth_type` is `oidc_azure`. + type: string + client_id: + description: The client ID of the Azure AD application. Required + when `auth_type` is `oidc_azure`. + type: string + aws_region: + description: The AWS region. Required when `auth_type` is `oidc_aws`. + type: string + account_id: + description: The AWS account ID. Required when `auth_type` is `oidc_aws`. + type: string + role_name: + description: The AWS IAM role name. Required when `auth_type` is + `oidc_aws`. + type: string + domain: + description: The CodeArtifact domain. Required when `auth_type` + is `oidc_aws`. + type: string + domain_owner: + description: The CodeArtifact domain owner (AWS account ID). Required + when `auth_type` is `oidc_aws`. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. Required when `auth_type` + is `oidc_jfrog`. + type: string + audience: + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and `oidc_gcp`, and required for `oidc_cloudsmith` auth types. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. Optional for `oidc_jfrog` + auth type. + type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + Required when `auth_type` is `oidc_gcp`. + type: string + service_account: + description: The GCP service account email to impersonate. Optional + for `oidc_gcp` auth type. If omitted, the federated token is used + directly (direct WIF). + type: string + required: + - registry_type + - url + - visibility + examples: + org-private-registry-with-private-visibility: + summary: Example of a private registry configuration with private + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + replaces_base: true + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: private + org-private-registry-with-selected-visibility: + summary: Example of a private registry configuration with selected + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + org-private-registry-with-oidc-azure: + summary: Example of an OIDC private registry configuration using Azure + value: + registry_type: docker_registry + url: https://myregistry.azurecr.io + auth_type: oidc_azure + visibility: all + tenant_id: 12345678-1234-1234-1234-123456789012 + client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org + org-private-registry-with-oidc-gcp: + summary: Example of an OIDC private registry configuration using Google + Cloud Artifact Registry + value: + registry_type: docker_registry + url: https://us-docker.pkg.dev/my-project/my-repo + auth_type: oidc_gcp + visibility: all + workload_identity_provider: projects/123456789/locations/global/workloadIdentityPools/github-pool/providers/github-provider + service_account: dependabot@my-project.iam.gserviceaccount.com + responses: + '201': + description: The organization private registry configuration + content: + application/json: + schema: + "$ref": "#/components/schemas/org-private-registry-configuration-with-selected-repositories" + examples: + org-private-registry-with-selected-visibility: + "$ref": "#/components/examples/org-private-registry-configuration" + org-private-registry-with-private-visibility: + "$ref": "#/components/examples/org-private-registry-configuration-with-selected-repositories" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/public-key": + get: + summary: Get private registries public key for an organization + description: |2- + + Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - key_id + - key + properties: + key_id: + description: The identifier for the key. + type: string + examples: + - '012345678912345678' + key: + description: The Base64 encoded public key. + type: string + examples: + - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + examples: + default: + "$ref": "#/components/examples/private-registries-public-key" + headers: + Link: + "$ref": "#/components/headers/link" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/{secret_name}": + get: + summary: Get a private registry for an organization + description: |2- + + Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/secret-name" + responses: + '200': + description: The specified private registry configuration for the organization + content: + application/json: + schema: + "$ref": "#/components/schemas/org-private-registry-configuration" + examples: + default: + "$ref": "#/components/examples/org-private-registry-configuration" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + patch: + summary: Update a private registry for an organization + description: |2- + + Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/update-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/secret-name" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + registry_type: + description: The registry type. + type: string + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the private + registry. This field should be omitted if the private registry + does not require a username for authentication. + type: + - string + - 'null' + replaces_base: + description: Whether this private registry should replace the base + registry (e.g., npmjs.org for npm, rubygems.org for rubygems). + When set to `true`, Dependabot will only use this registry and + will not fall back to the public registry. When set to `false` + (default), Dependabot will use this registry for scoped packages + but may fall back to the public registry for other packages. + type: boolean + default: false + encrypted_value: + description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get private registries + public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + endpoint. + type: string + pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + key_id: + description: The ID of the key you used to encrypt the secret. + type: string + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + type: string + enum: + - all + - private + - selected + selected_repository_ids: + description: An array of repository IDs that can access the organization + private registry. You can only provide a list of repository IDs + when `visibility` is set to `selected`. This field should be omitted + if `visibility` is set to `all` or `private`. + type: array + items: + type: integer + auth_type: + description: The authentication type for the private registry. This + field cannot be changed after creation. If provided, it must match + the existing `auth_type` of the configuration. To change the authentication + type, delete and recreate the configuration. type: string enum: - token @@ -20561,6 +23411,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -20593,7 +23444,7 @@ paths: type: string audience: description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, - and required for `oidc_cloudsmith` auth types. + and `oidc_gcp`, and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` @@ -20611,312 +23462,15 @@ paths: description: The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default. type: string - required: - - registry_type - - url - - visibility - examples: - org-private-registry-with-private-visibility: - summary: Example of a private registry configuration with private - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - replaces_base: true - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: private - org-private-registry-with-selected-visibility: - summary: Example of a private registry configuration with selected - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - org-private-registry-with-oidc-azure: - summary: Example of an OIDC private registry configuration using Azure - value: - registry_type: docker_registry - url: https://myregistry.azurecr.io - auth_type: oidc_azure - visibility: all - tenant_id: 12345678-1234-1234-1234-123456789012 - client_id: abcdef01-2345-6789-abcd-ef0123456789 - org-private-registry-with-oidc-cloudsmith: - summary: Example of an OIDC private registry configuration using Cloudsmith - value: - registry_type: npm_registry - url: https://npm.cloudsmith.io/my-org/my-repo/ - auth_type: oidc_cloudsmith - visibility: all - namespace: my-org - service_slug: my-service-account - audience: https://github.com/my-org - responses: - '201': - description: The organization private registry configuration - content: - application/json: - schema: - "$ref": "#/components/schemas/org-private-registry-configuration-with-selected-repositories" - examples: - org-private-registry-with-selected-visibility: - "$ref": "#/components/examples/org-private-registry-configuration" - org-private-registry-with-private-visibility: - "$ref": "#/components/examples/org-private-registry-configuration-with-selected-repositories" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/public-key": - get: - summary: Get private registries public key for an organization - description: |2- - - Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - key_id - - key - properties: - key_id: - description: The identifier for the key. - type: string - examples: - - '012345678912345678' - key: - description: The Base64 encoded public key. - type: string - examples: - - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - examples: - default: - "$ref": "#/components/examples/private-registries-public-key" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/{secret_name}": - get: - summary: Get a private registry for an organization - description: |2- - - Get the configuration of a single private registry defined for an organization, omitting its encrypted value. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/secret-name" - responses: - '200': - description: The specified private registry configuration for the organization - content: - application/json: - schema: - "$ref": "#/components/schemas/org-private-registry-configuration" - examples: - default: - "$ref": "#/components/examples/org-private-registry-configuration" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - patch: - summary: Update a private registry for an organization - description: |2- - - Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/update-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/secret-name" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - registry_type: - description: The registry type. + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + Required when `auth_type` is `oidc_gcp`. type: string - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with the private - registry. This field should be omitted if the private registry - does not require a username for authentication. - type: - - string - - 'null' - replaces_base: - description: Whether this private registry should replace the base - registry (e.g., npmjs.org for npm, rubygems.org for rubygems). - When set to `true`, Dependabot will only use this registry and - will not fall back to the public registry. When set to `false` - (default), Dependabot will use this registry for scoped packages - but may fall back to the public registry for other packages. - type: boolean - default: false - encrypted_value: - description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get private registries - public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) - endpoint. - type: string - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - description: The ID of the key you used to encrypt the secret. - type: string - visibility: - description: Which type of organization repositories have access - to the private registry. `selected` means only the repositories - specified by `selected_repository_ids` can access the private - registry. - type: string - enum: - - all - - private - - selected - selected_repository_ids: - description: An array of repository IDs that can access the organization - private registry. You can only provide a list of repository IDs - when `visibility` is set to `selected`. This field should be omitted - if `visibility` is set to `all` or `private`. - type: array - items: - type: integer - auth_type: - description: The authentication type for the private registry. This - field cannot be changed after creation. If provided, it must match - the existing `auth_type` of the configuration. To change the authentication - type, delete and recreate the configuration. - type: string - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - - oidc_cloudsmith - tenant_id: - description: The tenant ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - client_id: - description: The client ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - aws_region: - description: The AWS region. Required when `auth_type` is `oidc_aws`. - type: string - account_id: - description: The AWS account ID. Required when `auth_type` is `oidc_aws`. - type: string - role_name: - description: The AWS IAM role name. Required when `auth_type` is - `oidc_aws`. - type: string - domain: - description: The CodeArtifact domain. Required when `auth_type` - is `oidc_aws`. - type: string - domain_owner: - description: The CodeArtifact domain owner (AWS account ID). Required - when `auth_type` is `oidc_aws`. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. Required when `auth_type` - is `oidc_jfrog`. - type: string - audience: - description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, - and required for `oidc_cloudsmith` auth types. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. Optional for `oidc_jfrog` - auth type. - type: string - namespace: - description: The Cloudsmith organization namespace. Required when - `auth_type` is `oidc_cloudsmith`. - type: string - service_slug: - description: The Cloudsmith service account slug. Required when - `auth_type` is `oidc_cloudsmith`. - type: string - api_host: - description: The Cloudsmith API host. Optional for `oidc_cloudsmith` - auth type. If omitted, `api.cloudsmith.io` is used by default. + service_account: + description: The GCP service account email to impersonate. Optional + for `oidc_gcp` auth type. If omitted, the federated token is used + directly (direct WIF). type: string examples: secret-based-update: @@ -23112,6 +25666,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + - "$ref": "#/components/parameters/secret-scanning-alert-bypassed" responses: '200': description: Response @@ -25695,6 +28250,111 @@ paths: enabledForGitHubApps: true category: actions subcategory: cache + "/repos/{owner}/{repo}/actions/concurrency_groups": + get: + summary: List concurrency groups for a repository + description: |- + Lists the active concurrency groups for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-concurrency-groups-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-after" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/concurrency-group-list" + examples: + default: + "$ref": "#/components/examples/concurrency-group-list" + headers: + Link: + "$ref": "#/components/headers/link" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups + "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}": + get: + summary: Get a concurrency group for a repository + description: |- + Gets a specific concurrency group for a repository, including all instances in the group's queue. + Returns 404 if the group is inactive or does not exist. + + Optionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items + ahead of the specified workflow run or job in the queue, plus the specified item itself + (returned as the last element). This is useful for determining what is blocking a particular + run or job. Returns 422 if the specified run or job is not in this concurrency group. + + When using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow + leases held on behalf of that run. Job-level leases within the run are not considered to + block the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow + leases on the job's ancestor paths. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-concurrency-group-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/concurrency-group-name" + - name: ahead_of_run + description: |- + Filter to items ahead of this workflow run ID in the queue, plus the run itself. + Matches workflow-level concurrency and reusable-workflow leases held on behalf of + the run. Mutually exclusive with `ahead_of_job`. + in: query + required: false + schema: + type: integer + minimum: 1 + - name: ahead_of_job + description: |- + Filter to items ahead of this job ID in the queue, plus the job itself. + Matches job-level concurrency and reusable-workflow leases on the job's + ancestor paths. Mutually exclusive with `ahead_of_run`. + in: query + required: false + schema: + type: integer + minimum: 1 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/concurrency-group" + examples: + default: + "$ref": "#/components/examples/concurrency-group" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups "/repos/{owner}/{repo}/actions/jobs/{job_id}": get: summary: Get a job for a workflow run @@ -27397,6 +30057,64 @@ paths: enabledForGitHubApps: true category: actions subcategory: workflow-runs + "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups": + get: + summary: List concurrency groups for a workflow run + description: |- + Lists all concurrency groups associated with a workflow run or its jobs. + + The set of groups is derived from the run's configuration, so a group is + included even when the run no longer has any items currently holding or + waiting in it. In that case the `group_members` array will be empty. + `total_count` reflects the number of groups the run participates in by + configuration, not the number with active items. + + This differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`, + which returns 404 when a group has no active items. That endpoint reports + the live state of a group repo-wide, while this endpoint reports the + groups associated with a specific run by configuration. + + Results are sorted by group name and support cursor-based pagination via + `before` and `after`. The `after` cursor paginates forward only and does + not emit a `rel="prev"` Link; use `before` to page backward from a + forward page's `next` cursor. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-concurrency-groups-for-workflow-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/run-id" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/concurrency-group-run-list" + examples: + default: + "$ref": "#/components/examples/concurrency-group-run-list" + headers: + Link: + "$ref": "#/components/headers/link" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": post: summary: Review custom deployment protection rules for a workflow run @@ -48260,6 +50978,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + - "$ref": "#/components/parameters/secret-scanning-alert-bypassed" responses: '200': description: Response @@ -89300,6 +92019,7 @@ components: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -89367,6 +92087,14 @@ components: api_host: description: The Cloudsmith API host. type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity Provider + (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + type: string + service_account: + description: The GCP service account email to impersonate. If omitted, the + federated token is used directly (direct WIF). + type: string created_at: type: string format: date-time @@ -89417,6 +92145,7 @@ components: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -89489,6 +92218,14 @@ components: api_host: description: The Cloudsmith API host. type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity Provider + (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + type: string + service_account: + description: The GCP service account email to impersonate. If omitted, the + federated token is used directly (direct WIF). + type: string created_at: type: string format: date-time @@ -94668,6 +97405,112 @@ components: required: - total_count - actions_caches + concurrency-group-list: + title: Concurrency Group List + description: A list of active concurrency groups for a repository. + type: object + required: + - total_count + - concurrency_groups + properties: + total_count: + type: integer + concurrency_groups: + type: array + items: + type: object + required: + - group_name + - group_url + - last_acquired_at + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: API URL for this concurrency group. + last_acquired_at: + type: + - string + - 'null' + format: date-time + concurrency-group: + title: Concurrency Group + description: |- + A concurrency group with the workflow runs and jobs that are either currently holding + or waiting for the concurrency group lease. + type: object + required: + - group_name + - group_url + - total_count + - group_members + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: API URL for this concurrency group. + total_count: + type: integer + group_members: + type: array + items: + type: object + required: + - run_id + - run_name + - run_url + - run_html_url + - status + properties: + run_id: + type: integer + description: The ID of the workflow run. + run_name: + type: string + description: The name of the workflow run. + run_url: + type: + - string + - 'null' + format: uri + description: API URL for the workflow run. + run_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the workflow run. + job_id: + type: integer + description: The ID of the job, when the item represents a job-level + or reusable-workflow-level lease. + job_name: + type: string + description: The display name of the job, when the item represents + a job-level or reusable-workflow-level lease. + job_url: + type: + - string + - 'null' + format: uri + description: API URL for the job. + job_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the job. + status: + type: string + enum: + - in_progress + - pending job: title: Job description: Information of a job execution in a workflow run @@ -95371,6 +98214,116 @@ components: - state - user - comment + concurrency-group-run-list: + title: Concurrency Group Run List + description: A list of concurrency groups associated with a workflow run. + type: object + required: + - total_count + - concurrency_groups + properties: + total_count: + type: integer + description: |- + The total number of concurrency groups this workflow run participates in, + derived from the run's configuration. This count is not filtered by + whether the run currently holds or is waiting in each group, so it can + include groups whose `group_members` array is empty (for example, when + the run has already released its lease in that group). + concurrency_groups: + type: array + items: + type: object + required: + - group_name + - group_url + - group_members + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: |- + API URL for this concurrency group. May return 404 if the group + has no active items at the time it is requested, since the + get-by-name endpoint reports the live repo-wide state of a group + while this endpoint lists groups associated with a run by + configuration. + group_members: + type: array + description: |- + Items belonging to this workflow run that are either currently holding or + waiting for the concurrency group lease. May be empty if the run no + longer has any active or queued items in this group. + items: + type: object + required: + - run_id + - run_name + - run_url + - run_html_url + - status + - position + - position_url + properties: + run_id: + type: integer + description: The ID of the workflow run. + run_name: + type: string + description: The name of the workflow run. + run_url: + type: + - string + - 'null' + format: uri + description: API URL for the workflow run. + run_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the workflow run. + position: + type: integer + description: Queue position. 0 means the item holds the concurrency + lease (in_progress), 1 or higher means queued (pending). + position_url: + type: string + format: uri + description: API URL to get items ahead of this item in the + concurrency group. + job_id: + type: + - integer + - 'null' + description: The ID of the job, when the item represents a job-level + or reusable-workflow-level lease. + job_name: + type: + - string + - 'null' + description: The display name of the job, when the item represents + a job-level or reusable-workflow-level lease. + job_url: + type: + - string + - 'null' + format: uri + description: API URL for the job. + job_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the job. + status: + type: string + enum: + - in_progress + - pending review-custom-gates-comment-required: type: object properties: @@ -230662,6 +233615,41 @@ components: last_accessed_at: '2019-01-24T22:45:36.000Z' created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 + concurrency-group-list: + value: + total_count: 2 + concurrency_groups: + - group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + last_acquired_at: '2026-01-15T16:14:23Z' + - group_name: ci-build + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build + last_acquired_at: '2026-01-15T16:13:55Z' + concurrency-group: + value: + group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + total_count: 3 + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: in_progress + - run_id: 30433643 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433643 + status: pending + - run_id: 30433644 + run_name: Deploy hotfix + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433644 + job_id: 798245260 + job_name: deploy + job_url: https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260 + job_html_url: https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260 + status: pending job: value: id: 399444496 @@ -231338,6 +234326,34 @@ components: runner_group_name: my runner group workflow_name: CI head_branch: main + concurrency-group-run-list: + value: + total_count: 2 + concurrency_groups: + - group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: in_progress + position: 0 + position_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642 + - group_name: ci-build + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: pending + position: 2 + position_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260 + job_id: 798245260 + job_name: build + job_url: https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260 + job_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260 pending-deployment-items: value: - environment: @@ -248563,6 +251579,17 @@ components: schema: type: boolean default: false + secret-scanning-alert-bypassed: + name: is_bypassed + in: query + description: A boolean value (`true` or `false`) indicating whether to filter + alerts by their push protection bypass status. When set to `true`, only alerts + that were created because a push protection rule was bypassed will be returned. + When set to `false`, only alerts that were not caused by a push protection + bypass will be returned. + required: false + schema: + type: boolean network-configuration-id: name: network_configuration_id description: Unique identifier of the hosted compute network configuration. @@ -248678,6 +251705,13 @@ components: required: true schema: type: integer + concurrency-group-name: + name: concurrency_group_name + description: The name of the concurrency group. + in: path + required: true + schema: + type: string job-id: name: job_id description: The unique identifier of the job. diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 5c94afb10..2b51afbfe 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -530,6 +530,3174 @@ } } }, + "/agents/repos/{owner}/{repo}/tasks": { + "get": { + "summary": "List tasks for repository", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n\n**Fine-grained access tokens for \"List tasks for repository\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Start a task", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nStarts a new Copilot cloud agent task for a repository.\n\nThis endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription.\n\n**Fine-grained access tokens for \"Start a task\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read and write)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/create-task-in-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#start-a-task" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + } + ], + "requestBody": { + "required": true, + "description": "The task creation parameters, including the user's prompt and optional agent settings.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "prompt" + ], + "properties": { + "prompt": { + "type": "string", + "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`" + }, + "create_pull_request": { + "type": "boolean", + "description": "Whether to create a PR.", + "default": false + }, + "base_ref": { + "type": "string", + "description": "Base ref for new branch/PR" + } + } + }, + "examples": { + "default": { + "value": { + "prompt": "Fix the login button on the homepage", + "base_ref": "main" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Task created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "queued", + "session_count": 1, + "artifacts": [], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "400": { + "description": "Problems parsing JSON", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/repos/{owner}/{repo}/tasks/{task_id}": { + "get": { + "summary": "Get a task by repo", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n\n**Fine-grained access tokens for \"Get a task by repo\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-repo-and-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "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": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks": { + "get": { + "summary": "List tasks", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n\n**Fine-grained access tokens for \"List tasks\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks/{task_id}": { + "get": { + "summary": "Get a task by ID", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n\n**Fine-grained access tokens for \"Get a task by ID\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "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": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, "/app": { "get": { "summary": "Get the authenticated app", @@ -14772,7 +17940,7 @@ "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { "post": { "summary": "Set cluster deployment records", - "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.", + "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.\nNote: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments\narray resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use\nthe artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can\nonly have one name and version.", "tags": [ "orgs" ], @@ -14825,20 +17993,20 @@ "properties": { "name": { "type": "string", - "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", + "description": "The name of the artifact.", "minLength": 1, "maxLength": 256 }, "digest": { "type": "string", - "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", + "description": "The hex encoded digest of the artifact.", "minLength": 71, "maxLength": 71, "pattern": "^sha256:[a-f0-9]{64}$" }, "version": { "type": "string", - "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", + "description": "The artifact version.", "maxLength": 100, "x-multi-segment": true, "examples": [ @@ -28293,7 +31461,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -28378,7 +31546,393 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication.", + "type": "string", + "enum": [ + "token", + "username_password", + "oidc_azure", + "oidc_aws", + "oidc_jfrog", + "oidc_cloudsmith", + "oidc_gcp" + ] + }, + "tenant_id": { + "description": "The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`.", + "type": "string" + }, + "client_id": { + "description": "The client ID of the Azure AD application. Required when `auth_type` is `oidc_azure`.", + "type": "string" + }, + "aws_region": { + "description": "The AWS region. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "account_id": { + "description": "The AWS account ID. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "role_name": { + "description": "The AWS IAM role name. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "domain": { + "description": "The CodeArtifact domain. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "domain_owner": { + "description": "The CodeArtifact domain owner (AWS account ID). Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "jfrog_oidc_provider_name": { + "description": "The JFrog OIDC provider name. Required when `auth_type` is `oidc_jfrog`.", + "type": "string" + }, + "audience": { + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.", + "type": "string" + }, + "identity_mapping_name": { + "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", + "type": "string" + }, + "namespace": { + "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "service_slug": { + "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", + "type": "string" + }, + "api_host": { + "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "type": "string" + }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). Required when `auth_type` is `oidc_gcp`.", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + } + }, + "required": [ + "registry_type", + "url", + "visibility" + ] + }, + "examples": { + "org-private-registry-with-private-visibility": { + "summary": "Example of a private registry configuration with private visibility", + "value": { + "registry_type": "maven_repository", + "url": "https://maven.pkg.github.com/organization/", + "username": "monalisa", + "replaces_base": true, + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "private" + } + }, + "org-private-registry-with-selected-visibility": { + "summary": "Example of a private registry configuration with selected visibility", + "value": { + "registry_type": "maven_repository", + "url": "https://maven.pkg.github.com/organization/", + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + }, + "org-private-registry-with-oidc-azure": { + "summary": "Example of an OIDC private registry configuration using Azure", + "value": { + "registry_type": "docker_registry", + "url": "https://myregistry.azurecr.io", + "auth_type": "oidc_azure", + "visibility": "all", + "tenant_id": "12345678-1234-1234-1234-123456789012", + "client_id": "abcdef01-2345-6789-abcd-ef0123456789" + } + }, + "org-private-registry-with-oidc-cloudsmith": { + "summary": "Example of an OIDC private registry configuration using Cloudsmith", + "value": { + "registry_type": "npm_registry", + "url": "https://npm.cloudsmith.io/my-org/my-repo/", + "auth_type": "oidc_cloudsmith", + "visibility": "all", + "namespace": "my-org", + "service_slug": "my-service-account", + "audience": "https://github.com/my-org" + } + }, + "org-private-registry-with-oidc-gcp": { + "summary": "Example of an OIDC private registry configuration using Google Cloud Artifact Registry", + "value": { + "registry_type": "docker_registry", + "url": "https://us-docker.pkg.dev/my-project/my-repo", + "auth_type": "oidc_gcp", + "visibility": "all", + "workload_identity_provider": "projects/123456789/locations/global/workloadIdentityPools/github-pool/providers/github-provider", + "service_account": "dependabot@my-project.iam.gserviceaccount.com" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "The organization private registry configuration", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-private-registry-configuration-with-selected-repositories" + }, + "examples": { + "org-private-registry-with-selected-visibility": { + "$ref": "#/components/examples/org-private-registry-configuration" + }, + "org-private-registry-with-private-visibility": { + "$ref": "#/components/examples/org-private-registry-configuration-with-selected-repositories" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + } + }, + "/orgs/{org}/private-registries/public-key": { + "get": { + "summary": "Get private registries public key for an organization", + "description": "\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key_id", + "key" + ], + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "examples": [ + "012345678912345678" + ] + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "examples": [ + "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + ] + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/private-registries-public-key" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + } + }, + "/orgs/{org}/private-registries/{secret_name}": { + "get": { + "summary": "Get a private registry for an organization", + "description": "\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/get-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "The specified private registry configuration for the organization", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-private-registry-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-private-registry-configuration" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + }, + "patch": { + "summary": "Update a private registry for an organization", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/update-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "registry_type": { + "description": "The registry type.", + "type": "string", + "enum": [ + "maven_repository", + "nuget_feed", + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" + ] + }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, + "username": { + "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", + "type": [ + "string", + "null" + ] + }, + "replaces_base": { + "description": "Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, + "encrypted_value": { + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "description": "The ID of the key you used to encrypt the secret.", + "type": "string" + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "type": "string", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`.", + "type": "array", + "items": { + "type": "integer" + } + }, + "auth_type": { + "description": "The authentication type for the private registry. This field cannot be changed after creation. If provided, it must match the existing `auth_type` of the configuration. To change the authentication type, delete and recreate the configuration.", "type": "string", "enum": [ "token", @@ -28386,7 +31940,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -28422,7 +31977,7 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { @@ -28440,371 +31995,13 @@ "api_host": { "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", "type": "string" - } - }, - "required": [ - "registry_type", - "url", - "visibility" - ] - }, - "examples": { - "org-private-registry-with-private-visibility": { - "summary": "Example of a private registry configuration with private visibility", - "value": { - "registry_type": "maven_repository", - "url": "https://maven.pkg.github.com/organization/", - "username": "monalisa", - "replaces_base": true, - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "private" - } - }, - "org-private-registry-with-selected-visibility": { - "summary": "Example of a private registry configuration with selected visibility", - "value": { - "registry_type": "maven_repository", - "url": "https://maven.pkg.github.com/organization/", - "username": "monalisa", - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - } - }, - "org-private-registry-with-oidc-azure": { - "summary": "Example of an OIDC private registry configuration using Azure", - "value": { - "registry_type": "docker_registry", - "url": "https://myregistry.azurecr.io", - "auth_type": "oidc_azure", - "visibility": "all", - "tenant_id": "12345678-1234-1234-1234-123456789012", - "client_id": "abcdef01-2345-6789-abcd-ef0123456789" - } - }, - "org-private-registry-with-oidc-cloudsmith": { - "summary": "Example of an OIDC private registry configuration using Cloudsmith", - "value": { - "registry_type": "npm_registry", - "url": "https://npm.cloudsmith.io/my-org/my-repo/", - "auth_type": "oidc_cloudsmith", - "visibility": "all", - "namespace": "my-org", - "service_slug": "my-service-account", - "audience": "https://github.com/my-org" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "The organization private registry configuration", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/org-private-registry-configuration-with-selected-repositories" - }, - "examples": { - "org-private-registry-with-selected-visibility": { - "$ref": "#/components/examples/org-private-registry-configuration" }, - "org-private-registry-with-private-visibility": { - "$ref": "#/components/examples/org-private-registry-configuration-with-selected-repositories" - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "private-registries", - "subcategory": "organization-configurations" - } - } - }, - "/orgs/{org}/private-registries/public-key": { - "get": { - "summary": "Get private registries public key for an organization", - "description": "\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "private-registries" - ], - "operationId": "private-registries/get-org-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "key_id", - "key" - ], - "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "examples": [ - "012345678912345678" - ] - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "examples": [ - "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - ] - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/private-registries-public-key" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "private-registries", - "subcategory": "organization-configurations" - } - } - }, - "/orgs/{org}/private-registries/{secret_name}": { - "get": { - "summary": "Get a private registry for an organization", - "description": "\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "private-registries" - ], - "operationId": "private-registries/get-org-private-registry", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "responses": { - "200": { - "description": "The specified private registry configuration for the organization", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/org-private-registry-configuration" - }, - "examples": { - "default": { - "$ref": "#/components/examples/org-private-registry-configuration" - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "private-registries", - "subcategory": "organization-configurations" - } - }, - "patch": { - "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "private-registries" - ], - "operationId": "private-registries/update-org-private-registry", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/secret-name" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "registry_type": { - "description": "The registry type.", - "type": "string", - "enum": [ - "maven_repository", - "nuget_feed", - "goproxy_server", - "npm_registry", - "rubygems_server", - "cargo_registry", - "composer_repository", - "docker_registry", - "git_source", - "helm_registry", - "hex_organization", - "hex_repository", - "pub_repository", - "python_index", - "terraform_registry" - ] - }, - "url": { - "description": "The URL of the private registry.", - "type": "string", - "format": "uri" - }, - "username": { - "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", - "type": [ - "string", - "null" - ] - }, - "replaces_base": { - "description": "Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", - "type": "boolean", - "default": false - }, - "encrypted_value": { - "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", - "type": "string", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "description": "The ID of the key you used to encrypt the secret.", - "type": "string" - }, - "visibility": { - "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", - "type": "string", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`.", - "type": "array", - "items": { - "type": "integer" - } - }, - "auth_type": { - "description": "The authentication type for the private registry. This field cannot be changed after creation. If provided, it must match the existing `auth_type` of the configuration. To change the authentication type, delete and recreate the configuration.", - "type": "string", - "enum": [ - "token", - "username_password", - "oidc_azure", - "oidc_aws", - "oidc_jfrog", - "oidc_cloudsmith" - ] - }, - "tenant_id": { - "description": "The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`.", + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). Required when `auth_type` is `oidc_gcp`.", "type": "string" }, - "client_id": { - "description": "The client ID of the Azure AD application. Required when `auth_type` is `oidc_azure`.", - "type": "string" - }, - "aws_region": { - "description": "The AWS region. Required when `auth_type` is `oidc_aws`.", - "type": "string" - }, - "account_id": { - "description": "The AWS account ID. Required when `auth_type` is `oidc_aws`.", - "type": "string" - }, - "role_name": { - "description": "The AWS IAM role name. Required when `auth_type` is `oidc_aws`.", - "type": "string" - }, - "domain": { - "description": "The CodeArtifact domain. Required when `auth_type` is `oidc_aws`.", - "type": "string" - }, - "domain_owner": { - "description": "The CodeArtifact domain owner (AWS account ID). Required when `auth_type` is `oidc_aws`.", - "type": "string" - }, - "jfrog_oidc_provider_name": { - "description": "The JFrog OIDC provider name. Required when `auth_type` is `oidc_jfrog`.", - "type": "string" - }, - "audience": { - "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", - "type": "string" - }, - "identity_mapping_name": { - "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", - "type": "string" - }, - "namespace": { - "description": "The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.", - "type": "string" - }, - "service_slug": { - "description": "The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.", - "type": "string" - }, - "api_host": { - "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", + "service_account": { + "description": "The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).", "type": "string" } } @@ -32010,6 +35207,9 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-bypassed" } ], "responses": { @@ -35454,6 +38654,139 @@ } } }, + "/repos/{owner}/{repo}/actions/concurrency_groups": { + "get": { + "summary": "List concurrency groups for a repository", + "description": "Lists the active concurrency groups for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-concurrency-groups-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/concurrency-group-list" + }, + "examples": { + "default": { + "$ref": "#/components/examples/concurrency-group-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "concurrency-groups" + } + } + }, + "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}": { + "get": { + "summary": "Get a concurrency group for a repository", + "description": "Gets a specific concurrency group for a repository, including all instances in the group's queue.\nReturns 404 if the group is inactive or does not exist.\n\nOptionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items\nahead of the specified workflow run or job in the queue, plus the specified item itself\n(returned as the last element). This is useful for determining what is blocking a particular\nrun or job. Returns 422 if the specified run or job is not in this concurrency group.\n\nWhen using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow\nleases held on behalf of that run. Job-level leases within the run are not considered to\nblock the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow\nleases on the job's ancestor paths.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/get-concurrency-group-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/concurrency-group-name" + }, + { + "name": "ahead_of_run", + "description": "Filter to items ahead of this workflow run ID in the queue, plus the run itself.\nMatches workflow-level concurrency and reusable-workflow leases held on behalf of\nthe run. Mutually exclusive with `ahead_of_job`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + }, + { + "name": "ahead_of_job", + "description": "Filter to items ahead of this job ID in the queue, plus the job itself.\nMatches job-level concurrency and reusable-workflow leases on the job's\nancestor paths. Mutually exclusive with `ahead_of_run`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/concurrency-group" + }, + "examples": { + "default": { + "$ref": "#/components/examples/concurrency-group" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "concurrency-groups" + } + } + }, "/repos/{owner}/{repo}/actions/jobs/{job_id}": { "get": { "summary": "Get a job for a workflow run", @@ -37867,6 +41200,74 @@ } } }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups": { + "get": { + "summary": "List concurrency groups for a workflow run", + "description": "Lists all concurrency groups associated with a workflow run or its jobs.\n\nThe set of groups is derived from the run's configuration, so a group is\nincluded even when the run no longer has any items currently holding or\nwaiting in it. In that case the `group_members` array will be empty.\n`total_count` reflects the number of groups the run participates in by\nconfiguration, not the number with active items.\n\nThis differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`,\nwhich returns 404 when a group has no active items. That endpoint reports\nthe live state of a group repo-wide, while this endpoint reports the\ngroups associated with a specific run by configuration.\n\nResults are sorted by group name and support cursor-based pagination via\n`before` and `after`. The `after` cursor paginates forward only and does\nnot emit a `rel=\"prev\"` Link; use `before` to page backward from a\nforward page's `next` cursor.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-concurrency-groups-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/concurrency-group-run-list" + }, + "examples": { + "default": { + "$ref": "#/components/examples/concurrency-group-run-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "concurrency-groups" + } + } + }, "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { "post": { "summary": "Review custom deployment protection rules for a workflow run", @@ -66767,6 +70168,9 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-bypassed" } ], "responses": { @@ -124244,7 +127648,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -124329,6 +127734,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -124387,7 +127800,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -124476,6 +127890,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -131878,6 +135300,144 @@ "actions_caches" ] }, + "concurrency-group-list": { + "title": "Concurrency Group List", + "description": "A list of active concurrency groups for a repository.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "last_acquired_at" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "last_acquired_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + } + } + } + } + }, + "concurrency-group": { + "title": "Concurrency Group", + "description": "A concurrency group with the workflow runs and jobs that are either currently holding\nor waiting for the concurrency group lease.", + "type": "object", + "required": [ + "group_name", + "group_url", + "total_count", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "total_count": { + "type": "integer" + }, + "group_members": { + "type": "array", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "job_id": { + "type": "integer", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + }, "job": { "title": "Job", "description": "Information of a job execution in a workflow run", @@ -132809,6 +136369,131 @@ "comment" ] }, + "concurrency-group-run-list": { + "title": "Concurrency Group Run List", + "description": "A list of concurrency groups associated with a workflow run.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer", + "description": "The total number of concurrency groups this workflow run participates in,\nderived from the run's configuration. This count is not filtered by\nwhether the run currently holds or is waiting in each group, so it can\ninclude groups whose `group_members` array is empty (for example, when\nthe run has already released its lease in that group)." + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group. May return 404 if the group\nhas no active items at the time it is requested, since the\nget-by-name endpoint reports the live repo-wide state of a group\nwhile this endpoint lists groups associated with a run by\nconfiguration." + }, + "group_members": { + "type": "array", + "description": "Items belonging to this workflow run that are either currently holding or\nwaiting for the concurrency group lease. May be empty if the run no\nlonger has any active or queued items in this group.", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status", + "position", + "position_url" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "position": { + "type": "integer", + "description": "Queue position. 0 means the item holds the concurrency lease (in_progress), 1 or higher means queued (pending)." + }, + "position_url": { + "type": "string", + "format": "uri", + "description": "API URL to get items ahead of this item in the concurrency group." + }, + "job_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": [ + "string", + "null" + ], + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } + }, "review-custom-gates-comment-required": { "type": "object", "properties": { @@ -314456,6 +318141,57 @@ ] } }, + "concurrency-group-list": { + "value": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "last_acquired_at": "2026-01-15T16:14:23Z" + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "last_acquired_at": "2026-01-15T16:13:55Z" + } + ] + } + }, + "concurrency-group": { + "value": { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "total_count": 3, + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress" + }, + { + "run_id": 30433643, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433643", + "status": "pending" + }, + { + "run_id": 30433644, + "run_name": "Deploy hotfix", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644", + "job_id": 798245260, + "job_name": "deploy", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260", + "status": "pending" + } + ] + } + }, "job": { "value": { "id": 399444496, @@ -315244,6 +318980,47 @@ ] } }, + "concurrency-group-run-list": { + "value": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress", + "position": 0, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642" + } + ] + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "pending", + "position": 2, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260", + "job_id": 798245260, + "job_name": "build", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260" + } + ] + } + ] + } + }, "pending-deployment-items": { "value": [ { @@ -335385,6 +339162,15 @@ "default": false } }, + "secret-scanning-alert-bypassed": { + "name": "is_bypassed", + "in": "query", + "description": "A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.", + "required": false, + "schema": { + "type": "boolean" + } + }, "network-configuration-id": { "name": "network_configuration_id", "description": "Unique identifier of the hosted compute network configuration.", @@ -335518,6 +339304,15 @@ "type": "integer" } }, + "concurrency-group-name": { + "name": "concurrency_group_name", + "description": "The name of the concurrency group.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "job-id": { "name": "job_id", "description": "The unique identifier of the job.", diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index bee45867e..878997e46 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -343,6 +343,2530 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories + "/agents/repos/{owner}/{repo}/tasks": + get: + summary: List tasks for repository + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for a specific repository + + **Fine-grained access tokens for "List tasks for repository"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/list-tasks-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, + `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived + tasks. When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + - name: creator_id + in: query + schema: + type: integer + description: Filter tasks by creator user ID + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="prev" (when current page > 1), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; + rel="next", ; + rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + post: + summary: Start a task + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Starts a new Copilot cloud agent task for a repository. + + This endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription. + + **Fine-grained access tokens for "Start a task"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read and write) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/create-task-in-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#start-a-task + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + requestBody: + required: true + description: The task creation parameters, including the user's prompt and + optional agent settings. + content: + application/json: + schema: + type: object + required: + - prompt + properties: + prompt: + type: string + 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`' + create_pull_request: + type: boolean + description: Whether to create a PR. + default: false + base_ref: + type: string + description: Base ref for new branch/PR + examples: + default: + value: + prompt: Fix the login button on the homepage + base_ref: main + responses: + '201': + description: Task created successfully + content: + application/json: + schema: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: queued + session_count: 1 + artifacts: [] + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '400': + description: Problems parsing JSON + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/repos/{owner}/{repo}/tasks/{task_id}": + get: + summary: Get a task by repo + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID scoped to an owner/repo path + + **Fine-grained access tokens for "Get a task by repo"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-repo-and-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + allOf: + - type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + 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: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/tasks": + get: + summary: List tasks + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for the authenticated user + + **Fine-grained access tokens for "List tasks"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/list-tasks + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, + `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived + tasks. When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; rel="next", + ; rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/tasks/{task_id}": + get: + summary: Get a task by ID + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID with its associated sessions + + **Fine-grained access tokens for "Get a task by ID"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + allOf: + - type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + 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: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation "/app": get: summary: Get the authenticated app @@ -10678,6 +13202,10 @@ paths: If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. If no existing records match, new records will be created. + Note: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments + array resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use + the artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can + only have one name and version. tags: - orgs operationId: orgs/set-cluster-deployment-records @@ -10720,24 +13248,18 @@ paths: properties: name: type: string - description: | - The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name parameter must also be identical across all entries. + description: The name of the artifact. minLength: 1 maxLength: 256 digest: type: string - description: | - The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name and version parameters must also be identical across all entries. + description: The hex encoded digest of the artifact. minLength: 71 maxLength: 71 pattern: "^sha256:[a-f0-9]{64}$" version: type: string - description: | - The artifact version. Note that if multiple deployments have identical 'digest' parameter values, - the version parameter must also be identical across all entries. + description: The artifact version. maxLength: 100 x-multi-segment: true examples: @@ -20585,7 +23107,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -20679,7 +23201,335 @@ paths: auth_type: description: The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, - or `oidc_cloudsmith` for OIDC authentication. + `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication. + type: string + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + - oidc_cloudsmith + - oidc_gcp + tenant_id: + description: The tenant ID of the Azure AD application. Required + when `auth_type` is `oidc_azure`. + type: string + client_id: + description: The client ID of the Azure AD application. Required + when `auth_type` is `oidc_azure`. + type: string + aws_region: + description: The AWS region. Required when `auth_type` is `oidc_aws`. + type: string + account_id: + description: The AWS account ID. Required when `auth_type` is `oidc_aws`. + type: string + role_name: + description: The AWS IAM role name. Required when `auth_type` is + `oidc_aws`. + type: string + domain: + description: The CodeArtifact domain. Required when `auth_type` + is `oidc_aws`. + type: string + domain_owner: + description: The CodeArtifact domain owner (AWS account ID). Required + when `auth_type` is `oidc_aws`. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. Required when `auth_type` + is `oidc_jfrog`. + type: string + audience: + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and `oidc_gcp`, and required for `oidc_cloudsmith` auth types. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. Optional for `oidc_jfrog` + auth type. + type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + Required when `auth_type` is `oidc_gcp`. + type: string + service_account: + description: The GCP service account email to impersonate. Optional + for `oidc_gcp` auth type. If omitted, the federated token is used + directly (direct WIF). + type: string + required: + - registry_type + - url + - visibility + examples: + org-private-registry-with-private-visibility: + summary: Example of a private registry configuration with private + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + replaces_base: true + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: private + org-private-registry-with-selected-visibility: + summary: Example of a private registry configuration with selected + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + org-private-registry-with-oidc-azure: + summary: Example of an OIDC private registry configuration using Azure + value: + registry_type: docker_registry + url: https://myregistry.azurecr.io + auth_type: oidc_azure + visibility: all + tenant_id: 12345678-1234-1234-1234-123456789012 + client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org + org-private-registry-with-oidc-gcp: + summary: Example of an OIDC private registry configuration using Google + Cloud Artifact Registry + value: + registry_type: docker_registry + url: https://us-docker.pkg.dev/my-project/my-repo + auth_type: oidc_gcp + visibility: all + workload_identity_provider: projects/123456789/locations/global/workloadIdentityPools/github-pool/providers/github-provider + service_account: dependabot@my-project.iam.gserviceaccount.com + responses: + '201': + description: The organization private registry configuration + content: + application/json: + schema: + "$ref": "#/components/schemas/org-private-registry-configuration-with-selected-repositories" + examples: + org-private-registry-with-selected-visibility: + "$ref": "#/components/examples/org-private-registry-configuration" + org-private-registry-with-private-visibility: + "$ref": "#/components/examples/org-private-registry-configuration-with-selected-repositories" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/public-key": + get: + summary: Get private registries public key for an organization + description: |2- + + Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - key_id + - key + properties: + key_id: + description: The identifier for the key. + type: string + examples: + - '012345678912345678' + key: + description: The Base64 encoded public key. + type: string + examples: + - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + examples: + default: + "$ref": "#/components/examples/private-registries-public-key" + headers: + Link: + "$ref": "#/components/headers/link" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/{secret_name}": + get: + summary: Get a private registry for an organization + description: |2- + + Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/secret-name" + responses: + '200': + description: The specified private registry configuration for the organization + content: + application/json: + schema: + "$ref": "#/components/schemas/org-private-registry-configuration" + examples: + default: + "$ref": "#/components/examples/org-private-registry-configuration" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + patch: + summary: Update a private registry for an organization + description: |2- + + Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/update-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/secret-name" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + registry_type: + description: The registry type. + type: string + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the private + registry. This field should be omitted if the private registry + does not require a username for authentication. + type: + - string + - 'null' + replaces_base: + description: Whether this private registry should replace the base + registry (e.g., npmjs.org for npm, rubygems.org for rubygems). + When set to `true`, Dependabot will only use this registry and + will not fall back to the public registry. When set to `false` + (default), Dependabot will use this registry for scoped packages + but may fall back to the public registry for other packages. + type: boolean + default: false + encrypted_value: + description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get private registries + public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + endpoint. + type: string + pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + key_id: + description: The ID of the key you used to encrypt the secret. + type: string + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + type: string + enum: + - all + - private + - selected + selected_repository_ids: + description: An array of repository IDs that can access the organization + private registry. You can only provide a list of repository IDs + when `visibility` is set to `selected`. This field should be omitted + if `visibility` is set to `all` or `private`. + type: array + items: + type: integer + auth_type: + description: The authentication type for the private registry. This + field cannot be changed after creation. If provided, it must match + the existing `auth_type` of the configuration. To change the authentication + type, delete and recreate the configuration. type: string enum: - token @@ -20688,6 +23538,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -20720,7 +23571,7 @@ paths: type: string audience: description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, - and required for `oidc_cloudsmith` auth types. + and `oidc_gcp`, and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` @@ -20738,312 +23589,15 @@ paths: description: The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default. type: string - required: - - registry_type - - url - - visibility - examples: - org-private-registry-with-private-visibility: - summary: Example of a private registry configuration with private - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - replaces_base: true - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: private - org-private-registry-with-selected-visibility: - summary: Example of a private registry configuration with selected - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - org-private-registry-with-oidc-azure: - summary: Example of an OIDC private registry configuration using Azure - value: - registry_type: docker_registry - url: https://myregistry.azurecr.io - auth_type: oidc_azure - visibility: all - tenant_id: 12345678-1234-1234-1234-123456789012 - client_id: abcdef01-2345-6789-abcd-ef0123456789 - org-private-registry-with-oidc-cloudsmith: - summary: Example of an OIDC private registry configuration using Cloudsmith - value: - registry_type: npm_registry - url: https://npm.cloudsmith.io/my-org/my-repo/ - auth_type: oidc_cloudsmith - visibility: all - namespace: my-org - service_slug: my-service-account - audience: https://github.com/my-org - responses: - '201': - description: The organization private registry configuration - content: - application/json: - schema: - "$ref": "#/components/schemas/org-private-registry-configuration-with-selected-repositories" - examples: - org-private-registry-with-selected-visibility: - "$ref": "#/components/examples/org-private-registry-configuration" - org-private-registry-with-private-visibility: - "$ref": "#/components/examples/org-private-registry-configuration-with-selected-repositories" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/public-key": - get: - summary: Get private registries public key for an organization - description: |2- - - Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - key_id - - key - properties: - key_id: - description: The identifier for the key. - type: string - examples: - - '012345678912345678' - key: - description: The Base64 encoded public key. - type: string - examples: - - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - examples: - default: - "$ref": "#/components/examples/private-registries-public-key" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/{secret_name}": - get: - summary: Get a private registry for an organization - description: |2- - - Get the configuration of a single private registry defined for an organization, omitting its encrypted value. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/secret-name" - responses: - '200': - description: The specified private registry configuration for the organization - content: - application/json: - schema: - "$ref": "#/components/schemas/org-private-registry-configuration" - examples: - default: - "$ref": "#/components/examples/org-private-registry-configuration" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - patch: - summary: Update a private registry for an organization - description: |2- - - Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/update-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/secret-name" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - registry_type: - description: The registry type. + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + Required when `auth_type` is `oidc_gcp`. type: string - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with the private - registry. This field should be omitted if the private registry - does not require a username for authentication. - type: - - string - - 'null' - replaces_base: - description: Whether this private registry should replace the base - registry (e.g., npmjs.org for npm, rubygems.org for rubygems). - When set to `true`, Dependabot will only use this registry and - will not fall back to the public registry. When set to `false` - (default), Dependabot will use this registry for scoped packages - but may fall back to the public registry for other packages. - type: boolean - default: false - encrypted_value: - description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get private registries - public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) - endpoint. - type: string - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - description: The ID of the key you used to encrypt the secret. - type: string - visibility: - description: Which type of organization repositories have access - to the private registry. `selected` means only the repositories - specified by `selected_repository_ids` can access the private - registry. - type: string - enum: - - all - - private - - selected - selected_repository_ids: - description: An array of repository IDs that can access the organization - private registry. You can only provide a list of repository IDs - when `visibility` is set to `selected`. This field should be omitted - if `visibility` is set to `all` or `private`. - type: array - items: - type: integer - auth_type: - description: The authentication type for the private registry. This - field cannot be changed after creation. If provided, it must match - the existing `auth_type` of the configuration. To change the authentication - type, delete and recreate the configuration. - type: string - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - - oidc_cloudsmith - tenant_id: - description: The tenant ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - client_id: - description: The client ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - aws_region: - description: The AWS region. Required when `auth_type` is `oidc_aws`. - type: string - account_id: - description: The AWS account ID. Required when `auth_type` is `oidc_aws`. - type: string - role_name: - description: The AWS IAM role name. Required when `auth_type` is - `oidc_aws`. - type: string - domain: - description: The CodeArtifact domain. Required when `auth_type` - is `oidc_aws`. - type: string - domain_owner: - description: The CodeArtifact domain owner (AWS account ID). Required - when `auth_type` is `oidc_aws`. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. Required when `auth_type` - is `oidc_jfrog`. - type: string - audience: - description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, - and required for `oidc_cloudsmith` auth types. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. Optional for `oidc_jfrog` - auth type. - type: string - namespace: - description: The Cloudsmith organization namespace. Required when - `auth_type` is `oidc_cloudsmith`. - type: string - service_slug: - description: The Cloudsmith service account slug. Required when - `auth_type` is `oidc_cloudsmith`. - type: string - api_host: - description: The Cloudsmith API host. Optional for `oidc_cloudsmith` - auth type. If omitted, `api.cloudsmith.io` is used by default. + service_account: + description: The GCP service account email to impersonate. Optional + for `oidc_gcp` auth type. If omitted, the federated token is used + directly (direct WIF). type: string examples: secret-based-update: @@ -23244,6 +25798,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + - "$ref": "#/components/parameters/secret-scanning-alert-bypassed" responses: '200': description: Response @@ -25846,6 +28401,111 @@ paths: enabledForGitHubApps: true category: actions subcategory: cache + "/repos/{owner}/{repo}/actions/concurrency_groups": + get: + summary: List concurrency groups for a repository + description: |- + Lists the active concurrency groups for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-concurrency-groups-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-after" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/concurrency-group-list" + examples: + default: + "$ref": "#/components/examples/concurrency-group-list" + headers: + Link: + "$ref": "#/components/headers/link" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups + "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}": + get: + summary: Get a concurrency group for a repository + description: |- + Gets a specific concurrency group for a repository, including all instances in the group's queue. + Returns 404 if the group is inactive or does not exist. + + Optionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items + ahead of the specified workflow run or job in the queue, plus the specified item itself + (returned as the last element). This is useful for determining what is blocking a particular + run or job. Returns 422 if the specified run or job is not in this concurrency group. + + When using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow + leases held on behalf of that run. Job-level leases within the run are not considered to + block the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow + leases on the job's ancestor paths. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-concurrency-group-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/concurrency-group-name" + - name: ahead_of_run + description: |- + Filter to items ahead of this workflow run ID in the queue, plus the run itself. + Matches workflow-level concurrency and reusable-workflow leases held on behalf of + the run. Mutually exclusive with `ahead_of_job`. + in: query + required: false + schema: + type: integer + minimum: 1 + - name: ahead_of_job + description: |- + Filter to items ahead of this job ID in the queue, plus the job itself. + Matches job-level concurrency and reusable-workflow leases on the job's + ancestor paths. Mutually exclusive with `ahead_of_run`. + in: query + required: false + schema: + type: integer + minimum: 1 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/concurrency-group" + examples: + default: + "$ref": "#/components/examples/concurrency-group" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups "/repos/{owner}/{repo}/actions/jobs/{job_id}": get: summary: Get a job for a workflow run @@ -27548,6 +30208,64 @@ paths: enabledForGitHubApps: true category: actions subcategory: workflow-runs + "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups": + get: + summary: List concurrency groups for a workflow run + description: |- + Lists all concurrency groups associated with a workflow run or its jobs. + + The set of groups is derived from the run's configuration, so a group is + included even when the run no longer has any items currently holding or + waiting in it. In that case the `group_members` array will be empty. + `total_count` reflects the number of groups the run participates in by + configuration, not the number with active items. + + This differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`, + which returns 404 when a group has no active items. That endpoint reports + the live state of a group repo-wide, while this endpoint reports the + groups associated with a specific run by configuration. + + Results are sorted by group name and support cursor-based pagination via + `before` and `after`. The `after` cursor paginates forward only and does + not emit a `rel="prev"` Link; use `before` to page backward from a + forward page's `next` cursor. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-concurrency-groups-for-workflow-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/run-id" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/concurrency-group-run-list" + examples: + default: + "$ref": "#/components/examples/concurrency-group-run-list" + headers: + Link: + "$ref": "#/components/headers/link" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": post: summary: Review custom deployment protection rules for a workflow run @@ -48523,6 +51241,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + - "$ref": "#/components/parameters/secret-scanning-alert-bypassed" responses: '200': description: Response @@ -90221,6 +92940,7 @@ components: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -90288,6 +93008,14 @@ components: api_host: description: The Cloudsmith API host. type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity Provider + (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + type: string + service_account: + description: The GCP service account email to impersonate. If omitted, the + federated token is used directly (direct WIF). + type: string created_at: type: string format: date-time @@ -90338,6 +93066,7 @@ components: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -90410,6 +93139,14 @@ components: api_host: description: The Cloudsmith API host. type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity Provider + (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + type: string + service_account: + description: The GCP service account email to impersonate. If omitted, the + federated token is used directly (direct WIF). + type: string created_at: type: string format: date-time @@ -95843,6 +98580,112 @@ components: required: - total_count - actions_caches + concurrency-group-list: + title: Concurrency Group List + description: A list of active concurrency groups for a repository. + type: object + required: + - total_count + - concurrency_groups + properties: + total_count: + type: integer + concurrency_groups: + type: array + items: + type: object + required: + - group_name + - group_url + - last_acquired_at + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: API URL for this concurrency group. + last_acquired_at: + type: + - string + - 'null' + format: date-time + concurrency-group: + title: Concurrency Group + description: |- + A concurrency group with the workflow runs and jobs that are either currently holding + or waiting for the concurrency group lease. + type: object + required: + - group_name + - group_url + - total_count + - group_members + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: API URL for this concurrency group. + total_count: + type: integer + group_members: + type: array + items: + type: object + required: + - run_id + - run_name + - run_url + - run_html_url + - status + properties: + run_id: + type: integer + description: The ID of the workflow run. + run_name: + type: string + description: The name of the workflow run. + run_url: + type: + - string + - 'null' + format: uri + description: API URL for the workflow run. + run_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the workflow run. + job_id: + type: integer + description: The ID of the job, when the item represents a job-level + or reusable-workflow-level lease. + job_name: + type: string + description: The display name of the job, when the item represents + a job-level or reusable-workflow-level lease. + job_url: + type: + - string + - 'null' + format: uri + description: API URL for the job. + job_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the job. + status: + type: string + enum: + - in_progress + - pending job: title: Job description: Information of a job execution in a workflow run @@ -96546,6 +99389,116 @@ components: - state - user - comment + concurrency-group-run-list: + title: Concurrency Group Run List + description: A list of concurrency groups associated with a workflow run. + type: object + required: + - total_count + - concurrency_groups + properties: + total_count: + type: integer + description: |- + The total number of concurrency groups this workflow run participates in, + derived from the run's configuration. This count is not filtered by + whether the run currently holds or is waiting in each group, so it can + include groups whose `group_members` array is empty (for example, when + the run has already released its lease in that group). + concurrency_groups: + type: array + items: + type: object + required: + - group_name + - group_url + - group_members + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: |- + API URL for this concurrency group. May return 404 if the group + has no active items at the time it is requested, since the + get-by-name endpoint reports the live repo-wide state of a group + while this endpoint lists groups associated with a run by + configuration. + group_members: + type: array + description: |- + Items belonging to this workflow run that are either currently holding or + waiting for the concurrency group lease. May be empty if the run no + longer has any active or queued items in this group. + items: + type: object + required: + - run_id + - run_name + - run_url + - run_html_url + - status + - position + - position_url + properties: + run_id: + type: integer + description: The ID of the workflow run. + run_name: + type: string + description: The name of the workflow run. + run_url: + type: + - string + - 'null' + format: uri + description: API URL for the workflow run. + run_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the workflow run. + position: + type: integer + description: Queue position. 0 means the item holds the concurrency + lease (in_progress), 1 or higher means queued (pending). + position_url: + type: string + format: uri + description: API URL to get items ahead of this item in the + concurrency group. + job_id: + type: + - integer + - 'null' + description: The ID of the job, when the item represents a job-level + or reusable-workflow-level lease. + job_name: + type: + - string + - 'null' + description: The display name of the job, when the item represents + a job-level or reusable-workflow-level lease. + job_url: + type: + - string + - 'null' + format: uri + description: API URL for the job. + job_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the job. + status: + type: string + enum: + - in_progress + - pending review-custom-gates-comment-required: type: object properties: @@ -232639,6 +235592,41 @@ components: last_accessed_at: '2019-01-24T22:45:36.000Z' created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 + concurrency-group-list: + value: + total_count: 2 + concurrency_groups: + - group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + last_acquired_at: '2026-01-15T16:14:23Z' + - group_name: ci-build + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build + last_acquired_at: '2026-01-15T16:13:55Z' + concurrency-group: + value: + group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + total_count: 3 + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: in_progress + - run_id: 30433643 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433643 + status: pending + - run_id: 30433644 + run_name: Deploy hotfix + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433644 + job_id: 798245260 + job_name: deploy + job_url: https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260 + job_html_url: https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260 + status: pending job: value: id: 399444496 @@ -233315,6 +236303,34 @@ components: runner_group_name: my runner group workflow_name: CI head_branch: main + concurrency-group-run-list: + value: + total_count: 2 + concurrency_groups: + - group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: in_progress + position: 0 + position_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642 + - group_name: ci-build + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: pending + position: 2 + position_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260 + job_id: 798245260 + job_name: build + job_url: https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260 + job_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260 pending-deployment-items: value: - environment: @@ -250689,6 +253705,17 @@ components: schema: type: boolean default: false + secret-scanning-alert-bypassed: + name: is_bypassed + in: query + description: A boolean value (`true` or `false`) indicating whether to filter + alerts by their push protection bypass status. When set to `true`, only alerts + that were created because a push protection rule was bypassed will be returned. + When set to `false`, only alerts that were not caused by a push protection + bypass will be returned. + required: false + schema: + type: boolean network-configuration-id: name: network_configuration_id description: Unique identifier of the hosted compute network configuration. @@ -250804,6 +253831,13 @@ components: required: true schema: type: integer + concurrency-group-name: + name: concurrency_group_name + description: The name of the concurrency group. + in: path + required: true + schema: + type: string job-id: name: job_id description: The unique identifier of the job. 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 bc80497d4..75ab4c2f2 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 @@ -2228,6 +2228,3174 @@ } } }, + "/agents/repos/{owner}/{repo}/tasks": { + "get": { + "summary": "List tasks for repository", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n\n**Fine-grained access tokens for \"List tasks for repository\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Start a task", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nStarts a new Copilot cloud agent task for a repository.\n\nThis endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription.\n\n**Fine-grained access tokens for \"Start a task\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read and write)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/create-task-in-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#start-a-task" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + } + ], + "requestBody": { + "required": true, + "description": "The task creation parameters, including the user's prompt and optional agent settings.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "prompt" + ], + "properties": { + "prompt": { + "type": "string", + "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`" + }, + "create_pull_request": { + "type": "boolean", + "description": "Whether to create a PR.", + "default": false + }, + "base_ref": { + "type": "string", + "description": "Base ref for new branch/PR" + } + } + }, + "examples": { + "default": { + "value": { + "prompt": "Fix the login button on the homepage", + "base_ref": "main" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Task created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "queued", + "session_count": 1, + "artifacts": [], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "400": { + "description": "Problems parsing JSON", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/repos/{owner}/{repo}/tasks/{task_id}": { + "get": { + "summary": "Get a task by repo", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n\n**Fine-grained access tokens for \"Get a task by repo\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-repo-and-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "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": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks": { + "get": { + "summary": "List tasks", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n\n**Fine-grained access tokens for \"List tasks\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks/{task_id}": { + "get": { + "summary": "Get a task by ID", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n\n**Fine-grained access tokens for \"Get a task by ID\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "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": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, "/app": { "get": { "summary": "Get the authenticated app", @@ -107407,7 +110575,7 @@ "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { "post": { "summary": "Set cluster deployment records", - "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.", + "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.\nNote: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments\narray resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use\nthe artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can\nonly have one name and version.", "tags": [ "orgs" ], @@ -107466,20 +110634,20 @@ "properties": { "name": { "type": "string", - "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", + "description": "The name of the artifact.", "minLength": 1, "maxLength": 256 }, "digest": { "type": "string", - "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", + "description": "The hex encoded digest of the artifact.", "minLength": 71, "maxLength": 71, "pattern": "^sha256:[a-f0-9]{64}$" }, "version": { "type": "string", - "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", + "description": "The artifact version.", "maxLength": 100, "x-multi-segment": true, "examples": [ @@ -195728,7 +198896,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -195813,6 +198982,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -195965,7 +199142,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -196056,7 +199233,7 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication.", "type": "string", "enum": [ "token", @@ -196064,7 +199241,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -196100,7 +199278,7 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { @@ -196118,6 +199296,14 @@ "api_host": { "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", "type": "string" + }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). Required when `auth_type` is `oidc_gcp`.", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).", + "type": "string" } }, "required": [ @@ -196176,6 +199362,17 @@ "service_slug": "my-service-account", "audience": "https://github.com/my-org" } + }, + "org-private-registry-with-oidc-gcp": { + "summary": "Example of an OIDC private registry configuration using Google Cloud Artifact Registry", + "value": { + "registry_type": "docker_registry", + "url": "https://us-docker.pkg.dev/my-project/my-repo", + "auth_type": "oidc_gcp", + "visibility": "all", + "workload_identity_provider": "projects/123456789/locations/global/workloadIdentityPools/github-pool/providers/github-provider", + "service_account": "dependabot@my-project.iam.gserviceaccount.com" + } } } } @@ -196227,7 +199424,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -196316,6 +199514,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -196655,7 +199861,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -196740,6 +199947,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -196808,7 +200023,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -196916,7 +200131,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -196952,7 +200168,7 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { @@ -196970,6 +200186,14 @@ "api_host": { "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", "type": "string" + }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). Required when `auth_type` is `oidc_gcp`.", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).", + "type": "string" } } }, @@ -245637,6 +248861,15 @@ "type": "boolean", "default": false } + }, + { + "name": "is_bypassed", + "in": "query", + "description": "A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -274712,25 +277945,547 @@ } }, { - "name": "cache_id", - "description": "The unique identifier of the GitHub Actions cache.", + "name": "cache_id", + "description": "The unique identifier of the GitHub Actions cache.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/concurrency_groups": { + "get": { + "summary": "List concurrency groups for a repository", + "description": "Lists the active concurrency groups for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-concurrency-groups-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Concurrency Group List", + "description": "A list of active concurrency groups for a repository.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "last_acquired_at" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "last_acquired_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "last_acquired_at": "2026-01-15T16:14:23Z" + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "last_acquired_at": "2026-01-15T16:13:55Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "concurrency-groups" + } + } + }, + "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}": { + "get": { + "summary": "Get a concurrency group for a repository", + "description": "Gets a specific concurrency group for a repository, including all instances in the group's queue.\nReturns 404 if the group is inactive or does not exist.\n\nOptionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items\nahead of the specified workflow run or job in the queue, plus the specified item itself\n(returned as the last element). This is useful for determining what is blocking a particular\nrun or job. Returns 422 if the specified run or job is not in this concurrency group.\n\nWhen using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow\nleases held on behalf of that run. Job-level leases within the run are not considered to\nblock the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow\nleases on the job's ancestor paths.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/get-concurrency-group-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "concurrency_group_name", + "description": "The name of the concurrency group.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "ahead_of_run", + "description": "Filter to items ahead of this workflow run ID in the queue, plus the run itself.\nMatches workflow-level concurrency and reusable-workflow leases held on behalf of\nthe run. Mutually exclusive with `ahead_of_job`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + }, + { + "name": "ahead_of_job", + "description": "Filter to items ahead of this job ID in the queue, plus the job itself.\nMatches job-level concurrency and reusable-workflow leases on the job's\nancestor paths. Mutually exclusive with `ahead_of_run`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 } } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Concurrency Group", + "description": "A concurrency group with the workflow runs and jobs that are either currently holding\nor waiting for the concurrency group lease.", + "type": "object", + "required": [ + "group_name", + "group_url", + "total_count", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "total_count": { + "type": "integer" + }, + "group_members": { + "type": "array", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "job_id": { + "type": "integer", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "total_count": 3, + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress" + }, + { + "run_id": 30433643, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433643", + "status": "pending" + }, + { + "run_id": 30433644, + "run_name": "Deploy hotfix", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644", + "job_id": 798245260, + "job_name": "deploy", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260", + "status": "pending" + } + ] + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "concurrency-groups" } } }, @@ -292096,99 +295851,386 @@ } }, { - "name": "attempt_number", - "description": "The attempt number of the workflow run.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "302": { - "description": "Response", - "headers": { - "Location": { - "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "workflow-runs" - } - } - }, - "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { - "post": { - "summary": "Cancel a workflow run", - "description": "Cancels a workflow run using its `id`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/cancel-workflow-run", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "attempt_number", + "description": "The attempt number of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + "post": { + "summary": "Cancel a workflow run", + "description": "Cancels a workflow run using its `id`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/cancel-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The unique identifier of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups": { + "get": { + "summary": "List concurrency groups for a workflow run", + "description": "Lists all concurrency groups associated with a workflow run or its jobs.\n\nThe set of groups is derived from the run's configuration, so a group is\nincluded even when the run no longer has any items currently holding or\nwaiting in it. In that case the `group_members` array will be empty.\n`total_count` reflects the number of groups the run participates in by\nconfiguration, not the number with active items.\n\nThis differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`,\nwhich returns 404 when a group has no active items. That endpoint reports\nthe live state of a group repo-wide, while this endpoint reports the\ngroups associated with a specific run by configuration.\n\nResults are sorted by group name and support cursor-based pagination via\n`before` and `after`. The `after` cursor paginates forward only and does\nnot emit a `rel=\"prev\"` Link; use `before` to page backward from a\nforward page's `next` cursor.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-concurrency-groups-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The unique identifier of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 } }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, "schema": { "type": "string" } }, { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "path", - "required": true, + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, "schema": { - "type": "integer" + "type": "string" } } ], "responses": { - "202": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", + "title": "Concurrency Group Run List", + "description": "A list of concurrency groups associated with a workflow run.", "type": "object", - "properties": {}, - "additionalProperties": false + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer", + "description": "The total number of concurrency groups this workflow run participates in,\nderived from the run's configuration. This count is not filtered by\nwhether the run currently holds or is waiting in each group, so it can\ninclude groups whose `group_members` array is empty (for example, when\nthe run has already released its lease in that group)." + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group. May return 404 if the group\nhas no active items at the time it is requested, since the\nget-by-name endpoint reports the live repo-wide state of a group\nwhile this endpoint lists groups associated with a run by\nconfiguration." + }, + "group_members": { + "type": "array", + "description": "Items belonging to this workflow run that are either currently holding or\nwaiting for the concurrency group lease. May be empty if the run no\nlonger has any active or queued items in this group.", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status", + "position", + "position_url" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "position": { + "type": "integer", + "description": "Queue position. 0 means the item holds the concurrency lease (in_progress), 1 or higher means queued (pending)." + }, + "position_url": { + "type": "string", + "format": "uri", + "description": "API URL to get items ahead of this item in the concurrency group." + }, + "job_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": [ + "string", + "null" + ], + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } }, "examples": { "default": { - "value": null + "value": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress", + "position": 0, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642" + } + ] + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "pending", + "position": 2, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260", + "job_id": 798245260, + "job_name": "build", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260" + } + ] + } + ] + } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, - "409": { - "description": "Conflict", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -292212,13 +296254,88 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "workflow-runs" + "subcategory": "concurrency-groups" } } }, @@ -631741,6 +635858,15 @@ "type": "boolean", "default": false } + }, + { + "name": "is_bypassed", + "in": "query", + "description": "A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index d8f4e05b8..db22f6695 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -1078,7 +1078,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &644 + - &645 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1168,6 +1168,2530 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories + "/agents/repos/{owner}/{repo}/tasks": + get: + summary: List tasks for repository + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for a specific repository + + **Fine-grained access tokens for "List tasks for repository"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/list-tasks-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, + `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived + tasks. When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + - name: creator_id + in: query + schema: + type: integer + description: Filter tasks by creator user ID + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="prev" (when current page > 1), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; + rel="next", ; + rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + post: + summary: Start a task + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Starts a new Copilot cloud agent task for a repository. + + This endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription. + + **Fine-grained access tokens for "Start a task"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read and write) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/create-task-in-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#start-a-task + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + requestBody: + required: true + description: The task creation parameters, including the user's prompt and + optional agent settings. + content: + application/json: + schema: + type: object + required: + - prompt + properties: + prompt: + type: string + 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`' + create_pull_request: + type: boolean + description: Whether to create a PR. + default: false + base_ref: + type: string + description: Base ref for new branch/PR + examples: + default: + value: + prompt: Fix the login button on the homepage + base_ref: main + responses: + '201': + description: Task created successfully + content: + application/json: + schema: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: queued + session_count: 1 + artifacts: [] + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '400': + description: Problems parsing JSON + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/repos/{owner}/{repo}/tasks/{task_id}": + get: + summary: Get a task by repo + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID scoped to an owner/repo path + + **Fine-grained access tokens for "Get a task by repo"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-repo-and-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + allOf: + - type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + 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: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/tasks": + get: + summary: List tasks + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for the authenticated user + + **Fine-grained access tokens for "List tasks"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/list-tasks + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, + `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived + tasks. When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; rel="next", + ; rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/tasks/{task_id}": + get: + summary: Get a task by ID + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID with its associated sessions + + **Fine-grained access tokens for "Get a task by ID"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + allOf: + - type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + 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: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation "/app": get: summary: Get the authenticated app @@ -11912,7 +14436,7 @@ paths: properties: action: type: string - discussion: &735 + discussion: &736 title: Discussion description: A Discussion in a repository. type: object @@ -12696,7 +15220,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &655 + sub_issues_summary: &656 title: Sub-issues Summary type: object properties: @@ -12807,7 +15331,7 @@ paths: - url - created_at - updated_at - issue_dependencies_summary: &656 + issue_dependencies_summary: &657 title: Issue Dependencies Summary type: object properties: @@ -14292,7 +16816,7 @@ paths: url: type: string format: uri - user: &662 + user: &663 title: Public User description: Public User type: object @@ -19651,7 +22175,7 @@ paths: required: false schema: type: string - - &712 + - &713 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -19797,7 +22321,7 @@ paths: parameters: - *74 - *116 - - &713 + - &714 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -19909,7 +22433,7 @@ paths: - *116 - *118 - *117 - - &714 + - &715 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -19917,7 +22441,7 @@ paths: schema: type: string - *119 - - &715 + - &716 name: sku description: The SKU to query for usage. in: query @@ -26264,6 +28788,10 @@ paths: If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. If no existing records match, new records will be created. + Note: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments + array resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use + the artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can + only have one name and version. tags: - orgs operationId: orgs/set-cluster-deployment-records @@ -26306,24 +28834,18 @@ paths: properties: name: type: string - description: | - The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name parameter must also be identical across all entries. + description: The name of the artifact. minLength: 1 maxLength: 256 digest: type: string - description: | - The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name and version parameters must also be identical across all entries. + description: The hex encoded digest of the artifact. minLength: 71 maxLength: 71 pattern: "^sha256:[a-f0-9]{64}$" version: type: string - description: | - The artifact version. Note that if multiple deployments have identical 'digest' parameter values, - the version parameter must also be identical across all entries. + description: The artifact version. maxLength: 100 x-multi-segment: true examples: @@ -26800,12 +29322,12 @@ paths: required: - subject_digests examples: - default: &693 + default: &694 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &694 + withPredicateType: &695 value: subject_digests: - sha256:abc123 @@ -26864,7 +29386,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &695 + default: &696 value: attestations_subject_digests: - sha256:abc: @@ -39469,7 +41991,7 @@ paths: parameters: - *74 - *248 - - &676 + - &677 name: repo_name description: repo_name parameter in: path @@ -40530,7 +43052,7 @@ paths: - nuget - container - *74 - - &677 + - &678 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -40571,7 +43093,7 @@ paths: default: *254 '403': *27 '401': *23 - '400': &679 + '400': &680 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -41797,6 +44319,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -41867,6 +44390,15 @@ paths: api_host: description: The Cloudsmith API host. type: string + workload_identity_provider: + description: The full resource name of the GCP Workload + Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + type: string + service_account: + description: The GCP service account email to impersonate. + If omitted, the federated token is used directly (direct + WIF). + type: string created_at: type: string format: date-time @@ -41904,7 +44436,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -41998,7 +44530,477 @@ paths: auth_type: description: The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, - or `oidc_cloudsmith` for OIDC authentication. + `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication. + type: string + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + - oidc_cloudsmith + - oidc_gcp + tenant_id: + description: The tenant ID of the Azure AD application. Required + when `auth_type` is `oidc_azure`. + type: string + client_id: + description: The client ID of the Azure AD application. Required + when `auth_type` is `oidc_azure`. + type: string + aws_region: + description: The AWS region. Required when `auth_type` is `oidc_aws`. + type: string + account_id: + description: The AWS account ID. Required when `auth_type` is `oidc_aws`. + type: string + role_name: + description: The AWS IAM role name. Required when `auth_type` is + `oidc_aws`. + type: string + domain: + description: The CodeArtifact domain. Required when `auth_type` + is `oidc_aws`. + type: string + domain_owner: + description: The CodeArtifact domain owner (AWS account ID). Required + when `auth_type` is `oidc_aws`. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. Required when `auth_type` + is `oidc_jfrog`. + type: string + audience: + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and `oidc_gcp`, and required for `oidc_cloudsmith` auth types. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. Optional for `oidc_jfrog` + auth type. + type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + Required when `auth_type` is `oidc_gcp`. + type: string + service_account: + description: The GCP service account email to impersonate. Optional + for `oidc_gcp` auth type. If omitted, the federated token is used + directly (direct WIF). + type: string + required: + - registry_type + - url + - visibility + examples: + org-private-registry-with-private-visibility: + summary: Example of a private registry configuration with private + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + replaces_base: true + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: private + org-private-registry-with-selected-visibility: + summary: Example of a private registry configuration with selected + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + org-private-registry-with-oidc-azure: + summary: Example of an OIDC private registry configuration using Azure + value: + registry_type: docker_registry + url: https://myregistry.azurecr.io + auth_type: oidc_azure + visibility: all + tenant_id: 12345678-1234-1234-1234-123456789012 + client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org + org-private-registry-with-oidc-gcp: + summary: Example of an OIDC private registry configuration using Google + Cloud Artifact Registry + value: + registry_type: docker_registry + url: https://us-docker.pkg.dev/my-project/my-repo + auth_type: oidc_gcp + visibility: all + workload_identity_provider: projects/123456789/locations/global/workloadIdentityPools/github-pool/providers/github-provider + service_account: dependabot@my-project.iam.gserviceaccount.com + responses: + '201': + description: The organization private registry configuration + content: + application/json: + schema: + title: Organization private registry + description: Private registry configuration for an organization + type: object + properties: + name: + description: The name of the private registry configuration. + type: string + examples: + - MAVEN_REPOSITORY_SECRET + registry_type: + description: The registry type. + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + type: string + auth_type: + description: The authentication type for the private registry. + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + - oidc_cloudsmith + - oidc_gcp + type: string + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the + private registry. + type: string + examples: + - monalisa + replaces_base: + description: Whether this private registry replaces the base registry + (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, + Dependabot will only use this registry and will not fall back + to the public registry. When `false` (default), Dependabot will + use this registry for scoped packages but may fall back to the + public registry for other packages. + type: boolean + default: false + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + enum: + - all + - private + - selected + type: string + selected_repository_ids: + type: array + description: An array of repository IDs that can access the organization + private registry when `visibility` is set to `selected`. + items: + type: integer + tenant_id: + description: The tenant ID of the Azure AD application. + type: string + client_id: + description: The client ID of the Azure AD application. + type: string + aws_region: + description: The AWS region. + type: string + account_id: + description: The AWS account ID. + type: string + role_name: + description: The AWS IAM role name. + type: string + domain: + description: The CodeArtifact domain. + type: string + domain_owner: + description: The CodeArtifact domain owner. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. + type: string + audience: + description: The OIDC audience. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. + type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + type: string + service_account: + description: The GCP service account email to impersonate. If + omitted, the federated token is used directly (direct WIF). + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - registry_type + - visibility + - created_at + - updated_at + examples: + org-private-registry-with-selected-visibility: &268 + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: private + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + org-private-registry-with-private-visibility: + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/public-key": + get: + summary: Get private registries public key for an organization + description: |2- + + Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization + parameters: + - *74 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - key_id + - key + properties: + key_id: + description: The identifier for the key. + type: string + examples: + - '012345678912345678' + key: + description: The Base64 encoded public key. + type: string + examples: + - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + examples: + default: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + headers: + Link: *66 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/{secret_name}": + get: + summary: Get a private registry for an organization + description: |2- + + Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization + parameters: + - *74 + - *161 + responses: + '200': + description: The specified private registry configuration for the organization + content: + application/json: + schema: *267 + examples: + default: *268 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + patch: + summary: Update a private registry for an organization + description: |2- + + Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/update-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization + parameters: + - *74 + - *161 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + registry_type: + description: The registry type. + type: string + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the private + registry. This field should be omitted if the private registry + does not require a username for authentication. + type: + - string + - 'null' + replaces_base: + description: Whether this private registry should replace the base + registry (e.g., npmjs.org for npm, rubygems.org for rubygems). + When set to `true`, Dependabot will only use this registry and + will not fall back to the public registry. When set to `false` + (default), Dependabot will use this registry for scoped packages + but may fall back to the public registry for other packages. + type: boolean + default: false + encrypted_value: + description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get private registries + public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + endpoint. + type: string + pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + key_id: + description: The ID of the key you used to encrypt the secret. + type: string + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + type: string + enum: + - all + - private + - selected + selected_repository_ids: + description: An array of repository IDs that can access the organization + private registry. You can only provide a list of repository IDs + when `visibility` is set to `selected`. This field should be omitted + if `visibility` is set to `all` or `private`. + type: array + items: + type: integer + auth_type: + description: The authentication type for the private registry. This + field cannot be changed after creation. If provided, it must match + the existing `auth_type` of the configuration. To change the authentication + type, delete and recreate the configuration. type: string enum: - token @@ -42007,6 +45009,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -42039,7 +45042,7 @@ paths: type: string audience: description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, - and required for `oidc_cloudsmith` auth types. + and `oidc_gcp`, and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` @@ -42057,445 +45060,15 @@ paths: description: The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default. type: string - required: - - registry_type - - url - - visibility - examples: - org-private-registry-with-private-visibility: - summary: Example of a private registry configuration with private - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - replaces_base: true - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: private - org-private-registry-with-selected-visibility: - summary: Example of a private registry configuration with selected - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - org-private-registry-with-oidc-azure: - summary: Example of an OIDC private registry configuration using Azure - value: - registry_type: docker_registry - url: https://myregistry.azurecr.io - auth_type: oidc_azure - visibility: all - tenant_id: 12345678-1234-1234-1234-123456789012 - client_id: abcdef01-2345-6789-abcd-ef0123456789 - org-private-registry-with-oidc-cloudsmith: - summary: Example of an OIDC private registry configuration using Cloudsmith - value: - registry_type: npm_registry - url: https://npm.cloudsmith.io/my-org/my-repo/ - auth_type: oidc_cloudsmith - visibility: all - namespace: my-org - service_slug: my-service-account - audience: https://github.com/my-org - responses: - '201': - description: The organization private registry configuration - content: - application/json: - schema: - title: Organization private registry - description: Private registry configuration for an organization - type: object - properties: - name: - description: The name of the private registry configuration. - type: string - examples: - - MAVEN_REPOSITORY_SECRET - registry_type: - description: The registry type. - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - type: string - auth_type: - description: The authentication type for the private registry. - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - - oidc_cloudsmith - type: string - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with the - private registry. - type: string - examples: - - monalisa - replaces_base: - description: Whether this private registry replaces the base registry - (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, - Dependabot will only use this registry and will not fall back - to the public registry. When `false` (default), Dependabot will - use this registry for scoped packages but may fall back to the - public registry for other packages. - type: boolean - default: false - visibility: - description: Which type of organization repositories have access - to the private registry. `selected` means only the repositories - specified by `selected_repository_ids` can access the private - registry. - enum: - - all - - private - - selected - type: string - selected_repository_ids: - type: array - description: An array of repository IDs that can access the organization - private registry when `visibility` is set to `selected`. - items: - type: integer - tenant_id: - description: The tenant ID of the Azure AD application. - type: string - client_id: - description: The client ID of the Azure AD application. - type: string - aws_region: - description: The AWS region. - type: string - account_id: - description: The AWS account ID. - type: string - role_name: - description: The AWS IAM role name. - type: string - domain: - description: The CodeArtifact domain. - type: string - domain_owner: - description: The CodeArtifact domain owner. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. - type: string - audience: - description: The OIDC audience. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. - type: string - namespace: - description: The Cloudsmith organization namespace. - type: string - service_slug: - description: The Cloudsmith service account slug. - type: string - api_host: - description: The Cloudsmith API host. - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - name - - registry_type - - visibility - - created_at - - updated_at - examples: - org-private-registry-with-selected-visibility: &268 - value: - name: MAVEN_REPOSITORY_SECRET - registry_type: maven_repository - username: monalisa - visibility: private - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - org-private-registry-with-private-visibility: - value: - name: MAVEN_REPOSITORY_SECRET - registry_type: maven_repository - username: monalisa - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/public-key": - get: - summary: Get private registries public key for an organization - description: |2- - - Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization - parameters: - - *74 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - key_id - - key - properties: - key_id: - description: The identifier for the key. - type: string - examples: - - '012345678912345678' - key: - description: The Base64 encoded public key. - type: string - examples: - - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - examples: - default: - value: - key_id: '012345678912345678' - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - headers: - Link: *66 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/{secret_name}": - get: - summary: Get a private registry for an organization - description: |2- - - Get the configuration of a single private registry defined for an organization, omitting its encrypted value. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization - parameters: - - *74 - - *161 - responses: - '200': - description: The specified private registry configuration for the organization - content: - application/json: - schema: *267 - examples: - default: *268 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - patch: - summary: Update a private registry for an organization - description: |2- - - Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/update-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization - parameters: - - *74 - - *161 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - registry_type: - description: The registry type. + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + Required when `auth_type` is `oidc_gcp`. type: string - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with the private - registry. This field should be omitted if the private registry - does not require a username for authentication. - type: - - string - - 'null' - replaces_base: - description: Whether this private registry should replace the base - registry (e.g., npmjs.org for npm, rubygems.org for rubygems). - When set to `true`, Dependabot will only use this registry and - will not fall back to the public registry. When set to `false` - (default), Dependabot will use this registry for scoped packages - but may fall back to the public registry for other packages. - type: boolean - default: false - encrypted_value: - description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get private registries - public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) - endpoint. - type: string - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - description: The ID of the key you used to encrypt the secret. - type: string - visibility: - description: Which type of organization repositories have access - to the private registry. `selected` means only the repositories - specified by `selected_repository_ids` can access the private - registry. - type: string - enum: - - all - - private - - selected - selected_repository_ids: - description: An array of repository IDs that can access the organization - private registry. You can only provide a list of repository IDs - when `visibility` is set to `selected`. This field should be omitted - if `visibility` is set to `all` or `private`. - type: array - items: - type: integer - auth_type: - description: The authentication type for the private registry. This - field cannot be changed after creation. If provided, it must match - the existing `auth_type` of the configuration. To change the authentication - type, delete and recreate the configuration. - type: string - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - - oidc_cloudsmith - tenant_id: - description: The tenant ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - client_id: - description: The client ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - aws_region: - description: The AWS region. Required when `auth_type` is `oidc_aws`. - type: string - account_id: - description: The AWS account ID. Required when `auth_type` is `oidc_aws`. - type: string - role_name: - description: The AWS IAM role name. Required when `auth_type` is - `oidc_aws`. - type: string - domain: - description: The CodeArtifact domain. Required when `auth_type` - is `oidc_aws`. - type: string - domain_owner: - description: The CodeArtifact domain owner (AWS account ID). Required - when `auth_type` is `oidc_aws`. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. Required when `auth_type` - is `oidc_jfrog`. - type: string - audience: - description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, - and required for `oidc_cloudsmith` auth types. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. Optional for `oidc_jfrog` - auth type. - type: string - namespace: - description: The Cloudsmith organization namespace. Required when - `auth_type` is `oidc_cloudsmith`. - type: string - service_slug: - description: The Cloudsmith service account slug. Required when - `auth_type` is `oidc_cloudsmith`. - type: string - api_host: - description: The Cloudsmith API host. Optional for `oidc_cloudsmith` - auth type. If omitted, `api.cloudsmith.io` is used by default. + service_account: + description: The GCP service account email to impersonate. Optional + for `oidc_gcp` auth type. If omitted, the federated token is used + directly (direct WIF). type: string examples: secret-based-update: @@ -42651,7 +45224,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &763 + - &764 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -43549,7 +46122,7 @@ paths: - updated_at - project_url examples: - default: &699 + default: &700 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -43726,7 +46299,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &700 + items: &701 type: object properties: name: @@ -43763,7 +46336,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &701 + iteration_configuration: &702 type: object description: The configuration for iteration fields. properties: @@ -43813,7 +46386,7 @@ paths: value: name: Due date data_type: date - single_select_field: &702 + single_select_field: &703 summary: Create a single select field value: name: Priority @@ -43840,7 +46413,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &703 + iteration_field: &704 summary: Create an iteration field value: name: Sprint @@ -43866,7 +46439,7 @@ paths: application/json: schema: *274 examples: - text_field: &704 + text_field: &705 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -43875,7 +46448,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &705 + number_field: &706 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -43884,7 +46457,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &706 + date_field: &707 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -43893,7 +46466,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &707 + single_select_field: &708 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -43927,7 +46500,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &708 + iteration_field: &709 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -43973,7 +46546,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *271 - - &709 + - &710 name: field_id description: The unique identifier of the field. in: path @@ -43988,7 +46561,7 @@ paths: application/json: schema: *274 examples: - default: &710 + default: &711 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -45199,7 +47772,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &690 + schema: &691 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -45382,7 +47955,7 @@ paths: parameters: - *271 - *74 - - &711 + - &712 name: view_number description: The number that identifies the project view. in: path @@ -49514,6 +52087,17 @@ paths: schema: type: boolean default: false + - &622 + name: is_bypassed + in: query + description: A boolean value (`true` or `false`) indicating whether to filter + alerts by their push protection bypass status. When set to `true`, only + alerts that were created because a push protection rule was bypassed will + be returned. When set to `false`, only alerts that were not caused by a + push protection bypass will be returned. + required: false + schema: + type: boolean responses: '200': description: Response @@ -49537,14 +52121,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &622 + state: &623 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &623 + resolution: &624 type: - string - 'null' @@ -49663,14 +52247,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &624 + - &625 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &626 + - &627 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -49734,7 +52318,7 @@ paths: - blob_url - commit_sha - commit_url - - &627 + - &628 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -49795,7 +52379,7 @@ paths: - page_url - commit_sha - commit_url - - &628 + - &629 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -49817,7 +52401,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &629 + - &630 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -49839,7 +52423,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &630 + - &631 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -49861,7 +52445,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &631 + - &632 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -49876,7 +52460,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &632 + - &633 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -49891,7 +52475,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &633 + - &634 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -49906,7 +52490,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &634 + - &635 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -49928,7 +52512,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &635 + - &636 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -49950,7 +52534,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &636 + - &637 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -49972,7 +52556,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &637 + - &638 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -49994,7 +52578,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &638 + - &639 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -50515,7 +53099,7 @@ paths: application/json: schema: type: array - items: &642 + items: &643 description: A repository security advisory. type: object properties: @@ -50834,7 +53418,7 @@ paths: - private_fork additionalProperties: false examples: - default: &643 + default: &644 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -52909,7 +55493,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &658 + response-if-user-is-a-team-maintainer: &659 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -52974,7 +55558,7 @@ paths: application/json: schema: *330 examples: - response-if-users-membership-with-team-is-now-pending: &659 + response-if-users-membership-with-team-is-now-pending: &660 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -53088,7 +55672,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &660 + schema: &661 title: Team Repository description: A team's access to a repository. type: object @@ -53817,7 +56401,7 @@ paths: type: array items: *191 examples: - response-if-child-teams-exist: &661 + response-if-child-teams-exist: &662 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -55677,6 +58261,245 @@ paths: enabledForGitHubApps: true category: actions subcategory: cache + "/repos/{owner}/{repo}/actions/concurrency_groups": + get: + summary: List concurrency groups for a repository + description: |- + Lists the active concurrency groups for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-concurrency-groups-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository + parameters: + - *331 + - *332 + - *17 + - *46 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Concurrency Group List + description: A list of active concurrency groups for a repository. + type: object + required: + - total_count + - concurrency_groups + properties: + total_count: + type: integer + concurrency_groups: + type: array + items: + type: object + required: + - group_name + - group_url + - last_acquired_at + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: API URL for this concurrency group. + last_acquired_at: + type: + - string + - 'null' + format: date-time + examples: + default: + value: + total_count: 2 + concurrency_groups: + - group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + last_acquired_at: '2026-01-15T16:14:23Z' + - group_name: ci-build + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build + last_acquired_at: '2026-01-15T16:13:55Z' + headers: + Link: *66 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups + "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}": + get: + summary: Get a concurrency group for a repository + description: |- + Gets a specific concurrency group for a repository, including all instances in the group's queue. + Returns 404 if the group is inactive or does not exist. + + Optionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items + ahead of the specified workflow run or job in the queue, plus the specified item itself + (returned as the last element). This is useful for determining what is blocking a particular + run or job. Returns 422 if the specified run or job is not in this concurrency group. + + When using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow + leases held on behalf of that run. Job-level leases within the run are not considered to + block the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow + leases on the job's ancestor paths. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-concurrency-group-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository + parameters: + - *331 + - *332 + - name: concurrency_group_name + description: The name of the concurrency group. + in: path + required: true + schema: + type: string + - name: ahead_of_run + description: |- + Filter to items ahead of this workflow run ID in the queue, plus the run itself. + Matches workflow-level concurrency and reusable-workflow leases held on behalf of + the run. Mutually exclusive with `ahead_of_job`. + in: query + required: false + schema: + type: integer + minimum: 1 + - name: ahead_of_job + description: |- + Filter to items ahead of this job ID in the queue, plus the job itself. + Matches job-level concurrency and reusable-workflow leases on the job's + ancestor paths. Mutually exclusive with `ahead_of_run`. + in: query + required: false + schema: + type: integer + minimum: 1 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Concurrency Group + description: |- + A concurrency group with the workflow runs and jobs that are either currently holding + or waiting for the concurrency group lease. + type: object + required: + - group_name + - group_url + - total_count + - group_members + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: API URL for this concurrency group. + total_count: + type: integer + group_members: + type: array + items: + type: object + required: + - run_id + - run_name + - run_url + - run_html_url + - status + properties: + run_id: + type: integer + description: The ID of the workflow run. + run_name: + type: string + description: The name of the workflow run. + run_url: + type: + - string + - 'null' + format: uri + description: API URL for the workflow run. + run_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the workflow run. + job_id: + type: integer + description: The ID of the job, when the item represents + a job-level or reusable-workflow-level lease. + job_name: + type: string + description: The display name of the job, when the item + represents a job-level or reusable-workflow-level lease. + job_url: + type: + - string + - 'null' + format: uri + description: API URL for the job. + job_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the job. + status: + type: string + enum: + - in_progress + - pending + examples: + default: + value: + group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + total_count: 3 + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: in_progress + - run_id: 30433643 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433643 + status: pending + - run_id: 30433644 + run_name: Deploy hotfix + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433644 + job_id: 798245260 + job_name: deploy + job_url: https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260 + job_html_url: https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260 + status: pending + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups "/repos/{owner}/{repo}/actions/jobs/{job_id}": get: summary: Get a job for a workflow run @@ -58730,6 +61553,198 @@ paths: enabledForGitHubApps: true category: actions subcategory: workflow-runs + "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups": + get: + summary: List concurrency groups for a workflow run + description: |- + Lists all concurrency groups associated with a workflow run or its jobs. + + The set of groups is derived from the run's configuration, so a group is + included even when the run no longer has any items currently holding or + waiting in it. In that case the `group_members` array will be empty. + `total_count` reflects the number of groups the run participates in by + configuration, not the number with active items. + + This differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`, + which returns 404 when a group has no active items. That endpoint reports + the live state of a group repo-wide, while this endpoint reports the + groups associated with a specific run by configuration. + + Results are sorted by group name and support cursor-based pagination via + `before` and `after`. The `after` cursor paginates forward only and does + not emit a `rel="prev"` Link; use `before` to page backward from a + forward page's `next` cursor. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-concurrency-groups-for-workflow-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run + parameters: + - *331 + - *332 + - *369 + - *17 + - *45 + - *46 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Concurrency Group Run List + description: A list of concurrency groups associated with a workflow + run. + type: object + required: + - total_count + - concurrency_groups + properties: + total_count: + type: integer + description: |- + The total number of concurrency groups this workflow run participates in, + derived from the run's configuration. This count is not filtered by + whether the run currently holds or is waiting in each group, so it can + include groups whose `group_members` array is empty (for example, when + the run has already released its lease in that group). + concurrency_groups: + type: array + items: + type: object + required: + - group_name + - group_url + - group_members + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: |- + API URL for this concurrency group. May return 404 if the group + has no active items at the time it is requested, since the + get-by-name endpoint reports the live repo-wide state of a group + while this endpoint lists groups associated with a run by + configuration. + group_members: + type: array + description: |- + Items belonging to this workflow run that are either currently holding or + waiting for the concurrency group lease. May be empty if the run no + longer has any active or queued items in this group. + items: + type: object + required: + - run_id + - run_name + - run_url + - run_html_url + - status + - position + - position_url + properties: + run_id: + type: integer + description: The ID of the workflow run. + run_name: + type: string + description: The name of the workflow run. + run_url: + type: + - string + - 'null' + format: uri + description: API URL for the workflow run. + run_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the workflow run. + position: + type: integer + description: Queue position. 0 means the item holds + the concurrency lease (in_progress), 1 or higher + means queued (pending). + position_url: + type: string + format: uri + description: API URL to get items ahead of this item + in the concurrency group. + job_id: + type: + - integer + - 'null' + description: The ID of the job, when the item represents + a job-level or reusable-workflow-level lease. + job_name: + type: + - string + - 'null' + description: The display name of the job, when the + item represents a job-level or reusable-workflow-level + lease. + job_url: + type: + - string + - 'null' + format: uri + description: API URL for the job. + job_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the job. + status: + type: string + enum: + - in_progress + - pending + examples: + default: + value: + total_count: 2 + concurrency_groups: + - group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: in_progress + position: 0 + position_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642 + - group_name: ci-build + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: pending + position: 2 + position_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260 + job_id: 798245260 + job_name: build + job_url: https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260 + job_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260 + headers: + Link: *66 + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": post: summary: Review custom deployment protection rules for a workflow run @@ -64999,7 +68014,7 @@ paths: check. type: array items: *85 - deployment: &724 + deployment: &725 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -70254,7 +73269,7 @@ paths: type: array items: *452 examples: - default: &667 + default: &668 value: total_count: 2 machines: @@ -73431,7 +76446,7 @@ paths: application/json: schema: type: array - items: &647 + items: &648 title: Status description: The status of a commit. type: object @@ -75057,7 +78072,7 @@ paths: items: type: object properties: - placeholder_id: &639 + placeholder_id: &640 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -81058,7 +84073,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &755 + last_response: &756 title: Hook Response type: object properties: @@ -82127,7 +85142,7 @@ paths: parameters: - *331 - *332 - - &688 + - &689 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -82561,7 +85576,7 @@ paths: type: array items: *528 examples: - default: &681 + default: &682 value: - id: 1 repository: @@ -96970,6 +99985,7 @@ paths: - *619 - *620 - *621 + - *622 responses: '200': description: Response @@ -96977,7 +99993,7 @@ paths: application/json: schema: type: array - items: &625 + items: &626 type: object properties: number: *171 @@ -96993,8 +100009,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *622 - resolution: *623 + state: *623 + resolution: *624 resolved_at: type: - string @@ -97100,7 +100116,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *624 + - *625 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -97268,7 +100284,7 @@ paths: description: Response content: application/json: - schema: *625 + schema: *626 examples: default: value: @@ -97332,8 +100348,8 @@ paths: schema: type: object properties: - state: *622 - resolution: *623 + state: *623 + resolution: *624 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -97381,7 +100397,7 @@ paths: description: Response content: application/json: - schema: *625 + schema: *626 examples: default: value: @@ -97490,7 +100506,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &775 + items: &776 type: object properties: type: @@ -97517,7 +100533,6 @@ paths: - commit details: oneOf: - - *626 - *627 - *628 - *629 @@ -97530,6 +100545,7 @@ paths: - *636 - *637 - *638 + - *639 examples: default: value: @@ -97624,14 +100640,14 @@ paths: schema: type: object properties: - reason: &640 + reason: &641 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *639 + placeholder_id: *640 required: - reason - placeholder_id @@ -97648,7 +100664,7 @@ paths: schema: type: object properties: - reason: *640 + reason: *641 expire_at: type: - string @@ -97711,7 +100727,7 @@ paths: properties: incremental_scans: type: array - items: &641 + items: &642 description: Information on a single scan performed by secret scanning on the repository type: object @@ -97739,15 +100755,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *641 + items: *642 backfill_scans: type: array - items: *641 + items: *642 custom_pattern_backfill_scans: type: array items: allOf: - - *641 + - *642 - type: object properties: pattern_name: @@ -97760,7 +100776,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *641 + items: *642 examples: default: value: @@ -97870,9 +100886,9 @@ paths: application/json: schema: type: array - items: *642 + items: *643 examples: - default: *643 + default: *644 '400': *14 '404': *6 x-github: @@ -98066,9 +101082,9 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: &645 + default: &646 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -98415,7 +101431,7 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: default: value: @@ -98564,15 +101580,15 @@ paths: parameters: - *331 - *332 - - *644 + - *645 responses: '200': description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: *645 + default: *646 '403': *27 '404': *6 x-github: @@ -98598,7 +101614,7 @@ paths: parameters: - *331 - *332 - - *644 + - *645 requestBody: required: true content: @@ -98769,10 +101785,10 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: *645 - add_credit: *645 + default: *646 + add_credit: *646 '403': *27 '404': *6 '422': @@ -98812,7 +101828,7 @@ paths: parameters: - *331 - *332 - - *644 + - *645 responses: '202': *37 '400': *14 @@ -98841,7 +101857,7 @@ paths: parameters: - *331 - *332 - - *644 + - *645 responses: '202': description: Response @@ -98982,7 +101998,7 @@ paths: application/json: schema: type: array - items: &646 + items: &647 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -99355,7 +102371,7 @@ paths: application/json: schema: type: array - items: *646 + items: *647 examples: default: value: @@ -99445,7 +102461,7 @@ paths: description: Response content: application/json: - schema: *647 + schema: *648 examples: default: value: @@ -99539,7 +102555,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &648 + schema: &649 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -99639,7 +102655,7 @@ paths: description: Response content: application/json: - schema: *648 + schema: *649 examples: default: value: @@ -99849,7 +102865,7 @@ paths: description: Response content: application/json: - schema: &649 + schema: &650 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -99861,7 +102877,7 @@ paths: required: - names examples: - default: &650 + default: &651 value: names: - octocat @@ -99916,9 +102932,9 @@ paths: description: Response content: application/json: - schema: *649 + schema: *650 examples: - default: *650 + default: *651 '404': *6 '422': *7 x-github: @@ -99941,7 +102957,7 @@ paths: parameters: - *331 - *332 - - &651 + - &652 name: per description: The time frame to display results for. in: query @@ -99972,7 +102988,7 @@ paths: - 128 clones: type: array - items: &652 + items: &653 title: Traffic type: object properties: @@ -100220,7 +103236,7 @@ paths: parameters: - *331 - *332 - - *651 + - *652 responses: '200': description: Response @@ -100241,7 +103257,7 @@ paths: - 3782 views: type: array - items: *652 + items: *653 required: - uniques - count @@ -101014,7 +104030,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &653 + text_matches: &654 title: Search Result Text Matches type: array items: @@ -101177,7 +104193,7 @@ paths: enum: - author-date - committer-date - - &654 + - &655 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -101297,7 +104313,7 @@ paths: type: number node_id: type: string - text_matches: *653 + text_matches: *654 required: - sha - node_id @@ -101489,7 +104505,7 @@ paths: - interactions - created - updated - - *654 + - *655 - *17 - *19 - name: advanced_search @@ -101603,8 +104619,8 @@ paths: type: - string - 'null' - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -101635,7 +104651,7 @@ paths: - string - 'null' format: date-time - text_matches: *653 + text_matches: *654 pull_request: type: object properties: @@ -101901,7 +104917,7 @@ paths: enum: - created - updated - - *654 + - *655 - *17 - *19 responses: @@ -101946,7 +104962,7 @@ paths: - 'null' score: type: number - text_matches: *653 + text_matches: *654 required: - id - node_id @@ -102031,7 +105047,7 @@ paths: - forks - help-wanted-issues - updated - - *654 + - *655 - *17 - *19 responses: @@ -102277,7 +105293,7 @@ paths: - admin - pull - push - text_matches: *653 + text_matches: *654 temp_clone_token: type: string allow_merge_commit: @@ -102585,7 +105601,7 @@ paths: - string - 'null' format: uri - text_matches: *653 + text_matches: *654 related: type: - array @@ -102778,7 +105794,7 @@ paths: - followers - repositories - joined - - *654 + - *655 - *17 - *19 responses: @@ -102888,7 +105904,7 @@ paths: type: - boolean - 'null' - text_matches: *653 + text_matches: *654 blog: type: - string @@ -102970,7 +105986,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &657 + - &658 name: team_id description: The unique identifier of the team. in: path @@ -103011,7 +106027,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *657 + - *658 requestBody: required: true content: @@ -103112,7 +106128,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *657 + - *658 responses: '204': description: Response @@ -103141,7 +106157,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *657 + - *658 - *17 - *19 responses: @@ -103179,7 +106195,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *657 + - *658 - name: role description: Filters members returned by their role in the team. in: query @@ -103230,7 +106246,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *657 + - *658 - *70 responses: '204': @@ -103267,7 +106283,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *657 + - *658 - *70 responses: '204': @@ -103307,7 +106323,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *657 + - *658 - *70 responses: '204': @@ -103344,7 +106360,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *657 + - *658 - *70 responses: '200': @@ -103353,7 +106369,7 @@ paths: application/json: schema: *330 examples: - response-if-user-is-a-team-maintainer: *658 + response-if-user-is-a-team-maintainer: *659 '404': *6 x-github: githubCloudOnly: false @@ -103386,7 +106402,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *657 + - *658 - *70 requestBody: required: false @@ -103414,7 +106430,7 @@ paths: application/json: schema: *330 examples: - response-if-users-membership-with-team-is-now-pending: *659 + response-if-users-membership-with-team-is-now-pending: *660 '403': description: Forbidden if team synchronization is set up '422': @@ -103448,7 +106464,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *657 + - *658 - *70 responses: '204': @@ -103476,7 +106492,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *657 + - *658 - *17 - *19 responses: @@ -103518,7 +106534,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *657 + - *658 - *331 - *332 responses: @@ -103526,7 +106542,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *660 + schema: *661 examples: alternative-response-with-extra-repository-information: value: @@ -103677,7 +106693,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *657 + - *658 - *331 - *332 requestBody: @@ -103729,7 +106745,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *657 + - *658 - *331 - *332 responses: @@ -103756,7 +106772,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *657 + - *658 - *17 - *19 responses: @@ -103768,7 +106784,7 @@ paths: type: array items: *191 examples: - response-if-child-teams-exist: *661 + response-if-child-teams-exist: *662 headers: Link: *66 '404': *6 @@ -103801,7 +106817,7 @@ paths: application/json: schema: oneOf: - - &663 + - &664 title: Private User description: Private User type: object @@ -104051,7 +107067,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *662 + - *663 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -104211,7 +107227,7 @@ paths: description: Response content: application/json: - schema: *663 + schema: *664 examples: default: value: @@ -104609,7 +107625,7 @@ paths: type: integer secrets: type: array - items: &664 + items: &665 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -104729,7 +107745,7 @@ paths: description: Response content: application/json: - schema: *664 + schema: *665 examples: default: value: @@ -105142,7 +108158,7 @@ paths: description: Response content: application/json: - schema: &665 + schema: &666 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -105195,7 +108211,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &666 + default: &667 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -105240,9 +108256,9 @@ paths: description: Response content: application/json: - schema: *665 + schema: *666 examples: - default: *666 + default: *667 '404': *6 x-github: githubCloudOnly: false @@ -105281,7 +108297,7 @@ paths: type: array items: *452 examples: - default: *667 + default: *668 '304': *35 '500': *53 '401': *23 @@ -106247,7 +109263,7 @@ paths: type: array items: *253 examples: - default: &678 + default: &679 value: - id: 197 name: hello_docker @@ -106348,7 +109364,7 @@ paths: application/json: schema: type: array - items: &668 + items: &669 title: Email description: Email type: object @@ -106418,9 +109434,9 @@ paths: application/json: schema: type: array - items: *668 + items: *669 examples: - default: &680 + default: &681 value: - email: octocat@github.com verified: true @@ -106497,7 +109513,7 @@ paths: application/json: schema: type: array - items: *668 + items: *669 examples: default: value: @@ -106755,7 +109771,7 @@ paths: application/json: schema: type: array - items: &669 + items: &670 title: GPG Key description: A unique encryption key type: object @@ -106900,7 +109916,7 @@ paths: - subkeys - revoked examples: - default: &697 + default: &698 value: - id: 3 name: Octocat's GPG Key @@ -106985,9 +110001,9 @@ paths: description: Response content: application/json: - schema: *669 + schema: *670 examples: - default: &670 + default: &671 value: id: 3 name: Octocat's GPG Key @@ -107044,7 +110060,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &671 + - &672 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -107056,9 +110072,9 @@ paths: description: Response content: application/json: - schema: *669 + schema: *670 examples: - default: *670 + default: *671 '404': *6 '304': *35 '403': *27 @@ -107081,7 +110097,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *671 + - *672 responses: '204': description: Response @@ -107539,7 +110555,7 @@ paths: application/json: schema: type: array - items: &672 + items: &673 title: Key description: Key type: object @@ -107642,9 +110658,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: &673 + default: &674 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -107683,9 +110699,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: *673 + default: *674 '404': *6 '304': *35 '403': *27 @@ -107741,7 +110757,7 @@ paths: application/json: schema: type: array - items: &674 + items: &675 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -107820,7 +110836,7 @@ paths: - account - plan examples: - default: &675 + default: &676 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -107882,9 +110898,9 @@ paths: application/json: schema: type: array - items: *674 + items: *675 examples: - default: *675 + default: *676 headers: Link: *66 '304': *35 @@ -108902,7 +111918,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *248 - - *676 + - *677 responses: '204': description: Response @@ -109017,7 +112033,7 @@ paths: - docker - nuget - container - - *677 + - *678 - *19 - *17 responses: @@ -109029,8 +112045,8 @@ paths: type: array items: *253 examples: - default: *678 - '400': *679 + default: *679 + '400': *680 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -109059,7 +112075,7 @@ paths: application/json: schema: *253 examples: - default: &698 + default: &699 value: id: 40201 name: octo-name @@ -109421,9 +112437,9 @@ paths: application/json: schema: type: array - items: *668 + items: *669 examples: - default: *680 + default: *681 headers: Link: *66 '304': *35 @@ -109536,7 +112552,7 @@ paths: type: array items: *78 examples: - default: &687 + default: &688 summary: Default response value: - id: 1296269 @@ -109896,7 +112912,7 @@ paths: type: array items: *528 examples: - default: *681 + default: *682 headers: Link: *66 '304': *35 @@ -109975,7 +112991,7 @@ paths: application/json: schema: type: array - items: &682 + items: &683 title: Social account description: Social media account type: object @@ -109992,7 +113008,7 @@ paths: - provider - url examples: - default: &683 + default: &684 value: - provider: twitter url: https://twitter.com/github @@ -110055,9 +113071,9 @@ paths: application/json: schema: type: array - items: *682 + items: *683 examples: - default: *683 + default: *684 '422': *15 '304': *35 '404': *6 @@ -110145,7 +113161,7 @@ paths: application/json: schema: type: array - items: &684 + items: &685 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -110165,7 +113181,7 @@ paths: - title - created_at examples: - default: &716 + default: &717 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -110230,9 +113246,9 @@ paths: description: Response content: application/json: - schema: *684 + schema: *685 examples: - default: &685 + default: &686 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -110262,7 +113278,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &686 + - &687 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -110274,9 +113290,9 @@ paths: description: Response content: application/json: - schema: *684 + schema: *685 examples: - default: *685 + default: *686 '404': *6 '304': *35 '403': *27 @@ -110299,7 +113315,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *686 + - *687 responses: '204': description: Response @@ -110328,7 +113344,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &717 + - &718 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -110353,11 +113369,11 @@ paths: type: array items: *78 examples: - default-response: *687 + default-response: *688 application/vnd.github.v3.star+json: schema: type: array - items: &718 + items: &719 title: Starred Repository description: Starred Repository type: object @@ -110726,10 +113742,10 @@ paths: application/json: schema: oneOf: + - *664 - *663 - - *662 examples: - default-response: &691 + default-response: &692 summary: Default response value: login: octocat @@ -110764,7 +113780,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &692 + response-with-git-hub-plan-information: &693 summary: Response with GitHub plan information value: login: octocat @@ -110821,7 +113837,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &689 + - &690 name: user_id description: The unique identifier of the user. in: path @@ -110887,7 +113903,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *688 + - *689 - *17 responses: '200': @@ -110922,7 +113938,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *689 + - *690 - *271 requestBody: required: true @@ -110997,7 +114013,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *690 + schema: *691 examples: table_view: summary: Response for creating a table view @@ -111049,11 +114065,11 @@ paths: application/json: schema: oneOf: + - *664 - *663 - - *662 examples: - default-response: *691 - response-with-git-hub-plan-information: *692 + default-response: *692 + response-with-git-hub-plan-information: *693 '404': *6 x-github: githubCloudOnly: false @@ -111103,8 +114119,8 @@ paths: required: - subject_digests examples: - default: *693 - withPredicateType: *694 + default: *694 + withPredicateType: *695 responses: '200': description: Response @@ -111158,7 +114174,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *695 + default: *696 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111647,7 +114663,7 @@ paths: application/json: schema: *187 examples: - default: &696 + default: &697 summary: Example response for a user copilot space value: id: 42 @@ -111748,7 +114764,7 @@ paths: application/json: schema: *187 examples: - default: *696 + default: *697 '403': *27 '404': *6 x-github: @@ -111874,7 +114890,7 @@ paths: application/json: schema: *187 examples: - default: *696 + default: *697 '403': *27 '404': *6 '422': *15 @@ -112642,7 +115658,7 @@ paths: type: array items: *253 examples: - default: *678 + default: *679 '403': *27 '401': *23 x-github: @@ -113026,9 +116042,9 @@ paths: application/json: schema: type: array - items: *669 + items: *670 examples: - default: *697 + default: *698 headers: Link: *66 x-github: @@ -113257,7 +116273,7 @@ paths: - docker - nuget - container - - *677 + - *678 - *70 - *19 - *17 @@ -113270,10 +116286,10 @@ paths: type: array items: *253 examples: - default: *678 + default: *679 '403': *27 '401': *23 - '400': *679 + '400': *680 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -113303,7 +116319,7 @@ paths: application/json: schema: *253 examples: - default: *698 + default: *699 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -113652,7 +116668,7 @@ paths: type: array items: *274 examples: - default: *699 + default: *700 headers: Link: *66 '304': *35 @@ -113712,7 +116728,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *700 + items: *701 required: - name - data_type @@ -113728,7 +116744,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *701 + iteration_configuration: *702 required: - name - data_type @@ -113750,8 +116766,8 @@ paths: value: name: Due date data_type: date - single_select_field: *702 - iteration_field: *703 + single_select_field: *703 + iteration_field: *704 responses: '201': description: Response @@ -113759,11 +116775,11 @@ paths: application/json: schema: *274 examples: - text_field: *704 - number_field: *705 - date_field: *706 - single_select_field: *707 - iteration_field: *708 + text_field: *705 + number_field: *706 + date_field: *707 + single_select_field: *708 + iteration_field: *709 '304': *35 '403': *27 '401': *23 @@ -113785,7 +116801,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *271 - - *709 + - *710 - *70 responses: '200': @@ -113794,7 +116810,7 @@ paths: application/json: schema: *274 examples: - default: *710 + default: *711 headers: Link: *66 '304': *35 @@ -114151,7 +117167,7 @@ paths: parameters: - *271 - *70 - - *711 + - *712 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -114426,7 +117442,7 @@ paths: - *116 - *118 - *117 - - *712 + - *713 - *119 responses: '200': @@ -114557,7 +117573,7 @@ paths: parameters: - *70 - *116 - - *713 + - *714 - *117 responses: '200': @@ -114656,9 +117672,9 @@ paths: - *116 - *118 - *117 - - *714 - - *119 - *715 + - *119 + - *716 responses: '200': description: Response when getting a billing usage summary @@ -114792,9 +117808,9 @@ paths: application/json: schema: type: array - items: *682 + items: *683 examples: - default: *683 + default: *684 headers: Link: *66 x-github: @@ -114824,9 +117840,9 @@ paths: application/json: schema: type: array - items: *684 + items: *685 examples: - default: *716 + default: *717 headers: Link: *66 x-github: @@ -114851,7 +117867,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *70 - - *717 + - *718 - *60 - *17 - *19 @@ -114863,11 +117879,11 @@ paths: schema: anyOf: - type: array - items: *718 + items: *719 - type: array items: *78 examples: - default-response: *687 + default-response: *688 headers: Link: *66 x-github: @@ -115027,7 +118043,7 @@ webhooks: type: string enum: - disabled - enterprise: &719 + enterprise: &720 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -115096,7 +118112,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &720 + installation: &721 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -115117,7 +118133,7 @@ webhooks: required: - id - node_id - organization: &721 + organization: &722 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -115190,7 +118206,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &722 + repository: &723 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -116116,10 +119132,10 @@ webhooks: type: string enum: - enabled - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -116195,11 +119211,11 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - rule: &723 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + rule: &724 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -116422,11 +119438,11 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - rule: *723 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + rule: *724 sender: *4 required: - action @@ -116614,11 +119630,11 @@ webhooks: - everyone required: - from - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - rule: *723 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + rule: *724 sender: *4 required: - action @@ -116702,7 +119718,7 @@ webhooks: type: string enum: - completed - check_run: &725 + check_run: &726 title: CheckRun description: A check performed on the code of a given code change type: object @@ -116812,7 +119828,7 @@ webhooks: - examples: - neutral - deployment: *724 + deployment: *725 details_url: type: string examples: @@ -116910,10 +119926,10 @@ webhooks: - output - app - pull_requests - installation: *720 - enterprise: *719 - organization: *721 - repository: *722 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 sender: *4 required: - check_run @@ -117304,11 +120320,11 @@ webhooks: type: string enum: - created - check_run: *725 - installation: *720 - enterprise: *719 - organization: *721 - repository: *722 + check_run: *726 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 sender: *4 required: - check_run @@ -117702,11 +120718,11 @@ webhooks: type: string enum: - requested_action - check_run: *725 - installation: *720 - enterprise: *719 - organization: *721 - repository: *722 + check_run: *726 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 requested_action: description: The action requested by the user. type: object @@ -118109,11 +121125,11 @@ webhooks: type: string enum: - rerequested - check_run: *725 - installation: *720 - enterprise: *719 - organization: *721 - repository: *722 + check_run: *726 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 sender: *4 required: - check_run @@ -119098,10 +122114,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -119805,10 +122821,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -120506,10 +123522,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -120830,20 +123846,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &726 + commit_oid: &727 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *719 - installation: *720 - organization: *721 - ref: &727 + enterprise: *720 + installation: *721 + organization: *722 + ref: &728 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *722 + repository: *723 sender: *4 required: - action @@ -121251,12 +124267,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *726 - enterprise: *719 - installation: *720 - organization: *721 - ref: *727 - repository: *722 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -121539,12 +124555,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *726 - enterprise: *719 - installation: *720 - organization: *721 - ref: *727 - repository: *722 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -121890,12 +124906,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *726 - enterprise: *719 - installation: *720 - organization: *721 - ref: *727 - repository: *722 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -122185,9 +125201,9 @@ webhooks: type: - string - 'null' - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -122195,7 +125211,7 @@ webhooks: type: - string - 'null' - repository: *722 + repository: *723 sender: *4 required: - action @@ -122441,12 +125457,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *726 - enterprise: *719 - installation: *720 - organization: *721 - ref: *727 - repository: *722 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -122767,10 +125783,10 @@ webhooks: - dismissed_reason - rule - tool - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -123030,10 +126046,10 @@ webhooks: - updated_at - author_association - body - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -123114,18 +126130,18 @@ webhooks: type: - string - 'null' - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *721 - pusher_type: &728 + organization: *722 + pusher_type: &729 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &729 + ref: &730 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -123135,7 +126151,7 @@ webhooks: enum: - tag - branch - repository: *722 + repository: *723 sender: *4 required: - ref @@ -123218,9 +126234,9 @@ webhooks: enum: - created definition: *282 - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -123305,9 +126321,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -123385,9 +126401,9 @@ webhooks: enum: - promote_to_enterprise definition: *282 - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -123465,9 +126481,9 @@ webhooks: enum: - updated definition: *282 - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -123544,10 +126560,10 @@ webhooks: type: string enum: - updated - enterprise: *719 - installation: *720 - repository: *722 - organization: *721 + enterprise: *720 + installation: *721 + repository: *723 + organization: *722 sender: *4 new_property_values: type: array @@ -123632,18 +126648,18 @@ webhooks: title: delete event type: object properties: - enterprise: *719 - installation: *720 - organization: *721 - pusher_type: *728 - ref: *729 + enterprise: *720 + installation: *721 + organization: *722 + pusher_type: *729 + ref: *730 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *722 + repository: *723 sender: *4 required: - ref @@ -123724,10 +126740,10 @@ webhooks: enum: - assignees_changed alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -123808,10 +126824,10 @@ webhooks: enum: - auto_dismissed alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -123893,10 +126909,10 @@ webhooks: enum: - auto_reopened alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -123978,10 +126994,10 @@ webhooks: enum: - created alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -124061,10 +127077,10 @@ webhooks: enum: - dismissed alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -124144,10 +127160,10 @@ webhooks: enum: - fixed alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -124228,10 +127244,10 @@ webhooks: enum: - reintroduced alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -124311,10 +127327,10 @@ webhooks: enum: - reopened alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -124391,9 +127407,9 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - key: &730 + enterprise: *720 + installation: *721 + key: &731 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -124431,8 +127447,8 @@ webhooks: - verified - created_at - read_only - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -124509,11 +127525,11 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - key: *730 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + key: *731 + organization: *722 + repository: *723 sender: *4 required: - action @@ -125080,12 +128096,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: &734 + workflow: &735 title: Workflow type: - object @@ -125840,9 +128856,9 @@ webhooks: pull_requests: type: array items: *575 - repository: *722 - organization: *721 - installation: *720 + repository: *723 + organization: *722 + installation: *721 sender: *4 responses: '200': @@ -125913,7 +128929,7 @@ webhooks: type: string enum: - approved - approver: &731 + approver: &732 type: object properties: avatar_url: @@ -125956,11 +128972,11 @@ webhooks: type: string comment: type: string - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - reviewers: &732 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + reviewers: &733 type: array items: type: object @@ -126041,7 +129057,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &733 + workflow_job_run: &734 type: object properties: conclusion: @@ -126787,18 +129803,18 @@ webhooks: type: string enum: - rejected - approver: *731 + approver: *732 comment: type: string - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - reviewers: *732 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + reviewers: *733 sender: *4 since: type: string - workflow_job_run: *733 + workflow_job_run: *734 workflow_job_runs: type: array items: @@ -127515,13 +130531,13 @@ webhooks: type: string enum: - requested - enterprise: *719 + enterprise: *720 environment: type: string - installation: *720 - organization: *721 - repository: *722 - requestor: &739 + installation: *721 + organization: *722 + repository: *723 + requestor: &740 title: User type: - object @@ -129454,12 +132470,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *734 + workflow: *735 workflow_run: title: Deployment Workflow Run type: @@ -130150,7 +133166,7 @@ webhooks: type: string enum: - answered - answer: &737 + answer: &738 type: object properties: author_association: @@ -130310,11 +133326,11 @@ webhooks: - created_at - updated_at - body - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -130441,11 +133457,11 @@ webhooks: - from required: - category - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -130528,11 +133544,11 @@ webhooks: type: string enum: - closed - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -130614,7 +133630,7 @@ webhooks: type: string enum: - created - comment: &736 + comment: &737 type: object properties: author_association: @@ -130774,11 +133790,11 @@ webhooks: - updated_at - body - reactions - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -130861,12 +133877,12 @@ webhooks: type: string enum: - deleted - comment: *736 - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + comment: *737 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -130961,12 +133977,12 @@ webhooks: - from required: - body - comment: *736 - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + comment: *737 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131050,11 +134066,11 @@ webhooks: type: string enum: - created - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131136,11 +134152,11 @@ webhooks: type: string enum: - deleted - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131240,11 +134256,11 @@ webhooks: type: string required: - from - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131326,10 +134342,10 @@ webhooks: type: string enum: - labeled - discussion: *735 - enterprise: *719 - installation: *720 - label: &738 + discussion: *736 + enterprise: *720 + installation: *721 + label: &739 title: Label type: object properties: @@ -131362,8 +134378,8 @@ webhooks: - color - default - description - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131446,11 +134462,11 @@ webhooks: type: string enum: - locked - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131532,11 +134548,11 @@ webhooks: type: string enum: - pinned - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131618,11 +134634,11 @@ webhooks: type: string enum: - reopened - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131707,16 +134723,16 @@ webhooks: changes: type: object properties: - new_discussion: *735 - new_repository: *722 + new_discussion: *736 + new_repository: *723 required: - new_discussion - new_repository - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131799,10 +134815,10 @@ webhooks: type: string enum: - unanswered - discussion: *735 - old_answer: *737 - organization: *721 - repository: *722 + discussion: *736 + old_answer: *738 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131884,12 +134900,12 @@ webhooks: type: string enum: - unlabeled - discussion: *735 - enterprise: *719 - installation: *720 - label: *738 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131972,11 +134988,11 @@ webhooks: type: string enum: - unlocked - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -132058,11 +135074,11 @@ webhooks: type: string enum: - unpinned - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -132135,7 +135151,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *719 + enterprise: *720 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -132813,9 +135829,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - forkee @@ -132961,9 +135977,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pages: description: The pages that were updated. type: array @@ -133001,7 +136017,7 @@ webhooks: - action - sha - html_url - repository: *722 + repository: *723 sender: *4 required: - pages @@ -133077,10 +136093,10 @@ webhooks: type: string enum: - created - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories: &740 + organization: *722 + repositories: &741 description: An array of repository objects that the installation can access. type: array @@ -133106,8 +136122,8 @@ webhooks: - name - full_name - private - repository: *722 - requester: *739 + repository: *723 + requester: *740 sender: *4 required: - action @@ -133182,11 +136198,11 @@ webhooks: type: string enum: - deleted - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories: *740 - repository: *722 + organization: *722 + repositories: *741 + repository: *723 requester: type: - 'null' @@ -133263,11 +136279,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories: *740 - repository: *722 + organization: *722 + repositories: *741 + repository: *723 requester: type: - 'null' @@ -133344,10 +136360,10 @@ webhooks: type: string enum: - added - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories_added: &741 + organization: *722 + repositories_added: &742 description: An array of repository objects, which were added to the installation. type: array @@ -133393,15 +136409,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *722 - repository_selection: &742 + repository: *723 + repository_selection: &743 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *739 + requester: *740 sender: *4 required: - action @@ -133480,10 +136496,10 @@ webhooks: type: string enum: - removed - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories_added: *741 + organization: *722 + repositories_added: *742 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -133510,9 +136526,9 @@ webhooks: - name - full_name - private - repository: *722 - repository_selection: *742 - requester: *739 + repository: *723 + repository_selection: *743 + requester: *740 sender: *4 required: - action @@ -133591,11 +136607,11 @@ webhooks: type: string enum: - suspend - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories: *740 - repository: *722 + organization: *722 + repositories: *741 + repository: *723 requester: type: - 'null' @@ -133777,10 +136793,10 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 target_type: type: string @@ -133859,11 +136875,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories: *740 - repository: *722 + organization: *722 + repositories: *741 + repository: *723 requester: type: - 'null' @@ -134115,8 +137131,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -134928,8 +137944,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135290,8 +138306,8 @@ webhooks: - state - locked - assignee - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -135371,7 +138387,7 @@ webhooks: type: string enum: - deleted - comment: &743 + comment: &744 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -135542,8 +138558,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -136351,8 +139367,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136715,8 +139731,8 @@ webhooks: - state - locked - assignee - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -136796,7 +139812,7 @@ webhooks: type: string enum: - edited - changes: &767 + changes: &768 description: The changes to the comment. type: object properties: @@ -136808,9 +139824,9 @@ webhooks: type: string required: - from - comment: *743 - enterprise: *719 - installation: *720 + comment: *744 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -137621,8 +140637,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137983,8 +140999,8 @@ webhooks: - state - locked - assignee - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -138065,9 +141081,9 @@ webhooks: type: string enum: - pinned - comment: *743 - enterprise: *719 - installation: *720 + comment: *744 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -138880,8 +141896,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139244,8 +142260,8 @@ webhooks: - state - locked - assignee - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -139325,9 +142341,9 @@ webhooks: type: string enum: - unpinned - comment: *743 - enterprise: *719 - installation: *720 + comment: *744 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -140140,8 +143156,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140504,8 +143520,8 @@ webhooks: - state - locked - assignee - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -140594,9 +143610,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -140685,9 +143701,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -140775,9 +143791,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -140866,9 +143882,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -140948,10 +143964,10 @@ webhooks: type: string enum: - assigned - assignee: *739 - enterprise: *719 - installation: *720 - issue: &744 + assignee: *740 + enterprise: *720 + installation: *721 + issue: &745 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -141762,8 +144778,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -141886,8 +144902,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -141967,8 +144983,8 @@ webhooks: type: string enum: - closed - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -142784,8 +145800,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -143051,8 +146067,8 @@ webhooks: required: - state - closed_at - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -143131,8 +146147,8 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -143939,8 +146955,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -144062,8 +147078,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -144142,8 +147158,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144973,8 +147989,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -145075,7 +148091,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &745 + milestone: &746 title: Milestone description: A collection of related issues and pull requests. type: object @@ -145218,8 +148234,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -145318,8 +148334,8 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -146130,8 +149146,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -146254,9 +149270,9 @@ webhooks: - active_lock_reason - body - reactions - label: *738 - organization: *721 - repository: *722 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -146336,9 +149352,9 @@ webhooks: type: string enum: - field_added - enterprise: *719 - installation: *720 - issue: *744 + enterprise: *720 + installation: *721 + issue: *745 issue_field: type: object description: The issue field whose value was set or updated on the @@ -146457,8 +149473,8 @@ webhooks: - id required: - from - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -146538,9 +149554,9 @@ webhooks: type: string enum: - field_removed - enterprise: *719 - installation: *720 - issue: *744 + enterprise: *720 + installation: *721 + issue: *745 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -146603,8 +149619,8 @@ webhooks: - 'null' required: - id - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -146684,8 +149700,8 @@ webhooks: type: string enum: - labeled - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147495,8 +150511,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -147619,9 +150635,9 @@ webhooks: - active_lock_reason - body - reactions - label: *738 - organization: *721 - repository: *722 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147701,8 +150717,8 @@ webhooks: type: string enum: - locked - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -148537,8 +151553,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -148638,8 +151654,8 @@ webhooks: format: uri user_view_type: type: string - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -148718,8 +151734,8 @@ webhooks: type: string enum: - milestoned - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -149548,8 +152564,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -149649,9 +152665,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *745 - organization: *721 - repository: *722 + milestone: *746 + organization: *722 + repository: *723 sender: *4 required: - action @@ -150538,8 +153554,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -151134,8 +154150,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -151942,8 +154958,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -152069,8 +155085,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -152150,9 +155166,9 @@ webhooks: type: string enum: - pinned - enterprise: *719 - installation: *720 - issue: &746 + enterprise: *720 + installation: *721 + issue: &747 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -152957,8 +155973,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -153080,8 +156096,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -153160,8 +156176,8 @@ webhooks: type: string enum: - reopened - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -153994,8 +157010,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -154096,8 +157112,8 @@ webhooks: user_view_type: type: string type: *236 - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -154985,8 +158001,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -155599,11 +158615,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *719 - installation: *720 - issue: *746 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + issue: *747 + organization: *722 + repository: *723 sender: *4 required: - action @@ -155683,12 +158699,12 @@ webhooks: type: string enum: - typed - enterprise: *719 - installation: *720 - issue: *744 + enterprise: *720 + installation: *721 + issue: *745 type: *236 - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -155769,7 +158785,7 @@ webhooks: type: string enum: - unassigned - assignee: &770 + assignee: &771 title: User type: - object @@ -155841,11 +158857,11 @@ webhooks: required: - login - id - enterprise: *719 - installation: *720 - issue: *744 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + issue: *745 + organization: *722 + repository: *723 sender: *4 required: - action @@ -155924,12 +158940,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *719 - installation: *720 - issue: *744 - label: *738 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + issue: *745 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -156009,8 +159025,8 @@ webhooks: type: string enum: - unlocked - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -156843,8 +159859,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -156944,8 +159960,8 @@ webhooks: format: uri user_view_type: type: string - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -157025,11 +160041,11 @@ webhooks: type: string enum: - unpinned - enterprise: *719 - installation: *720 - issue: *746 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + issue: *747 + organization: *722 + repository: *723 sender: *4 required: - action @@ -157108,12 +160124,12 @@ webhooks: type: string enum: - untyped - enterprise: *719 - installation: *720 - issue: *744 + enterprise: *720 + installation: *721 + issue: *745 type: *236 - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -157193,11 +160209,11 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - label: *738 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -157275,11 +160291,11 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - label: *738 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -157389,11 +160405,11 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - label: *738 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -157475,9 +160491,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *719 - installation: *720 - marketplace_purchase: &747 + enterprise: *720 + installation: *721 + marketplace_purchase: &748 title: Marketplace Purchase type: object required: @@ -157565,8 +160581,8 @@ webhooks: type: integer unit_count: type: integer - organization: *721 - previous_marketplace_purchase: &748 + organization: *722 + previous_marketplace_purchase: &749 title: Marketplace Purchase type: object properties: @@ -157650,7 +160666,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *722 + repository: *723 sender: *4 required: - action @@ -157730,10 +160746,10 @@ webhooks: - changed effective_date: type: string - enterprise: *719 - installation: *720 - marketplace_purchase: *747 - organization: *721 + enterprise: *720 + installation: *721 + marketplace_purchase: *748 + organization: *722 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -157821,7 +160837,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *722 + repository: *723 sender: *4 required: - action @@ -157903,10 +160919,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *719 - installation: *720 - marketplace_purchase: *747 - organization: *721 + enterprise: *720 + installation: *721 + marketplace_purchase: *748 + organization: *722 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -157992,7 +161008,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *722 + repository: *723 sender: *4 required: - action @@ -158073,8 +161089,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 marketplace_purchase: title: Marketplace Purchase type: object @@ -158160,9 +161176,9 @@ webhooks: type: integer unit_count: type: integer - organization: *721 - previous_marketplace_purchase: *748 - repository: *722 + organization: *722 + previous_marketplace_purchase: *749 + repository: *723 sender: *4 required: - action @@ -158242,12 +161258,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *719 - installation: *720 - marketplace_purchase: *747 - organization: *721 - previous_marketplace_purchase: *748 - repository: *722 + enterprise: *720 + installation: *721 + marketplace_purchase: *748 + organization: *722 + previous_marketplace_purchase: *749 + repository: *723 sender: *4 required: - action @@ -158349,11 +161365,11 @@ webhooks: type: string required: - to - enterprise: *719 - installation: *720 - member: *739 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 sender: *4 required: - action @@ -158455,11 +161471,11 @@ webhooks: type: - string - 'null' - enterprise: *719 - installation: *720 - member: *739 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 sender: *4 required: - action @@ -158538,11 +161554,11 @@ webhooks: type: string enum: - removed - enterprise: *719 - installation: *720 - member: *739 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 sender: *4 required: - action @@ -158620,11 +161636,11 @@ webhooks: type: string enum: - added - enterprise: *719 - installation: *720 - member: *739 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 scope: description: The scope of the membership. Currently, can only be `team`. @@ -158702,7 +161718,7 @@ webhooks: required: - login - id - team: &749 + team: &750 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -158932,11 +161948,11 @@ webhooks: type: string enum: - removed - enterprise: *719 - installation: *720 - member: *739 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 scope: description: The scope of the membership. Currently, can only be `team`. @@ -159015,7 +162031,7 @@ webhooks: required: - login - id - team: *749 + team: *750 required: - action - scope @@ -159097,8 +162113,8 @@ webhooks: type: string enum: - checks_requested - installation: *720 - merge_group: &750 + installation: *721 + merge_group: &751 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -159124,8 +162140,8 @@ webhooks: - base_sha - base_ref - head_commit - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -159211,10 +162227,10 @@ webhooks: - merged - invalidated - dequeued - installation: *720 - merge_group: *750 - organization: *721 - repository: *722 + installation: *721 + merge_group: *751 + organization: *722 + repository: *723 sender: *4 required: - action @@ -159287,7 +162303,7 @@ webhooks: type: string enum: - deleted - enterprise: *719 + enterprise: *720 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -159396,12 +162412,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *720 - organization: *721 + installation: *721 + organization: *722 repository: anyOf: - type: 'null' - - *722 + - *723 sender: *4 required: - action @@ -159481,11 +162497,11 @@ webhooks: type: string enum: - closed - enterprise: *719 - installation: *720 - milestone: *745 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + milestone: *746 + organization: *722 + repository: *723 sender: *4 required: - action @@ -159564,9 +162580,9 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - milestone: &751 + enterprise: *720 + installation: *721 + milestone: &752 title: Milestone description: A collection of related issues and pull requests. type: object @@ -159708,8 +162724,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -159788,11 +162804,11 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - milestone: *745 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + milestone: *746 + organization: *722 + repository: *723 sender: *4 required: - action @@ -159902,11 +162918,11 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - milestone: *745 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + milestone: *746 + organization: *722 + repository: *723 sender: *4 required: - action @@ -159986,11 +163002,11 @@ webhooks: type: string enum: - opened - enterprise: *719 - installation: *720 - milestone: *751 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + milestone: *752 + organization: *722 + repository: *723 sender: *4 required: - action @@ -160069,11 +163085,11 @@ webhooks: type: string enum: - blocked - blocked_user: *739 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + blocked_user: *740 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -160152,11 +163168,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *739 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + blocked_user: *740 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -160235,9 +163251,9 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - membership: &752 + enterprise: *720 + installation: *721 + membership: &753 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -160347,8 +163363,8 @@ webhooks: - role - organization_url - user - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -160426,11 +163442,11 @@ webhooks: type: string enum: - member_added - enterprise: *719 - installation: *720 - membership: *752 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + membership: *753 + organization: *722 + repository: *723 sender: *4 required: - action @@ -160509,8 +163525,8 @@ webhooks: type: string enum: - member_invited - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -160632,10 +163648,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 - user: *739 + user: *740 required: - action - invitation @@ -160713,11 +163729,11 @@ webhooks: type: string enum: - member_removed - enterprise: *719 - installation: *720 - membership: *752 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + membership: *753 + organization: *722 + repository: *723 sender: *4 required: - action @@ -160804,11 +163820,11 @@ webhooks: properties: from: type: string - enterprise: *719 - installation: *720 - membership: *752 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + membership: *753 + organization: *722 + repository: *723 sender: *4 required: - action @@ -160885,9 +163901,9 @@ webhooks: type: string enum: - published - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 package: description: Information about the package. type: object @@ -161410,7 +164426,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &753 + items: &754 title: Ruby Gems metadata type: object properties: @@ -161507,7 +164523,7 @@ webhooks: - owner - package_version - registry - repository: *722 + repository: *723 sender: *4 required: - action @@ -161583,9 +164599,9 @@ webhooks: type: string enum: - updated - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 package: description: Information about the package. type: object @@ -161947,7 +164963,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *753 + items: *754 source_url: type: string format: uri @@ -162018,7 +165034,7 @@ webhooks: - owner - package_version - registry - repository: *722 + repository: *723 sender: *4 required: - action @@ -162198,12 +165214,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *719 + enterprise: *720 id: type: integer - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - id @@ -162280,7 +165296,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &754 + personal_access_token_request: &755 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -162430,10 +165446,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *719 - organization: *721 + enterprise: *720 + organization: *722 sender: *4 - installation: *720 + installation: *721 required: - action - personal_access_token_request @@ -162510,11 +165526,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *754 - enterprise: *719 - organization: *721 + personal_access_token_request: *755 + enterprise: *720 + organization: *722 sender: *4 - installation: *720 + installation: *721 required: - action - personal_access_token_request @@ -162590,11 +165606,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *754 - enterprise: *719 - organization: *721 + personal_access_token_request: *755 + enterprise: *720 + organization: *722 sender: *4 - installation: *720 + installation: *721 required: - action - personal_access_token_request @@ -162669,11 +165685,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *754 - organization: *721 - enterprise: *719 + personal_access_token_request: *755 + organization: *722 + enterprise: *720 sender: *4 - installation: *720 + installation: *721 required: - action - personal_access_token_request @@ -162778,7 +165794,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *755 + last_response: *756 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -162810,8 +165826,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 zen: description: Random string of GitHub zen. @@ -163056,10 +166072,10 @@ webhooks: - from required: - note - enterprise: *719 - installation: *720 - organization: *721 - project_card: &756 + enterprise: *720 + installation: *721 + organization: *722 + project_card: &757 title: Project Card type: object properties: @@ -163182,7 +166198,7 @@ webhooks: - creator - created_at - updated_at - repository: *722 + repository: *723 sender: *4 required: - action @@ -163263,11 +166279,11 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - project_card: *756 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project_card: *757 + repository: *723 sender: *4 required: - action @@ -163347,9 +166363,9 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 project_card: title: Project Card type: object @@ -163479,7 +166495,7 @@ webhooks: repository: anyOf: - type: 'null' - - *722 + - *723 sender: *4 required: - action @@ -163573,11 +166589,11 @@ webhooks: - from required: - note - enterprise: *719 - installation: *720 - organization: *721 - project_card: *756 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project_card: *757 + repository: *723 sender: *4 required: - action @@ -163671,9 +166687,9 @@ webhooks: - from required: - column_id - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 project_card: allOf: - title: Project Card @@ -163870,7 +166886,7 @@ webhooks: type: string required: - after_id - repository: *722 + repository: *723 sender: *4 required: - action @@ -163950,10 +166966,10 @@ webhooks: type: string enum: - closed - enterprise: *719 - installation: *720 - organization: *721 - project: &758 + enterprise: *720 + installation: *721 + organization: *722 + project: &759 title: Project type: object properties: @@ -164080,7 +167096,7 @@ webhooks: - creator - created_at - updated_at - repository: *722 + repository: *723 sender: *4 required: - action @@ -164160,10 +167176,10 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - project_column: &757 + enterprise: *720 + installation: *721 + organization: *722 + project_column: &758 title: Project Column type: object properties: @@ -164203,7 +167219,7 @@ webhooks: - name - created_at - updated_at - repository: *722 + repository: *723 sender: *4 required: - action @@ -164282,14 +167298,14 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - project_column: *757 + enterprise: *720 + installation: *721 + organization: *722 + project_column: *758 repository: anyOf: - type: 'null' - - *722 + - *723 sender: *4 required: - action @@ -164378,11 +167394,11 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - organization: *721 - project_column: *757 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project_column: *758 + repository: *723 sender: *4 required: - action @@ -164462,11 +167478,11 @@ webhooks: type: string enum: - moved - enterprise: *719 - installation: *720 - organization: *721 - project_column: *757 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project_column: *758 + repository: *723 sender: *4 required: - action @@ -164546,11 +167562,11 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - project: *758 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project: *759 + repository: *723 sender: *4 required: - action @@ -164630,14 +167646,14 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - project: *758 + enterprise: *720 + installation: *721 + organization: *722 + project: *759 repository: anyOf: - type: 'null' - - *722 + - *723 sender: *4 required: - action @@ -164738,11 +167754,11 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - organization: *721 - project: *758 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project: *759 + repository: *723 sender: *4 required: - action @@ -164821,11 +167837,11 @@ webhooks: type: string enum: - reopened - enterprise: *719 - installation: *720 - organization: *721 - project: *758 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project: *759 + repository: *723 sender: *4 required: - action @@ -164906,8 +167922,8 @@ webhooks: type: string enum: - closed - installation: *720 - organization: *721 + installation: *721 + organization: *722 projects_v2: *269 sender: *4 required: @@ -164989,8 +168005,8 @@ webhooks: type: string enum: - created - installation: *720 - organization: *721 + installation: *721 + organization: *722 projects_v2: *269 sender: *4 required: @@ -165072,8 +168088,8 @@ webhooks: type: string enum: - deleted - installation: *720 - organization: *721 + installation: *721 + organization: *722 projects_v2: *269 sender: *4 required: @@ -165195,8 +168211,8 @@ webhooks: type: string to: type: string - installation: *720 - organization: *721 + installation: *721 + organization: *722 projects_v2: *269 sender: *4 required: @@ -165280,7 +168296,7 @@ webhooks: type: string enum: - archived - changes: &762 + changes: &763 type: object properties: archived_at: @@ -165296,9 +168312,9 @@ webhooks: - string - 'null' format: date-time - installation: *720 - organization: *721 - projects_v2_item: &759 + installation: *721 + organization: *722 + projects_v2_item: &760 title: Projects v2 Item description: An item belonging to a project type: object @@ -165438,9 +168454,9 @@ webhooks: - 'null' to: type: string - installation: *720 - organization: *721 - projects_v2_item: *759 + installation: *721 + organization: *722 + projects_v2_item: *760 sender: *4 required: - action @@ -165522,9 +168538,9 @@ webhooks: type: string enum: - created - installation: *720 - organization: *721 - projects_v2_item: *759 + installation: *721 + organization: *722 + projects_v2_item: *760 sender: *4 required: - action @@ -165605,9 +168621,9 @@ webhooks: type: string enum: - deleted - installation: *720 - organization: *721 - projects_v2_item: *759 + installation: *721 + organization: *722 + projects_v2_item: *760 sender: *4 required: - action @@ -165712,7 +168728,7 @@ webhooks: oneOf: - type: string - type: integer - - &760 + - &761 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -165736,7 +168752,7 @@ webhooks: required: - id - name - - &761 + - &762 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -165776,8 +168792,8 @@ webhooks: oneOf: - type: string - type: integer - - *760 - *761 + - *762 type: - 'null' - string @@ -165800,9 +168816,9 @@ webhooks: - 'null' required: - body - installation: *720 - organization: *721 - projects_v2_item: *759 + installation: *721 + organization: *722 + projects_v2_item: *760 sender: *4 required: - action @@ -165899,9 +168915,9 @@ webhooks: type: - string - 'null' - installation: *720 - organization: *721 - projects_v2_item: *759 + installation: *721 + organization: *722 + projects_v2_item: *760 sender: *4 required: - action @@ -165984,10 +169000,10 @@ webhooks: type: string enum: - restored - changes: *762 - installation: *720 - organization: *721 - projects_v2_item: *759 + changes: *763 + installation: *721 + organization: *722 + projects_v2_item: *760 sender: *4 required: - action @@ -166069,8 +169085,8 @@ webhooks: type: string enum: - reopened - installation: *720 - organization: *721 + installation: *721 + organization: *722 projects_v2: *269 sender: *4 required: @@ -166152,9 +169168,9 @@ webhooks: type: string enum: - created - installation: *720 - organization: *721 - projects_v2_status_update: *763 + installation: *721 + organization: *722 + projects_v2_status_update: *764 sender: *4 required: - action @@ -166235,9 +169251,9 @@ webhooks: type: string enum: - deleted - installation: *720 - organization: *721 - projects_v2_status_update: *763 + installation: *721 + organization: *722 + projects_v2_status_update: *764 sender: *4 required: - action @@ -166383,9 +169399,9 @@ webhooks: - string - 'null' format: date - installation: *720 - organization: *721 - projects_v2_status_update: *763 + installation: *721 + organization: *722 + projects_v2_status_update: *764 sender: *4 required: - action @@ -166456,10 +169472,10 @@ webhooks: title: public event type: object properties: - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - repository @@ -166536,13 +169552,13 @@ webhooks: type: string enum: - assigned - assignee: *739 - enterprise: *719 - installation: *720 - number: &764 + assignee: *740 + enterprise: *720 + installation: *721 + number: &765 description: The pull request number. type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -168913,7 +171929,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -168995,11 +172011,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -171363,7 +174379,7 @@ webhooks: - draft reason: type: string - repository: *722 + repository: *723 sender: *4 required: - action @@ -171445,11 +174461,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -173813,7 +176829,7 @@ webhooks: - draft reason: type: string - repository: *722 + repository: *723 sender: *4 required: - action @@ -173895,11 +176911,11 @@ webhooks: type: string enum: - closed - enterprise: *719 - installation: *720 - number: *764 - organization: *721 - pull_request: &765 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 + pull_request: &766 allOf: - *575 - type: object @@ -173963,7 +176979,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *722 + repository: *723 sender: *4 required: - action @@ -174044,12 +177060,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *719 - installation: *720 - number: *764 - organization: *721 - pull_request: *765 - repository: *722 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 + pull_request: *766 + repository: *723 sender: *4 required: - action @@ -174129,11 +177145,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *719 + enterprise: *720 milestone: *272 - number: *764 - organization: *721 - pull_request: &766 + number: *765 + organization: *722 + pull_request: &767 title: Pull Request type: object properties: @@ -176482,7 +179498,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -176561,11 +179577,11 @@ webhooks: type: string enum: - dequeued - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -178933,7 +181949,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *722 + repository: *723 sender: *4 required: - action @@ -179057,12 +182073,12 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - number: *764 - organization: *721 - pull_request: *765 - repository: *722 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 + pull_request: *766 + repository: *723 sender: *4 required: - action @@ -179142,11 +182158,11 @@ webhooks: type: string enum: - enqueued - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -181499,7 +184515,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -181579,11 +184595,11 @@ webhooks: type: string enum: - labeled - enterprise: *719 - installation: *720 - label: *738 - number: *764 - organization: *721 + enterprise: *720 + installation: *721 + label: *739 + number: *765 + organization: *722 pull_request: title: Pull Request type: object @@ -183953,7 +186969,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -184034,10 +187050,10 @@ webhooks: type: string enum: - locked - enterprise: *719 - installation: *720 - number: *764 - organization: *721 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 pull_request: title: Pull Request type: object @@ -186405,7 +189421,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -186485,12 +189501,12 @@ webhooks: type: string enum: - milestoned - enterprise: *719 + enterprise: *720 milestone: *272 - number: *764 - organization: *721 - pull_request: *766 - repository: *722 + number: *765 + organization: *722 + pull_request: *767 + repository: *723 sender: *4 required: - action @@ -186569,12 +189585,12 @@ webhooks: type: string enum: - opened - enterprise: *719 - installation: *720 - number: *764 - organization: *721 - pull_request: *765 - repository: *722 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 + pull_request: *766 + repository: *723 sender: *4 required: - action @@ -186655,12 +189671,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *719 - installation: *720 - number: *764 - organization: *721 - pull_request: *765 - repository: *722 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 + pull_request: *766 + repository: *723 sender: *4 required: - action @@ -186740,12 +189756,12 @@ webhooks: type: string enum: - reopened - enterprise: *719 - installation: *720 - number: *764 - organization: *721 - pull_request: *765 - repository: *722 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 + pull_request: *766 + repository: *723 sender: *4 required: - action @@ -187120,9 +190136,9 @@ webhooks: - start_side - side - reactions - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: type: object properties: @@ -189374,7 +192390,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *722 + repository: *723 sender: *4 required: - action @@ -189454,7 +192470,7 @@ webhooks: type: string enum: - deleted - comment: &768 + comment: &769 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -189747,9 +192763,9 @@ webhooks: - start_side - side - reactions - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: type: object properties: @@ -191989,7 +195005,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *722 + repository: *723 sender: *4 required: - action @@ -192069,11 +195085,11 @@ webhooks: type: string enum: - edited - changes: *767 - comment: *768 - enterprise: *719 - installation: *720 - organization: *721 + changes: *768 + comment: *769 + enterprise: *720 + installation: *721 + organization: *722 pull_request: type: object properties: @@ -194316,7 +197332,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *722 + repository: *723 sender: *4 required: - action @@ -194397,9 +197413,9 @@ webhooks: type: string enum: - dismissed - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -196654,7 +199670,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *722 + repository: *723 review: description: The review that was affected. type: object @@ -196905,9 +199921,9 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -199021,8 +202037,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *722 - review: &769 + repository: *723 + review: &770 description: The review that was affected. type: object properties: @@ -199260,12 +202276,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -201634,7 +204650,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 requested_reviewer: title: User type: @@ -201720,12 +204736,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -204101,7 +207117,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 requested_team: title: Team description: Groups of organization members that gives permissions @@ -204296,12 +207312,12 @@ webhooks: type: string enum: - review_requested - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -206672,7 +209688,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 requested_reviewer: title: User type: @@ -206759,12 +209775,12 @@ webhooks: type: string enum: - review_requested - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -209126,7 +212142,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 requested_team: title: Team description: Groups of organization members that gives permissions @@ -209310,9 +212326,9 @@ webhooks: type: string enum: - submitted - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -211570,8 +214586,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *722 - review: *769 + repository: *723 + review: *770 sender: *4 required: - action @@ -211651,9 +214667,9 @@ webhooks: type: string enum: - resolved - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -213806,7 +216822,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *722 + repository: *723 sender: *4 thread: type: object @@ -214203,9 +217219,9 @@ webhooks: type: string enum: - unresolved - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -216341,7 +219357,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *722 + repository: *723 sender: *4 thread: type: object @@ -216740,10 +219756,10 @@ webhooks: type: string before: type: string - enterprise: *719 - installation: *720 - number: *764 - organization: *721 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 pull_request: title: Pull Request type: object @@ -219100,7 +222116,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -219182,11 +222198,11 @@ webhooks: type: string enum: - unassigned - assignee: *770 - enterprise: *719 - installation: *720 - number: *764 - organization: *721 + assignee: *771 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 pull_request: title: Pull Request type: object @@ -221558,7 +224574,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -221637,11 +224653,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *719 - installation: *720 - label: *738 - number: *764 - organization: *721 + enterprise: *720 + installation: *721 + label: *739 + number: *765 + organization: *722 pull_request: title: Pull Request type: object @@ -224002,7 +227018,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -224083,10 +227099,10 @@ webhooks: type: string enum: - unlocked - enterprise: *719 - installation: *720 - number: *764 - organization: *721 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 pull_request: title: Pull Request type: object @@ -226437,7 +229453,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -226640,7 +229656,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *719 + enterprise: *720 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -226735,8 +229751,8 @@ webhooks: - url - author - committer - installation: *720 - organization: *721 + installation: *721 + organization: *722 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -227335,9 +230351,9 @@ webhooks: type: string enum: - published - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 registry_package: type: object properties: @@ -227814,7 +230830,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *753 + items: *754 summary: type: string tag_name: @@ -227870,7 +230886,7 @@ webhooks: - owner - package_version - registry - repository: *722 + repository: *723 sender: *4 required: - action @@ -227948,9 +230964,9 @@ webhooks: type: string enum: - updated - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 registry_package: type: object properties: @@ -228262,7 +231278,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *753 + items: *754 summary: type: string tag_name: @@ -228312,7 +231328,7 @@ webhooks: - owner - package_version - registry - repository: *722 + repository: *723 sender: *4 required: - action @@ -228389,10 +231405,10 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - release: &771 + enterprise: *720 + installation: *721 + organization: *722 + release: &772 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -228723,7 +231739,7 @@ webhooks: - updated_at - zipball_url - body - repository: *722 + repository: *723 sender: *4 required: - action @@ -228800,11 +231816,11 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - release: *771 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + release: *772 + repository: *723 sender: *4 required: - action @@ -228921,11 +231937,11 @@ webhooks: type: boolean required: - to - enterprise: *719 - installation: *720 - organization: *721 - release: *771 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + release: *772 + repository: *723 sender: *4 required: - action @@ -229003,9 +232019,9 @@ webhooks: type: string enum: - prereleased - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -229341,7 +232357,7 @@ webhooks: - string - 'null' format: uri - repository: *722 + repository: *723 sender: *4 required: - action @@ -229417,10 +232433,10 @@ webhooks: type: string enum: - published - enterprise: *719 - installation: *720 - organization: *721 - release: &772 + enterprise: *720 + installation: *721 + organization: *722 + release: &773 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -229753,7 +232769,7 @@ webhooks: - string - 'null' format: uri - repository: *722 + repository: *723 sender: *4 required: - action @@ -229829,11 +232845,11 @@ webhooks: type: string enum: - released - enterprise: *719 - installation: *720 - organization: *721 - release: *771 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + release: *772 + repository: *723 sender: *4 required: - action @@ -229909,11 +232925,11 @@ webhooks: type: string enum: - unpublished - enterprise: *719 - installation: *720 - organization: *721 - release: *772 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + release: *773 + repository: *723 sender: *4 required: - action @@ -229989,11 +233005,11 @@ webhooks: type: string enum: - published - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - repository_advisory: *642 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + repository_advisory: *643 sender: *4 required: - action @@ -230069,11 +233085,11 @@ webhooks: type: string enum: - reported - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - repository_advisory: *642 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + repository_advisory: *643 sender: *4 required: - action @@ -230149,10 +233165,10 @@ webhooks: type: string enum: - archived - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -230229,10 +233245,10 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -230310,10 +233326,10 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -230398,10 +233414,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -230516,10 +233532,10 @@ webhooks: - 'null' items: type: string - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -230591,10 +233607,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 status: type: string @@ -230675,10 +233691,10 @@ webhooks: type: string enum: - privatized - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -230755,10 +233771,10 @@ webhooks: type: string enum: - publicized - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -230852,10 +233868,10 @@ webhooks: - name required: - repository - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -230935,10 +233951,10 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 repository_ruleset: *314 sender: *4 required: @@ -231017,10 +234033,10 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 repository_ruleset: *314 sender: *4 required: @@ -231099,10 +234115,10 @@ webhooks: type: string enum: - edited - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 repository_ruleset: *314 changes: type: object @@ -231410,10 +234426,10 @@ webhooks: - from required: - owner - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -231491,10 +234507,10 @@ webhooks: type: string enum: - unarchived - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -231572,7 +234588,7 @@ webhooks: type: string enum: - create - alert: &773 + alert: &774 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -231697,10 +234713,10 @@ webhooks: enum: - auto_dismissed - open - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -231910,10 +234926,10 @@ webhooks: type: string enum: - dismissed - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -231991,11 +235007,11 @@ webhooks: type: string enum: - reopen - alert: *773 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + alert: *774 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -232197,10 +235213,10 @@ webhooks: enum: - fixed - open - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -232278,7 +235294,7 @@ webhooks: type: string enum: - assigned - alert: &774 + alert: &775 type: object properties: number: *171 @@ -232418,10 +235434,10 @@ webhooks: - type: 'null' - *4 assignee: *4 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -232499,11 +235515,11 @@ webhooks: type: string enum: - created - alert: *774 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + alert: *775 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -232584,11 +235600,11 @@ webhooks: type: string enum: - created - alert: *774 - installation: *720 - location: *775 - organization: *721 - repository: *722 + alert: *775 + installation: *721 + location: *776 + organization: *722 + repository: *723 sender: *4 required: - location @@ -232826,11 +235842,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *774 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + alert: *775 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -232908,11 +235924,11 @@ webhooks: type: string enum: - reopened - alert: *774 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + alert: *775 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -232990,11 +236006,11 @@ webhooks: type: string enum: - resolved - alert: *774 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + alert: *775 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -233072,12 +236088,12 @@ webhooks: type: string enum: - unassigned - alert: *774 + alert: *775 assignee: *4 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -233155,11 +236171,11 @@ webhooks: type: string enum: - validated - alert: *774 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + alert: *775 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -233289,10 +236305,10 @@ webhooks: - organization - enterprise - - repository: *722 - enterprise: *719 - installation: *720 - organization: *721 + repository: *723 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -233370,11 +236386,11 @@ webhooks: type: string enum: - published - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - security_advisory: &776 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + security_advisory: &777 description: The details of the security advisory, including summary, description, and severity. type: object @@ -233560,11 +236576,11 @@ webhooks: type: string enum: - updated - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - security_advisory: *776 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + security_advisory: *777 sender: *4 required: - action @@ -233637,10 +236653,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -233827,9 +236843,9 @@ webhooks: type: object properties: security_and_analysis: *287 - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 repository: *334 sender: *4 required: @@ -233908,12 +236924,12 @@ webhooks: type: string enum: - cancelled - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: &777 + sponsorship: &778 type: object properties: created_at: @@ -234218,12 +237234,12 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *777 + sponsorship: *778 required: - action - sponsorship @@ -234311,12 +237327,12 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *777 + sponsorship: *778 required: - action - changes @@ -234393,17 +237409,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &778 + effective_date: &779 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *777 + sponsorship: *778 required: - action - sponsorship @@ -234477,7 +237493,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &779 + changes: &780 type: object properties: tier: @@ -234521,13 +237537,13 @@ webhooks: - from required: - tier - effective_date: *778 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + effective_date: *779 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *777 + sponsorship: *778 required: - action - changes @@ -234604,13 +237620,13 @@ webhooks: type: string enum: - tier_changed - changes: *779 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + changes: *780 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *777 + sponsorship: *778 required: - action - changes @@ -234684,10 +237700,10 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -234771,10 +237787,10 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -235208,15 +238224,15 @@ webhooks: type: - string - 'null' - enterprise: *719 + enterprise: *720 id: description: The unique identifier of the status. type: integer - installation: *720 + installation: *721 name: type: string - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 sha: description: The Commit SHA. @@ -235332,9 +238348,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -235424,9 +238440,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -235516,9 +238532,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -235608,9 +238624,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -235687,12 +238703,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - team: &780 + team: &781 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -235922,9 +238938,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -236394,7 +239410,7 @@ webhooks: - topics - visibility sender: *4 - team: *780 + team: *781 required: - action - team @@ -236470,9 +239486,9 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -236942,7 +239958,7 @@ webhooks: - topics - visibility sender: *4 - team: *780 + team: *781 required: - action - team @@ -237019,9 +240035,9 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -237491,7 +240507,7 @@ webhooks: - topics - visibility sender: *4 - team: *780 + team: *781 required: - action - team @@ -237635,9 +240651,9 @@ webhooks: - from required: - permissions - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -238107,7 +241123,7 @@ webhooks: - topics - visibility sender: *4 - team: *780 + team: *781 required: - action - changes @@ -238185,9 +241201,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -238657,7 +241673,7 @@ webhooks: - topics - visibility sender: *4 - team: *780 + team: *781 required: - action - team @@ -238733,10 +241749,10 @@ webhooks: type: string enum: - started - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -238809,17 +241825,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *719 + enterprise: *720 inputs: type: - object - 'null' additionalProperties: true - installation: *720 - organization: *721 + installation: *721 + organization: *722 ref: type: string - repository: *722 + repository: *723 sender: *4 workflow: type: string @@ -238901,10 +241917,10 @@ webhooks: type: string enum: - completed - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: allOf: @@ -239239,10 +242255,10 @@ webhooks: type: string enum: - in_progress - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: allOf: @@ -239603,10 +242619,10 @@ webhooks: type: string enum: - queued - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: type: object @@ -239831,10 +242847,10 @@ webhooks: type: string enum: - waiting - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: type: object @@ -240061,12 +243077,12 @@ webhooks: type: string enum: - completed - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *734 + workflow: *735 workflow_run: title: Workflow Run type: object @@ -241085,12 +244101,12 @@ webhooks: type: string enum: - in_progress - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *734 + workflow: *735 workflow_run: title: Workflow Run type: object @@ -242094,12 +245110,12 @@ webhooks: type: string enum: - requested - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *734 + workflow: *735 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index 728079642..49b3ac784 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -2152,6 +2152,3174 @@ } } }, + "/agents/repos/{owner}/{repo}/tasks": { + "get": { + "summary": "List tasks for repository", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n\n**Fine-grained access tokens for \"List tasks for repository\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Start a task", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nStarts a new Copilot cloud agent task for a repository.\n\nThis endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription.\n\n**Fine-grained access tokens for \"Start a task\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read and write)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/create-task-in-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#start-a-task" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + } + ], + "requestBody": { + "required": true, + "description": "The task creation parameters, including the user's prompt and optional agent settings.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "prompt" + ], + "properties": { + "prompt": { + "type": "string", + "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`" + }, + "create_pull_request": { + "type": "boolean", + "description": "Whether to create a PR.", + "default": false + }, + "base_ref": { + "type": "string", + "description": "Base ref for new branch/PR" + } + } + }, + "examples": { + "default": { + "value": { + "prompt": "Fix the login button on the homepage", + "base_ref": "main" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Task created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "queued", + "session_count": 1, + "artifacts": [], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "400": { + "description": "Problems parsing JSON", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/repos/{owner}/{repo}/tasks/{task_id}": { + "get": { + "summary": "Get a task by repo", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n\n**Fine-grained access tokens for \"Get a task by repo\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-repo-and-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "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": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks": { + "get": { + "summary": "List tasks", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n\n**Fine-grained access tokens for \"List tasks\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks/{task_id}": { + "get": { + "summary": "Get a task by ID", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n\n**Fine-grained access tokens for \"Get a task by ID\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "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": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, "/app": { "get": { "summary": "Get the authenticated app", @@ -103142,7 +106310,7 @@ "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { "post": { "summary": "Set cluster deployment records", - "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.", + "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.\nNote: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments\narray resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use\nthe artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can\nonly have one name and version.", "tags": [ "orgs" ], @@ -103201,20 +106369,20 @@ "properties": { "name": { "type": "string", - "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", + "description": "The name of the artifact.", "minLength": 1, "maxLength": 256 }, "digest": { "type": "string", - "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", + "description": "The hex encoded digest of the artifact.", "minLength": 71, "maxLength": 71, "pattern": "^sha256:[a-f0-9]{64}$" }, "version": { "type": "string", - "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", + "description": "The artifact version.", "maxLength": 100, "x-multi-segment": true, "examples": [ @@ -189176,7 +192344,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -189261,6 +192430,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -189413,7 +192590,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -189504,7 +192681,7 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication.", "type": "string", "enum": [ "token", @@ -189512,7 +192689,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -189548,7 +192726,7 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { @@ -189566,6 +192744,14 @@ "api_host": { "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", "type": "string" + }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). Required when `auth_type` is `oidc_gcp`.", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).", + "type": "string" } }, "required": [ @@ -189624,6 +192810,17 @@ "service_slug": "my-service-account", "audience": "https://github.com/my-org" } + }, + "org-private-registry-with-oidc-gcp": { + "summary": "Example of an OIDC private registry configuration using Google Cloud Artifact Registry", + "value": { + "registry_type": "docker_registry", + "url": "https://us-docker.pkg.dev/my-project/my-repo", + "auth_type": "oidc_gcp", + "visibility": "all", + "workload_identity_provider": "projects/123456789/locations/global/workloadIdentityPools/github-pool/providers/github-provider", + "service_account": "dependabot@my-project.iam.gserviceaccount.com" + } } } } @@ -189675,7 +192872,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -189764,6 +192962,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -190103,7 +193309,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -190188,6 +193395,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -190256,7 +193471,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -190364,7 +193579,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -190400,7 +193616,7 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { @@ -190418,6 +193634,14 @@ "api_host": { "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", "type": "string" + }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). Required when `auth_type` is `oidc_gcp`.", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).", + "type": "string" } } }, @@ -238259,6 +241483,15 @@ "type": "boolean", "default": false } + }, + { + "name": "is_bypassed", + "in": "query", + "description": "A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -267108,25 +270341,547 @@ } }, { - "name": "cache_id", - "description": "The unique identifier of the GitHub Actions cache.", + "name": "cache_id", + "description": "The unique identifier of the GitHub Actions cache.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/concurrency_groups": { + "get": { + "summary": "List concurrency groups for a repository", + "description": "Lists the active concurrency groups for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-concurrency-groups-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Concurrency Group List", + "description": "A list of active concurrency groups for a repository.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "last_acquired_at" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "last_acquired_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "last_acquired_at": "2026-01-15T16:14:23Z" + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "last_acquired_at": "2026-01-15T16:13:55Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "concurrency-groups" + } + } + }, + "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}": { + "get": { + "summary": "Get a concurrency group for a repository", + "description": "Gets a specific concurrency group for a repository, including all instances in the group's queue.\nReturns 404 if the group is inactive or does not exist.\n\nOptionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items\nahead of the specified workflow run or job in the queue, plus the specified item itself\n(returned as the last element). This is useful for determining what is blocking a particular\nrun or job. Returns 422 if the specified run or job is not in this concurrency group.\n\nWhen using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow\nleases held on behalf of that run. Job-level leases within the run are not considered to\nblock the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow\nleases on the job's ancestor paths.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/get-concurrency-group-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "concurrency_group_name", + "description": "The name of the concurrency group.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "ahead_of_run", + "description": "Filter to items ahead of this workflow run ID in the queue, plus the run itself.\nMatches workflow-level concurrency and reusable-workflow leases held on behalf of\nthe run. Mutually exclusive with `ahead_of_job`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + }, + { + "name": "ahead_of_job", + "description": "Filter to items ahead of this job ID in the queue, plus the job itself.\nMatches job-level concurrency and reusable-workflow leases on the job's\nancestor paths. Mutually exclusive with `ahead_of_run`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 } } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Concurrency Group", + "description": "A concurrency group with the workflow runs and jobs that are either currently holding\nor waiting for the concurrency group lease.", + "type": "object", + "required": [ + "group_name", + "group_url", + "total_count", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "total_count": { + "type": "integer" + }, + "group_members": { + "type": "array", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "job_id": { + "type": "integer", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "total_count": 3, + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress" + }, + { + "run_id": 30433643, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433643", + "status": "pending" + }, + { + "run_id": 30433644, + "run_name": "Deploy hotfix", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644", + "job_id": 798245260, + "job_name": "deploy", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260", + "status": "pending" + } + ] + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "concurrency-groups" } } }, @@ -284436,99 +288191,386 @@ } }, { - "name": "attempt_number", - "description": "The attempt number of the workflow run.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "302": { - "description": "Response", - "headers": { - "Location": { - "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "workflow-runs" - } - } - }, - "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { - "post": { - "summary": "Cancel a workflow run", - "description": "Cancels a workflow run using its `id`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/cancel-workflow-run", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "attempt_number", + "description": "The attempt number of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + "post": { + "summary": "Cancel a workflow run", + "description": "Cancels a workflow run using its `id`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/cancel-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The unique identifier of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups": { + "get": { + "summary": "List concurrency groups for a workflow run", + "description": "Lists all concurrency groups associated with a workflow run or its jobs.\n\nThe set of groups is derived from the run's configuration, so a group is\nincluded even when the run no longer has any items currently holding or\nwaiting in it. In that case the `group_members` array will be empty.\n`total_count` reflects the number of groups the run participates in by\nconfiguration, not the number with active items.\n\nThis differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`,\nwhich returns 404 when a group has no active items. That endpoint reports\nthe live state of a group repo-wide, while this endpoint reports the\ngroups associated with a specific run by configuration.\n\nResults are sorted by group name and support cursor-based pagination via\n`before` and `after`. The `after` cursor paginates forward only and does\nnot emit a `rel=\"prev\"` Link; use `before` to page backward from a\nforward page's `next` cursor.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-concurrency-groups-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The unique identifier of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 } }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, "schema": { "type": "string" } }, { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "path", - "required": true, + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, "schema": { - "type": "integer" + "type": "string" } } ], "responses": { - "202": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", + "title": "Concurrency Group Run List", + "description": "A list of concurrency groups associated with a workflow run.", "type": "object", - "properties": {}, - "additionalProperties": false + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer", + "description": "The total number of concurrency groups this workflow run participates in,\nderived from the run's configuration. This count is not filtered by\nwhether the run currently holds or is waiting in each group, so it can\ninclude groups whose `group_members` array is empty (for example, when\nthe run has already released its lease in that group)." + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group. May return 404 if the group\nhas no active items at the time it is requested, since the\nget-by-name endpoint reports the live repo-wide state of a group\nwhile this endpoint lists groups associated with a run by\nconfiguration." + }, + "group_members": { + "type": "array", + "description": "Items belonging to this workflow run that are either currently holding or\nwaiting for the concurrency group lease. May be empty if the run no\nlonger has any active or queued items in this group.", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status", + "position", + "position_url" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "position": { + "type": "integer", + "description": "Queue position. 0 means the item holds the concurrency lease (in_progress), 1 or higher means queued (pending)." + }, + "position_url": { + "type": "string", + "format": "uri", + "description": "API URL to get items ahead of this item in the concurrency group." + }, + "job_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": [ + "string", + "null" + ], + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } }, "examples": { "default": { - "value": null + "value": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress", + "position": 0, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642" + } + ] + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "pending", + "position": 2, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260", + "job_id": 798245260, + "job_name": "build", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260" + } + ] + } + ] + } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, - "409": { - "description": "Conflict", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -284552,13 +288594,88 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "workflow-runs" + "subcategory": "concurrency-groups" } } }, @@ -618139,6 +622256,15 @@ "type": "boolean", "default": false } + }, + { + "name": "is_bypassed", + "in": "query", + "description": "A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index a8d81b4cc..7980ef9a9 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -1046,7 +1046,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &644 + - &645 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1133,6 +1133,2530 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories + "/agents/repos/{owner}/{repo}/tasks": + get: + summary: List tasks for repository + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for a specific repository + + **Fine-grained access tokens for "List tasks for repository"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/list-tasks-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, + `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived + tasks. When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + - name: creator_id + in: query + schema: + type: integer + description: Filter tasks by creator user ID + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="prev" (when current page > 1), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; + rel="next", ; + rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + post: + summary: Start a task + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Starts a new Copilot cloud agent task for a repository. + + This endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription. + + **Fine-grained access tokens for "Start a task"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read and write) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/create-task-in-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#start-a-task + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + requestBody: + required: true + description: The task creation parameters, including the user's prompt and + optional agent settings. + content: + application/json: + schema: + type: object + required: + - prompt + properties: + prompt: + type: string + 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`' + create_pull_request: + type: boolean + description: Whether to create a PR. + default: false + base_ref: + type: string + description: Base ref for new branch/PR + examples: + default: + value: + prompt: Fix the login button on the homepage + base_ref: main + responses: + '201': + description: Task created successfully + content: + application/json: + schema: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: queued + session_count: 1 + artifacts: [] + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '400': + description: Problems parsing JSON + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/repos/{owner}/{repo}/tasks/{task_id}": + get: + summary: Get a task by repo + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID scoped to an owner/repo path + + **Fine-grained access tokens for "Get a task by repo"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-repo-and-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + allOf: + - type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + 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: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/tasks": + get: + summary: List tasks + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for the authenticated user + + **Fine-grained access tokens for "List tasks"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/list-tasks + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, + `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived + tasks. When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; rel="next", + ; rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/tasks/{task_id}": + get: + summary: Get a task by ID + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID with its associated sessions + + **Fine-grained access tokens for "Get a task by ID"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + allOf: + - type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + 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: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation "/app": get: summary: Get the authenticated app @@ -11837,7 +14361,7 @@ paths: properties: action: type: string - discussion: &735 + discussion: &736 title: Discussion description: A Discussion in a repository. type: object @@ -12622,7 +15146,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &655 + sub_issues_summary: &656 title: Sub-issues Summary type: object properties: @@ -12733,7 +15257,7 @@ paths: - url - created_at - updated_at - issue_dependencies_summary: &656 + issue_dependencies_summary: &657 title: Issue Dependencies Summary type: object properties: @@ -19337,7 +21861,7 @@ paths: required: false schema: type: string - - &712 + - &713 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -19483,7 +22007,7 @@ paths: parameters: - *74 - *116 - - &713 + - &714 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -19595,7 +22119,7 @@ paths: - *116 - *118 - *117 - - &714 + - &715 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -19603,7 +22127,7 @@ paths: schema: type: string - *119 - - &715 + - &716 name: sku description: The SKU to query for usage. in: query @@ -25940,6 +28464,10 @@ paths: If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. If no existing records match, new records will be created. + Note: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments + array resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use + the artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can + only have one name and version. tags: - orgs operationId: orgs/set-cluster-deployment-records @@ -25982,24 +28510,18 @@ paths: properties: name: type: string - description: | - The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name parameter must also be identical across all entries. + description: The name of the artifact. minLength: 1 maxLength: 256 digest: type: string - description: | - The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name and version parameters must also be identical across all entries. + description: The hex encoded digest of the artifact. minLength: 71 maxLength: 71 pattern: "^sha256:[a-f0-9]{64}$" version: type: string - description: | - The artifact version. Note that if multiple deployments have identical 'digest' parameter values, - the version parameter must also be identical across all entries. + description: The artifact version. maxLength: 100 x-multi-segment: true examples: @@ -26476,12 +28998,12 @@ paths: required: - subject_digests examples: - default: &693 + default: &694 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &694 + withPredicateType: &695 value: subject_digests: - sha256:abc123 @@ -26526,7 +29048,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &695 + default: &696 value: attestations_subject_digests: - sha256:abc: @@ -39113,7 +41635,7 @@ paths: parameters: - *74 - *248 - - &675 + - &676 name: repo_name description: repo_name parameter in: path @@ -40061,7 +42583,7 @@ paths: - nuget - container - *74 - - &676 + - &677 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -40102,7 +42624,7 @@ paths: default: *254 '403': *27 '401': *23 - '400': &678 + '400': &679 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -41439,6 +43961,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -41509,6 +44032,15 @@ paths: api_host: description: The Cloudsmith API host. type: string + workload_identity_provider: + description: The full resource name of the GCP Workload + Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + type: string + service_account: + description: The GCP service account email to impersonate. + If omitted, the federated token is used directly (direct + WIF). + type: string created_at: type: string format: date-time @@ -41546,7 +44078,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -41640,7 +44172,477 @@ paths: auth_type: description: The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, - or `oidc_cloudsmith` for OIDC authentication. + `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication. + type: string + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + - oidc_cloudsmith + - oidc_gcp + tenant_id: + description: The tenant ID of the Azure AD application. Required + when `auth_type` is `oidc_azure`. + type: string + client_id: + description: The client ID of the Azure AD application. Required + when `auth_type` is `oidc_azure`. + type: string + aws_region: + description: The AWS region. Required when `auth_type` is `oidc_aws`. + type: string + account_id: + description: The AWS account ID. Required when `auth_type` is `oidc_aws`. + type: string + role_name: + description: The AWS IAM role name. Required when `auth_type` is + `oidc_aws`. + type: string + domain: + description: The CodeArtifact domain. Required when `auth_type` + is `oidc_aws`. + type: string + domain_owner: + description: The CodeArtifact domain owner (AWS account ID). Required + when `auth_type` is `oidc_aws`. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. Required when `auth_type` + is `oidc_jfrog`. + type: string + audience: + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and `oidc_gcp`, and required for `oidc_cloudsmith` auth types. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. Optional for `oidc_jfrog` + auth type. + type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + Required when `auth_type` is `oidc_gcp`. + type: string + service_account: + description: The GCP service account email to impersonate. Optional + for `oidc_gcp` auth type. If omitted, the federated token is used + directly (direct WIF). + type: string + required: + - registry_type + - url + - visibility + examples: + org-private-registry-with-private-visibility: + summary: Example of a private registry configuration with private + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + replaces_base: true + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: private + org-private-registry-with-selected-visibility: + summary: Example of a private registry configuration with selected + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + org-private-registry-with-oidc-azure: + summary: Example of an OIDC private registry configuration using Azure + value: + registry_type: docker_registry + url: https://myregistry.azurecr.io + auth_type: oidc_azure + visibility: all + tenant_id: 12345678-1234-1234-1234-123456789012 + client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org + org-private-registry-with-oidc-gcp: + summary: Example of an OIDC private registry configuration using Google + Cloud Artifact Registry + value: + registry_type: docker_registry + url: https://us-docker.pkg.dev/my-project/my-repo + auth_type: oidc_gcp + visibility: all + workload_identity_provider: projects/123456789/locations/global/workloadIdentityPools/github-pool/providers/github-provider + service_account: dependabot@my-project.iam.gserviceaccount.com + responses: + '201': + description: The organization private registry configuration + content: + application/json: + schema: + title: Organization private registry + description: Private registry configuration for an organization + type: object + properties: + name: + description: The name of the private registry configuration. + type: string + examples: + - MAVEN_REPOSITORY_SECRET + registry_type: + description: The registry type. + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + type: string + auth_type: + description: The authentication type for the private registry. + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + - oidc_cloudsmith + - oidc_gcp + type: string + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the + private registry. + type: string + examples: + - monalisa + replaces_base: + description: Whether this private registry replaces the base registry + (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, + Dependabot will only use this registry and will not fall back + to the public registry. When `false` (default), Dependabot will + use this registry for scoped packages but may fall back to the + public registry for other packages. + type: boolean + default: false + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + enum: + - all + - private + - selected + type: string + selected_repository_ids: + type: array + description: An array of repository IDs that can access the organization + private registry when `visibility` is set to `selected`. + items: + type: integer + tenant_id: + description: The tenant ID of the Azure AD application. + type: string + client_id: + description: The client ID of the Azure AD application. + type: string + aws_region: + description: The AWS region. + type: string + account_id: + description: The AWS account ID. + type: string + role_name: + description: The AWS IAM role name. + type: string + domain: + description: The CodeArtifact domain. + type: string + domain_owner: + description: The CodeArtifact domain owner. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. + type: string + audience: + description: The OIDC audience. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. + type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + type: string + service_account: + description: The GCP service account email to impersonate. If + omitted, the federated token is used directly (direct WIF). + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - registry_type + - visibility + - created_at + - updated_at + examples: + org-private-registry-with-selected-visibility: &268 + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: private + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + org-private-registry-with-private-visibility: + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/public-key": + get: + summary: Get private registries public key for an organization + description: |2- + + Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization + parameters: + - *74 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - key_id + - key + properties: + key_id: + description: The identifier for the key. + type: string + examples: + - '012345678912345678' + key: + description: The Base64 encoded public key. + type: string + examples: + - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + examples: + default: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + headers: + Link: *66 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/{secret_name}": + get: + summary: Get a private registry for an organization + description: |2- + + Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization + parameters: + - *74 + - *161 + responses: + '200': + description: The specified private registry configuration for the organization + content: + application/json: + schema: *267 + examples: + default: *268 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + patch: + summary: Update a private registry for an organization + description: |2- + + Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/update-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization + parameters: + - *74 + - *161 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + registry_type: + description: The registry type. + type: string + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the private + registry. This field should be omitted if the private registry + does not require a username for authentication. + type: + - string + - 'null' + replaces_base: + description: Whether this private registry should replace the base + registry (e.g., npmjs.org for npm, rubygems.org for rubygems). + When set to `true`, Dependabot will only use this registry and + will not fall back to the public registry. When set to `false` + (default), Dependabot will use this registry for scoped packages + but may fall back to the public registry for other packages. + type: boolean + default: false + encrypted_value: + description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get private registries + public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + endpoint. + type: string + pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + key_id: + description: The ID of the key you used to encrypt the secret. + type: string + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + type: string + enum: + - all + - private + - selected + selected_repository_ids: + description: An array of repository IDs that can access the organization + private registry. You can only provide a list of repository IDs + when `visibility` is set to `selected`. This field should be omitted + if `visibility` is set to `all` or `private`. + type: array + items: + type: integer + auth_type: + description: The authentication type for the private registry. This + field cannot be changed after creation. If provided, it must match + the existing `auth_type` of the configuration. To change the authentication + type, delete and recreate the configuration. type: string enum: - token @@ -41649,6 +44651,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -41681,7 +44684,7 @@ paths: type: string audience: description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, - and required for `oidc_cloudsmith` auth types. + and `oidc_gcp`, and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` @@ -41699,445 +44702,15 @@ paths: description: The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default. type: string - required: - - registry_type - - url - - visibility - examples: - org-private-registry-with-private-visibility: - summary: Example of a private registry configuration with private - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - replaces_base: true - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: private - org-private-registry-with-selected-visibility: - summary: Example of a private registry configuration with selected - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - org-private-registry-with-oidc-azure: - summary: Example of an OIDC private registry configuration using Azure - value: - registry_type: docker_registry - url: https://myregistry.azurecr.io - auth_type: oidc_azure - visibility: all - tenant_id: 12345678-1234-1234-1234-123456789012 - client_id: abcdef01-2345-6789-abcd-ef0123456789 - org-private-registry-with-oidc-cloudsmith: - summary: Example of an OIDC private registry configuration using Cloudsmith - value: - registry_type: npm_registry - url: https://npm.cloudsmith.io/my-org/my-repo/ - auth_type: oidc_cloudsmith - visibility: all - namespace: my-org - service_slug: my-service-account - audience: https://github.com/my-org - responses: - '201': - description: The organization private registry configuration - content: - application/json: - schema: - title: Organization private registry - description: Private registry configuration for an organization - type: object - properties: - name: - description: The name of the private registry configuration. - type: string - examples: - - MAVEN_REPOSITORY_SECRET - registry_type: - description: The registry type. - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - type: string - auth_type: - description: The authentication type for the private registry. - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - - oidc_cloudsmith - type: string - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with the - private registry. - type: string - examples: - - monalisa - replaces_base: - description: Whether this private registry replaces the base registry - (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, - Dependabot will only use this registry and will not fall back - to the public registry. When `false` (default), Dependabot will - use this registry for scoped packages but may fall back to the - public registry for other packages. - type: boolean - default: false - visibility: - description: Which type of organization repositories have access - to the private registry. `selected` means only the repositories - specified by `selected_repository_ids` can access the private - registry. - enum: - - all - - private - - selected - type: string - selected_repository_ids: - type: array - description: An array of repository IDs that can access the organization - private registry when `visibility` is set to `selected`. - items: - type: integer - tenant_id: - description: The tenant ID of the Azure AD application. - type: string - client_id: - description: The client ID of the Azure AD application. - type: string - aws_region: - description: The AWS region. - type: string - account_id: - description: The AWS account ID. - type: string - role_name: - description: The AWS IAM role name. - type: string - domain: - description: The CodeArtifact domain. - type: string - domain_owner: - description: The CodeArtifact domain owner. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. - type: string - audience: - description: The OIDC audience. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. - type: string - namespace: - description: The Cloudsmith organization namespace. - type: string - service_slug: - description: The Cloudsmith service account slug. - type: string - api_host: - description: The Cloudsmith API host. - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - name - - registry_type - - visibility - - created_at - - updated_at - examples: - org-private-registry-with-selected-visibility: &268 - value: - name: MAVEN_REPOSITORY_SECRET - registry_type: maven_repository - username: monalisa - visibility: private - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - org-private-registry-with-private-visibility: - value: - name: MAVEN_REPOSITORY_SECRET - registry_type: maven_repository - username: monalisa - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/public-key": - get: - summary: Get private registries public key for an organization - description: |2- - - Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization - parameters: - - *74 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - key_id - - key - properties: - key_id: - description: The identifier for the key. - type: string - examples: - - '012345678912345678' - key: - description: The Base64 encoded public key. - type: string - examples: - - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - examples: - default: - value: - key_id: '012345678912345678' - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - headers: - Link: *66 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/{secret_name}": - get: - summary: Get a private registry for an organization - description: |2- - - Get the configuration of a single private registry defined for an organization, omitting its encrypted value. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization - parameters: - - *74 - - *161 - responses: - '200': - description: The specified private registry configuration for the organization - content: - application/json: - schema: *267 - examples: - default: *268 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - patch: - summary: Update a private registry for an organization - description: |2- - - Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/update-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization - parameters: - - *74 - - *161 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - registry_type: - description: The registry type. + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + Required when `auth_type` is `oidc_gcp`. type: string - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with the private - registry. This field should be omitted if the private registry - does not require a username for authentication. - type: - - string - - 'null' - replaces_base: - description: Whether this private registry should replace the base - registry (e.g., npmjs.org for npm, rubygems.org for rubygems). - When set to `true`, Dependabot will only use this registry and - will not fall back to the public registry. When set to `false` - (default), Dependabot will use this registry for scoped packages - but may fall back to the public registry for other packages. - type: boolean - default: false - encrypted_value: - description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get private registries - public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) - endpoint. - type: string - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - description: The ID of the key you used to encrypt the secret. - type: string - visibility: - description: Which type of organization repositories have access - to the private registry. `selected` means only the repositories - specified by `selected_repository_ids` can access the private - registry. - type: string - enum: - - all - - private - - selected - selected_repository_ids: - description: An array of repository IDs that can access the organization - private registry. You can only provide a list of repository IDs - when `visibility` is set to `selected`. This field should be omitted - if `visibility` is set to `all` or `private`. - type: array - items: - type: integer - auth_type: - description: The authentication type for the private registry. This - field cannot be changed after creation. If provided, it must match - the existing `auth_type` of the configuration. To change the authentication - type, delete and recreate the configuration. - type: string - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - - oidc_cloudsmith - tenant_id: - description: The tenant ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - client_id: - description: The client ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - aws_region: - description: The AWS region. Required when `auth_type` is `oidc_aws`. - type: string - account_id: - description: The AWS account ID. Required when `auth_type` is `oidc_aws`. - type: string - role_name: - description: The AWS IAM role name. Required when `auth_type` is - `oidc_aws`. - type: string - domain: - description: The CodeArtifact domain. Required when `auth_type` - is `oidc_aws`. - type: string - domain_owner: - description: The CodeArtifact domain owner (AWS account ID). Required - when `auth_type` is `oidc_aws`. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. Required when `auth_type` - is `oidc_jfrog`. - type: string - audience: - description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, - and required for `oidc_cloudsmith` auth types. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. Optional for `oidc_jfrog` - auth type. - type: string - namespace: - description: The Cloudsmith organization namespace. Required when - `auth_type` is `oidc_cloudsmith`. - type: string - service_slug: - description: The Cloudsmith service account slug. Required when - `auth_type` is `oidc_cloudsmith`. - type: string - api_host: - description: The Cloudsmith API host. Optional for `oidc_cloudsmith` - auth type. If omitted, `api.cloudsmith.io` is used by default. + service_account: + description: The GCP service account email to impersonate. Optional + for `oidc_gcp` auth type. If omitted, the federated token is used + directly (direct WIF). type: string examples: secret-based-update: @@ -42293,7 +44866,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &763 + - &764 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -43179,7 +45752,7 @@ paths: - updated_at - project_url examples: - default: &699 + default: &700 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -43356,7 +45929,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &700 + items: &701 type: object properties: name: @@ -43393,7 +45966,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &701 + iteration_configuration: &702 type: object description: The configuration for iteration fields. properties: @@ -43443,7 +46016,7 @@ paths: value: name: Due date data_type: date - single_select_field: &702 + single_select_field: &703 summary: Create a single select field value: name: Priority @@ -43470,7 +46043,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &703 + iteration_field: &704 summary: Create an iteration field value: name: Sprint @@ -43496,7 +46069,7 @@ paths: application/json: schema: *274 examples: - text_field: &704 + text_field: &705 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -43505,7 +46078,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &705 + number_field: &706 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -43514,7 +46087,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &706 + date_field: &707 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -43523,7 +46096,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &707 + single_select_field: &708 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -43557,7 +46130,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &708 + iteration_field: &709 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -43603,7 +46176,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *271 - - &709 + - &710 name: field_id description: The unique identifier of the field. in: path @@ -43618,7 +46191,7 @@ paths: application/json: schema: *274 examples: - default: &710 + default: &711 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -44829,7 +47402,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &690 + schema: &691 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -45012,7 +47585,7 @@ paths: parameters: - *271 - *74 - - &711 + - &712 name: view_number description: The number that identifies the project view. in: path @@ -49136,6 +51709,17 @@ paths: schema: type: boolean default: false + - &622 + name: is_bypassed + in: query + description: A boolean value (`true` or `false`) indicating whether to filter + alerts by their push protection bypass status. When set to `true`, only + alerts that were created because a push protection rule was bypassed will + be returned. When set to `false`, only alerts that were not caused by a + push protection bypass will be returned. + required: false + schema: + type: boolean responses: '200': description: Response @@ -49159,14 +51743,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &622 + state: &623 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &623 + resolution: &624 type: - string - 'null' @@ -49285,14 +51869,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &624 + - &625 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &626 + - &627 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -49356,7 +51940,7 @@ paths: - blob_url - commit_sha - commit_url - - &627 + - &628 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -49417,7 +52001,7 @@ paths: - page_url - commit_sha - commit_url - - &628 + - &629 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -49439,7 +52023,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &629 + - &630 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -49461,7 +52045,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &630 + - &631 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -49483,7 +52067,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &631 + - &632 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -49498,7 +52082,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &632 + - &633 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -49513,7 +52097,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &633 + - &634 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -49528,7 +52112,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &634 + - &635 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -49550,7 +52134,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &635 + - &636 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -49572,7 +52156,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &636 + - &637 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -49594,7 +52178,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &637 + - &638 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -49616,7 +52200,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &638 + - &639 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -50137,7 +52721,7 @@ paths: application/json: schema: type: array - items: &642 + items: &643 description: A repository security advisory. type: object properties: @@ -50434,7 +53018,7 @@ paths: - private_fork additionalProperties: false examples: - default: &643 + default: &644 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -52501,7 +55085,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &658 + response-if-user-is-a-team-maintainer: &659 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -52566,7 +55150,7 @@ paths: application/json: schema: *330 examples: - response-if-users-membership-with-team-is-now-pending: &659 + response-if-users-membership-with-team-is-now-pending: &660 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -52680,7 +55264,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &660 + schema: &661 title: Team Repository description: A team's access to a repository. type: object @@ -53401,7 +55985,7 @@ paths: type: array items: *191 examples: - response-if-child-teams-exist: &661 + response-if-child-teams-exist: &662 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -55253,6 +57837,245 @@ paths: enabledForGitHubApps: true category: actions subcategory: cache + "/repos/{owner}/{repo}/actions/concurrency_groups": + get: + summary: List concurrency groups for a repository + description: |- + Lists the active concurrency groups for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-concurrency-groups-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository + parameters: + - *331 + - *332 + - *17 + - *46 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Concurrency Group List + description: A list of active concurrency groups for a repository. + type: object + required: + - total_count + - concurrency_groups + properties: + total_count: + type: integer + concurrency_groups: + type: array + items: + type: object + required: + - group_name + - group_url + - last_acquired_at + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: API URL for this concurrency group. + last_acquired_at: + type: + - string + - 'null' + format: date-time + examples: + default: + value: + total_count: 2 + concurrency_groups: + - group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + last_acquired_at: '2026-01-15T16:14:23Z' + - group_name: ci-build + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build + last_acquired_at: '2026-01-15T16:13:55Z' + headers: + Link: *66 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups + "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}": + get: + summary: Get a concurrency group for a repository + description: |- + Gets a specific concurrency group for a repository, including all instances in the group's queue. + Returns 404 if the group is inactive or does not exist. + + Optionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items + ahead of the specified workflow run or job in the queue, plus the specified item itself + (returned as the last element). This is useful for determining what is blocking a particular + run or job. Returns 422 if the specified run or job is not in this concurrency group. + + When using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow + leases held on behalf of that run. Job-level leases within the run are not considered to + block the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow + leases on the job's ancestor paths. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-concurrency-group-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository + parameters: + - *331 + - *332 + - name: concurrency_group_name + description: The name of the concurrency group. + in: path + required: true + schema: + type: string + - name: ahead_of_run + description: |- + Filter to items ahead of this workflow run ID in the queue, plus the run itself. + Matches workflow-level concurrency and reusable-workflow leases held on behalf of + the run. Mutually exclusive with `ahead_of_job`. + in: query + required: false + schema: + type: integer + minimum: 1 + - name: ahead_of_job + description: |- + Filter to items ahead of this job ID in the queue, plus the job itself. + Matches job-level concurrency and reusable-workflow leases on the job's + ancestor paths. Mutually exclusive with `ahead_of_run`. + in: query + required: false + schema: + type: integer + minimum: 1 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Concurrency Group + description: |- + A concurrency group with the workflow runs and jobs that are either currently holding + or waiting for the concurrency group lease. + type: object + required: + - group_name + - group_url + - total_count + - group_members + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: API URL for this concurrency group. + total_count: + type: integer + group_members: + type: array + items: + type: object + required: + - run_id + - run_name + - run_url + - run_html_url + - status + properties: + run_id: + type: integer + description: The ID of the workflow run. + run_name: + type: string + description: The name of the workflow run. + run_url: + type: + - string + - 'null' + format: uri + description: API URL for the workflow run. + run_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the workflow run. + job_id: + type: integer + description: The ID of the job, when the item represents + a job-level or reusable-workflow-level lease. + job_name: + type: string + description: The display name of the job, when the item + represents a job-level or reusable-workflow-level lease. + job_url: + type: + - string + - 'null' + format: uri + description: API URL for the job. + job_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the job. + status: + type: string + enum: + - in_progress + - pending + examples: + default: + value: + group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + total_count: 3 + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: in_progress + - run_id: 30433643 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433643 + status: pending + - run_id: 30433644 + run_name: Deploy hotfix + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433644 + job_id: 798245260 + job_name: deploy + job_url: https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260 + job_html_url: https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260 + status: pending + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups "/repos/{owner}/{repo}/actions/jobs/{job_id}": get: summary: Get a job for a workflow run @@ -58306,6 +61129,198 @@ paths: enabledForGitHubApps: true category: actions subcategory: workflow-runs + "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups": + get: + summary: List concurrency groups for a workflow run + description: |- + Lists all concurrency groups associated with a workflow run or its jobs. + + The set of groups is derived from the run's configuration, so a group is + included even when the run no longer has any items currently holding or + waiting in it. In that case the `group_members` array will be empty. + `total_count` reflects the number of groups the run participates in by + configuration, not the number with active items. + + This differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`, + which returns 404 when a group has no active items. That endpoint reports + the live state of a group repo-wide, while this endpoint reports the + groups associated with a specific run by configuration. + + Results are sorted by group name and support cursor-based pagination via + `before` and `after`. The `after` cursor paginates forward only and does + not emit a `rel="prev"` Link; use `before` to page backward from a + forward page's `next` cursor. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-concurrency-groups-for-workflow-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run + parameters: + - *331 + - *332 + - *369 + - *17 + - *45 + - *46 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Concurrency Group Run List + description: A list of concurrency groups associated with a workflow + run. + type: object + required: + - total_count + - concurrency_groups + properties: + total_count: + type: integer + description: |- + The total number of concurrency groups this workflow run participates in, + derived from the run's configuration. This count is not filtered by + whether the run currently holds or is waiting in each group, so it can + include groups whose `group_members` array is empty (for example, when + the run has already released its lease in that group). + concurrency_groups: + type: array + items: + type: object + required: + - group_name + - group_url + - group_members + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: |- + API URL for this concurrency group. May return 404 if the group + has no active items at the time it is requested, since the + get-by-name endpoint reports the live repo-wide state of a group + while this endpoint lists groups associated with a run by + configuration. + group_members: + type: array + description: |- + Items belonging to this workflow run that are either currently holding or + waiting for the concurrency group lease. May be empty if the run no + longer has any active or queued items in this group. + items: + type: object + required: + - run_id + - run_name + - run_url + - run_html_url + - status + - position + - position_url + properties: + run_id: + type: integer + description: The ID of the workflow run. + run_name: + type: string + description: The name of the workflow run. + run_url: + type: + - string + - 'null' + format: uri + description: API URL for the workflow run. + run_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the workflow run. + position: + type: integer + description: Queue position. 0 means the item holds + the concurrency lease (in_progress), 1 or higher + means queued (pending). + position_url: + type: string + format: uri + description: API URL to get items ahead of this item + in the concurrency group. + job_id: + type: + - integer + - 'null' + description: The ID of the job, when the item represents + a job-level or reusable-workflow-level lease. + job_name: + type: + - string + - 'null' + description: The display name of the job, when the + item represents a job-level or reusable-workflow-level + lease. + job_url: + type: + - string + - 'null' + format: uri + description: API URL for the job. + job_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the job. + status: + type: string + enum: + - in_progress + - pending + examples: + default: + value: + total_count: 2 + concurrency_groups: + - group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: in_progress + position: 0 + position_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642 + - group_name: ci-build + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: pending + position: 2 + position_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260 + job_id: 798245260 + job_name: build + job_url: https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260 + job_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260 + headers: + Link: *66 + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": post: summary: Review custom deployment protection rules for a workflow run @@ -64552,7 +67567,7 @@ paths: check. type: array items: *85 - deployment: &724 + deployment: &725 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -69805,7 +72820,7 @@ paths: type: array items: *452 examples: - default: &666 + default: &667 value: total_count: 2 machines: @@ -72982,7 +75997,7 @@ paths: application/json: schema: type: array - items: &647 + items: &648 title: Status description: The status of a commit. type: object @@ -74608,7 +77623,7 @@ paths: items: type: object properties: - placeholder_id: &639 + placeholder_id: &640 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -80609,7 +83624,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &755 + last_response: &756 title: Hook Response type: object properties: @@ -81678,7 +84693,7 @@ paths: parameters: - *331 - *332 - - &688 + - &689 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -82112,7 +85127,7 @@ paths: type: array items: *528 examples: - default: &680 + default: &681 value: - id: 1 repository: @@ -96417,6 +99432,7 @@ paths: - *619 - *620 - *621 + - *622 responses: '200': description: Response @@ -96424,7 +99440,7 @@ paths: application/json: schema: type: array - items: &625 + items: &626 type: object properties: number: *171 @@ -96440,8 +99456,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *622 - resolution: *623 + state: *623 + resolution: *624 resolved_at: type: - string @@ -96547,7 +99563,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *624 + - *625 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -96715,7 +99731,7 @@ paths: description: Response content: application/json: - schema: *625 + schema: *626 examples: default: value: @@ -96779,8 +99795,8 @@ paths: schema: type: object properties: - state: *622 - resolution: *623 + state: *623 + resolution: *624 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -96828,7 +99844,7 @@ paths: description: Response content: application/json: - schema: *625 + schema: *626 examples: default: value: @@ -96937,7 +99953,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &775 + items: &776 type: object properties: type: @@ -96964,7 +99980,6 @@ paths: - commit details: oneOf: - - *626 - *627 - *628 - *629 @@ -96977,6 +99992,7 @@ paths: - *636 - *637 - *638 + - *639 examples: default: value: @@ -97071,14 +100087,14 @@ paths: schema: type: object properties: - reason: &640 + reason: &641 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *639 + placeholder_id: *640 required: - reason - placeholder_id @@ -97095,7 +100111,7 @@ paths: schema: type: object properties: - reason: *640 + reason: *641 expire_at: type: - string @@ -97158,7 +100174,7 @@ paths: properties: incremental_scans: type: array - items: &641 + items: &642 description: Information on a single scan performed by secret scanning on the repository type: object @@ -97186,15 +100202,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *641 + items: *642 backfill_scans: type: array - items: *641 + items: *642 custom_pattern_backfill_scans: type: array items: allOf: - - *641 + - *642 - type: object properties: pattern_name: @@ -97207,7 +100223,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *641 + items: *642 examples: default: value: @@ -97317,9 +100333,9 @@ paths: application/json: schema: type: array - items: *642 + items: *643 examples: - default: *643 + default: *644 '400': *14 '404': *6 x-github: @@ -97513,9 +100529,9 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: &645 + default: &646 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -97859,7 +100875,7 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: default: value: @@ -98007,15 +101023,15 @@ paths: parameters: - *331 - *332 - - *644 + - *645 responses: '200': description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: *645 + default: *646 '403': *27 '404': *6 x-github: @@ -98041,7 +101057,7 @@ paths: parameters: - *331 - *332 - - *644 + - *645 requestBody: required: true content: @@ -98212,10 +101228,10 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: *645 - add_credit: *645 + default: *646 + add_credit: *646 '403': *27 '404': *6 '422': @@ -98255,7 +101271,7 @@ paths: parameters: - *331 - *332 - - *644 + - *645 responses: '202': *37 '400': *14 @@ -98284,7 +101300,7 @@ paths: parameters: - *331 - *332 - - *644 + - *645 responses: '202': description: Response @@ -98425,7 +101441,7 @@ paths: application/json: schema: type: array - items: &646 + items: &647 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -98798,7 +101814,7 @@ paths: application/json: schema: type: array - items: *646 + items: *647 examples: default: value: @@ -98888,7 +101904,7 @@ paths: description: Response content: application/json: - schema: *647 + schema: *648 examples: default: value: @@ -98982,7 +101998,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &648 + schema: &649 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -99082,7 +102098,7 @@ paths: description: Response content: application/json: - schema: *648 + schema: *649 examples: default: value: @@ -99292,7 +102308,7 @@ paths: description: Response content: application/json: - schema: &649 + schema: &650 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -99304,7 +102320,7 @@ paths: required: - names examples: - default: &650 + default: &651 value: names: - octocat @@ -99359,9 +102375,9 @@ paths: description: Response content: application/json: - schema: *649 + schema: *650 examples: - default: *650 + default: *651 '404': *6 '422': *7 x-github: @@ -99384,7 +102400,7 @@ paths: parameters: - *331 - *332 - - &651 + - &652 name: per description: The time frame to display results for. in: query @@ -99415,7 +102431,7 @@ paths: - 128 clones: type: array - items: &652 + items: &653 title: Traffic type: object properties: @@ -99663,7 +102679,7 @@ paths: parameters: - *331 - *332 - - *651 + - *652 responses: '200': description: Response @@ -99684,7 +102700,7 @@ paths: - 3782 views: type: array - items: *652 + items: *653 required: - uniques - count @@ -100456,7 +103472,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &653 + text_matches: &654 title: Search Result Text Matches type: array items: @@ -100619,7 +103635,7 @@ paths: enum: - author-date - committer-date - - &654 + - &655 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -100739,7 +103755,7 @@ paths: type: number node_id: type: string - text_matches: *653 + text_matches: *654 required: - sha - node_id @@ -100931,7 +103947,7 @@ paths: - interactions - created - updated - - *654 + - *655 - *17 - *19 - name: advanced_search @@ -101045,8 +104061,8 @@ paths: type: - string - 'null' - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -101073,7 +104089,7 @@ paths: - string - 'null' format: date-time - text_matches: *653 + text_matches: *654 pull_request: type: object properties: @@ -101337,7 +104353,7 @@ paths: enum: - created - updated - - *654 + - *655 - *17 - *19 responses: @@ -101382,7 +104398,7 @@ paths: - 'null' score: type: number - text_matches: *653 + text_matches: *654 required: - id - node_id @@ -101467,7 +104483,7 @@ paths: - forks - help-wanted-issues - updated - - *654 + - *655 - *17 - *19 responses: @@ -101713,7 +104729,7 @@ paths: - admin - pull - push - text_matches: *653 + text_matches: *654 temp_clone_token: type: string allow_merge_commit: @@ -102021,7 +105037,7 @@ paths: - string - 'null' format: uri - text_matches: *653 + text_matches: *654 related: type: - array @@ -102214,7 +105230,7 @@ paths: - followers - repositories - joined - - *654 + - *655 - *17 - *19 responses: @@ -102324,7 +105340,7 @@ paths: type: - boolean - 'null' - text_matches: *653 + text_matches: *654 blog: type: - string @@ -102406,7 +105422,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &657 + - &658 name: team_id description: The unique identifier of the team. in: path @@ -102447,7 +105463,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *657 + - *658 requestBody: required: true content: @@ -102548,7 +105564,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *657 + - *658 responses: '204': description: Response @@ -102577,7 +105593,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *657 + - *658 - *17 - *19 responses: @@ -102615,7 +105631,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *657 + - *658 - name: role description: Filters members returned by their role in the team. in: query @@ -102666,7 +105682,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *657 + - *658 - *70 responses: '204': @@ -102703,7 +105719,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *657 + - *658 - *70 responses: '204': @@ -102743,7 +105759,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *657 + - *658 - *70 responses: '204': @@ -102780,7 +105796,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *657 + - *658 - *70 responses: '200': @@ -102789,7 +105805,7 @@ paths: application/json: schema: *330 examples: - response-if-user-is-a-team-maintainer: *658 + response-if-user-is-a-team-maintainer: *659 '404': *6 x-github: githubCloudOnly: false @@ -102822,7 +105838,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *657 + - *658 - *70 requestBody: required: false @@ -102850,7 +105866,7 @@ paths: application/json: schema: *330 examples: - response-if-users-membership-with-team-is-now-pending: *659 + response-if-users-membership-with-team-is-now-pending: *660 '403': description: Forbidden if team synchronization is set up '422': @@ -102884,7 +105900,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *657 + - *658 - *70 responses: '204': @@ -102912,7 +105928,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *657 + - *658 - *17 - *19 responses: @@ -102954,7 +105970,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *657 + - *658 - *331 - *332 responses: @@ -102962,7 +105978,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *660 + schema: *661 examples: alternative-response-with-extra-repository-information: value: @@ -103112,7 +106128,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *657 + - *658 - *331 - *332 requestBody: @@ -103164,7 +106180,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *657 + - *658 - *331 - *332 responses: @@ -103191,7 +106207,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *657 + - *658 - *17 - *19 responses: @@ -103203,7 +106219,7 @@ paths: type: array items: *191 examples: - response-if-child-teams-exist: *661 + response-if-child-teams-exist: *662 headers: Link: *66 '404': *6 @@ -103236,7 +106252,7 @@ paths: application/json: schema: oneOf: - - &662 + - &663 title: Private User description: Private User type: object @@ -103486,7 +106502,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - &687 + - &688 title: Public User description: Public User type: object @@ -103820,7 +106836,7 @@ paths: description: Response content: application/json: - schema: *662 + schema: *663 examples: default: value: @@ -104218,7 +107234,7 @@ paths: type: integer secrets: type: array - items: &663 + items: &664 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -104338,7 +107354,7 @@ paths: description: Response content: application/json: - schema: *663 + schema: *664 examples: default: value: @@ -104751,7 +107767,7 @@ paths: description: Response content: application/json: - schema: &664 + schema: &665 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -104804,7 +107820,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &665 + default: &666 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -104849,9 +107865,9 @@ paths: description: Response content: application/json: - schema: *664 + schema: *665 examples: - default: *665 + default: *666 '404': *6 x-github: githubCloudOnly: false @@ -104890,7 +107906,7 @@ paths: type: array items: *452 examples: - default: *666 + default: *667 '304': *35 '500': *53 '401': *23 @@ -105856,7 +108872,7 @@ paths: type: array items: *253 examples: - default: &677 + default: &678 value: - id: 197 name: hello_docker @@ -105957,7 +108973,7 @@ paths: application/json: schema: type: array - items: &667 + items: &668 title: Email description: Email type: object @@ -106027,9 +109043,9 @@ paths: application/json: schema: type: array - items: *667 + items: *668 examples: - default: &679 + default: &680 value: - email: octocat@github.com verified: true @@ -106106,7 +109122,7 @@ paths: application/json: schema: type: array - items: *667 + items: *668 examples: default: value: @@ -106364,7 +109380,7 @@ paths: application/json: schema: type: array - items: &668 + items: &669 title: GPG Key description: A unique encryption key type: object @@ -106509,7 +109525,7 @@ paths: - subkeys - revoked examples: - default: &697 + default: &698 value: - id: 3 name: Octocat's GPG Key @@ -106594,9 +109610,9 @@ paths: description: Response content: application/json: - schema: *668 + schema: *669 examples: - default: &669 + default: &670 value: id: 3 name: Octocat's GPG Key @@ -106653,7 +109669,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &670 + - &671 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -106665,9 +109681,9 @@ paths: description: Response content: application/json: - schema: *668 + schema: *669 examples: - default: *669 + default: *670 '404': *6 '304': *35 '403': *27 @@ -106690,7 +109706,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *670 + - *671 responses: '204': description: Response @@ -107148,7 +110164,7 @@ paths: application/json: schema: type: array - items: &671 + items: &672 title: Key description: Key type: object @@ -107251,9 +110267,9 @@ paths: description: Response content: application/json: - schema: *671 + schema: *672 examples: - default: &672 + default: &673 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -107292,9 +110308,9 @@ paths: description: Response content: application/json: - schema: *671 + schema: *672 examples: - default: *672 + default: *673 '404': *6 '304': *35 '403': *27 @@ -107350,7 +110366,7 @@ paths: application/json: schema: type: array - items: &673 + items: &674 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -107429,7 +110445,7 @@ paths: - account - plan examples: - default: &674 + default: &675 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -107491,9 +110507,9 @@ paths: application/json: schema: type: array - items: *673 + items: *674 examples: - default: *674 + default: *675 headers: Link: *66 '304': *35 @@ -108511,7 +111527,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *248 - - *675 + - *676 responses: '204': description: Response @@ -108624,7 +111640,7 @@ paths: - docker - nuget - container - - *676 + - *677 - *19 - *17 responses: @@ -108636,8 +111652,8 @@ paths: type: array items: *253 examples: - default: *677 - '400': *678 + default: *678 + '400': *679 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108666,7 +111682,7 @@ paths: application/json: schema: *253 examples: - default: &698 + default: &699 value: id: 40201 name: octo-name @@ -109028,9 +112044,9 @@ paths: application/json: schema: type: array - items: *667 + items: *668 examples: - default: *679 + default: *680 headers: Link: *66 '304': *35 @@ -109143,7 +112159,7 @@ paths: type: array items: *78 examples: - default: &686 + default: &687 summary: Default response value: - id: 1296269 @@ -109504,7 +112520,7 @@ paths: type: array items: *528 examples: - default: *680 + default: *681 headers: Link: *66 '304': *35 @@ -109584,7 +112600,7 @@ paths: application/json: schema: type: array - items: &681 + items: &682 title: Social account description: Social media account type: object @@ -109601,7 +112617,7 @@ paths: - provider - url examples: - default: &682 + default: &683 value: - provider: twitter url: https://twitter.com/github @@ -109664,9 +112680,9 @@ paths: application/json: schema: type: array - items: *681 + items: *682 examples: - default: *682 + default: *683 '422': *15 '304': *35 '404': *6 @@ -109754,7 +112770,7 @@ paths: application/json: schema: type: array - items: &683 + items: &684 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -109774,7 +112790,7 @@ paths: - title - created_at examples: - default: &716 + default: &717 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -109839,9 +112855,9 @@ paths: description: Response content: application/json: - schema: *683 + schema: *684 examples: - default: &684 + default: &685 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -109871,7 +112887,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &685 + - &686 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -109883,9 +112899,9 @@ paths: description: Response content: application/json: - schema: *683 + schema: *684 examples: - default: *684 + default: *685 '404': *6 '304': *35 '403': *27 @@ -109908,7 +112924,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *685 + - *686 responses: '204': description: Response @@ -109937,7 +112953,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &717 + - &718 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -109962,11 +112978,11 @@ paths: type: array items: *78 examples: - default-response: *686 + default-response: *687 application/vnd.github.v3.star+json: schema: type: array - items: &718 + items: &719 title: Starred Repository description: Starred Repository type: object @@ -110335,10 +113351,10 @@ paths: application/json: schema: oneOf: - - *662 - - *687 + - *663 + - *688 examples: - default-response: &691 + default-response: &692 summary: Default response value: login: octocat @@ -110373,7 +113389,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &692 + response-with-git-hub-plan-information: &693 summary: Response with GitHub plan information value: login: octocat @@ -110430,7 +113446,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &689 + - &690 name: user_id description: The unique identifier of the user. in: path @@ -110496,7 +113512,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *688 + - *689 - *17 responses: '200': @@ -110531,7 +113547,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *689 + - *690 - *271 requestBody: required: true @@ -110606,7 +113622,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *690 + schema: *691 examples: table_view: summary: Response for creating a table view @@ -110658,11 +113674,11 @@ paths: application/json: schema: oneOf: - - *662 - - *687 + - *663 + - *688 examples: - default-response: *691 - response-with-git-hub-plan-information: *692 + default-response: *692 + response-with-git-hub-plan-information: *693 '404': *6 x-github: githubCloudOnly: false @@ -110712,8 +113728,8 @@ paths: required: - subject_digests examples: - default: *693 - withPredicateType: *694 + default: *694 + withPredicateType: *695 responses: '200': description: Response @@ -110753,7 +113769,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *695 + default: *696 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111226,7 +114242,7 @@ paths: application/json: schema: *187 examples: - default: &696 + default: &697 summary: Example response for a user copilot space value: id: 42 @@ -111327,7 +114343,7 @@ paths: application/json: schema: *187 examples: - default: *696 + default: *697 '403': *27 '404': *6 x-github: @@ -111453,7 +114469,7 @@ paths: application/json: schema: *187 examples: - default: *696 + default: *697 '403': *27 '404': *6 '422': *15 @@ -112221,7 +115237,7 @@ paths: type: array items: *253 examples: - default: *677 + default: *678 '403': *27 '401': *23 x-github: @@ -112605,9 +115621,9 @@ paths: application/json: schema: type: array - items: *668 + items: *669 examples: - default: *697 + default: *698 headers: Link: *66 x-github: @@ -112836,7 +115852,7 @@ paths: - docker - nuget - container - - *676 + - *677 - *70 - *19 - *17 @@ -112849,10 +115865,10 @@ paths: type: array items: *253 examples: - default: *677 + default: *678 '403': *27 '401': *23 - '400': *678 + '400': *679 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112882,7 +115898,7 @@ paths: application/json: schema: *253 examples: - default: *698 + default: *699 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -113231,7 +116247,7 @@ paths: type: array items: *274 examples: - default: *699 + default: *700 headers: Link: *66 '304': *35 @@ -113291,7 +116307,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *700 + items: *701 required: - name - data_type @@ -113307,7 +116323,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *701 + iteration_configuration: *702 required: - name - data_type @@ -113329,8 +116345,8 @@ paths: value: name: Due date data_type: date - single_select_field: *702 - iteration_field: *703 + single_select_field: *703 + iteration_field: *704 responses: '201': description: Response @@ -113338,11 +116354,11 @@ paths: application/json: schema: *274 examples: - text_field: *704 - number_field: *705 - date_field: *706 - single_select_field: *707 - iteration_field: *708 + text_field: *705 + number_field: *706 + date_field: *707 + single_select_field: *708 + iteration_field: *709 '304': *35 '403': *27 '401': *23 @@ -113364,7 +116380,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *271 - - *709 + - *710 - *70 responses: '200': @@ -113373,7 +116389,7 @@ paths: application/json: schema: *274 examples: - default: *710 + default: *711 headers: Link: *66 '304': *35 @@ -113730,7 +116746,7 @@ paths: parameters: - *271 - *70 - - *711 + - *712 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -114005,7 +117021,7 @@ paths: - *116 - *118 - *117 - - *712 + - *713 - *119 responses: '200': @@ -114136,7 +117152,7 @@ paths: parameters: - *70 - *116 - - *713 + - *714 - *117 responses: '200': @@ -114235,9 +117251,9 @@ paths: - *116 - *118 - *117 - - *714 - - *119 - *715 + - *119 + - *716 responses: '200': description: Response when getting a billing usage summary @@ -114371,9 +117387,9 @@ paths: application/json: schema: type: array - items: *681 + items: *682 examples: - default: *682 + default: *683 headers: Link: *66 x-github: @@ -114403,9 +117419,9 @@ paths: application/json: schema: type: array - items: *683 + items: *684 examples: - default: *716 + default: *717 headers: Link: *66 x-github: @@ -114430,7 +117446,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *70 - - *717 + - *718 - *60 - *17 - *19 @@ -114442,11 +117458,11 @@ paths: schema: anyOf: - type: array - items: *718 + items: *719 - type: array items: *78 examples: - default-response: *686 + default-response: *687 headers: Link: *66 x-github: @@ -114606,7 +117622,7 @@ webhooks: type: string enum: - disabled - enterprise: &719 + enterprise: &720 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -114675,7 +117691,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &720 + installation: &721 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -114696,7 +117712,7 @@ webhooks: required: - id - node_id - organization: &721 + organization: &722 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -114769,7 +117785,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &722 + repository: &723 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -115684,10 +118700,10 @@ webhooks: type: string enum: - enabled - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -115763,11 +118779,11 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - rule: &723 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + rule: &724 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -115990,11 +119006,11 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - rule: *723 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + rule: *724 sender: *4 required: - action @@ -116182,11 +119198,11 @@ webhooks: - everyone required: - from - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - rule: *723 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + rule: *724 sender: *4 required: - action @@ -116270,7 +119286,7 @@ webhooks: type: string enum: - completed - check_run: &725 + check_run: &726 title: CheckRun description: A check performed on the code of a given code change type: object @@ -116380,7 +119396,7 @@ webhooks: - examples: - neutral - deployment: *724 + deployment: *725 details_url: type: string examples: @@ -116478,10 +119494,10 @@ webhooks: - output - app - pull_requests - installation: *720 - enterprise: *719 - organization: *721 - repository: *722 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 sender: *4 required: - check_run @@ -116872,11 +119888,11 @@ webhooks: type: string enum: - created - check_run: *725 - installation: *720 - enterprise: *719 - organization: *721 - repository: *722 + check_run: *726 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 sender: *4 required: - check_run @@ -117270,11 +120286,11 @@ webhooks: type: string enum: - requested_action - check_run: *725 - installation: *720 - enterprise: *719 - organization: *721 - repository: *722 + check_run: *726 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 requested_action: description: The action requested by the user. type: object @@ -117677,11 +120693,11 @@ webhooks: type: string enum: - rerequested - check_run: *725 - installation: *720 - enterprise: *719 - organization: *721 - repository: *722 + check_run: *726 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 sender: *4 required: - check_run @@ -118666,10 +121682,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -119373,10 +122389,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -120074,10 +123090,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -120398,20 +123414,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &726 + commit_oid: &727 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *719 - installation: *720 - organization: *721 - ref: &727 + enterprise: *720 + installation: *721 + organization: *722 + ref: &728 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *722 + repository: *723 sender: *4 required: - action @@ -120819,12 +123835,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *726 - enterprise: *719 - installation: *720 - organization: *721 - ref: *727 - repository: *722 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -121107,12 +124123,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *726 - enterprise: *719 - installation: *720 - organization: *721 - ref: *727 - repository: *722 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -121458,12 +124474,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *726 - enterprise: *719 - installation: *720 - organization: *721 - ref: *727 - repository: *722 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -121753,9 +124769,9 @@ webhooks: type: - string - 'null' - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -121763,7 +124779,7 @@ webhooks: type: - string - 'null' - repository: *722 + repository: *723 sender: *4 required: - action @@ -122009,12 +125025,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *726 - enterprise: *719 - installation: *720 - organization: *721 - ref: *727 - repository: *722 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -122335,10 +125351,10 @@ webhooks: - dismissed_reason - rule - tool - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122598,10 +125614,10 @@ webhooks: - updated_at - author_association - body - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122682,18 +125698,18 @@ webhooks: type: - string - 'null' - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *721 - pusher_type: &728 + organization: *722 + pusher_type: &729 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &729 + ref: &730 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -122703,7 +125719,7 @@ webhooks: enum: - tag - branch - repository: *722 + repository: *723 sender: *4 required: - ref @@ -122786,9 +125802,9 @@ webhooks: enum: - created definition: *282 - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -122873,9 +125889,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -122953,9 +125969,9 @@ webhooks: enum: - promote_to_enterprise definition: *282 - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -123033,9 +126049,9 @@ webhooks: enum: - updated definition: *282 - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -123112,10 +126128,10 @@ webhooks: type: string enum: - updated - enterprise: *719 - installation: *720 - repository: *722 - organization: *721 + enterprise: *720 + installation: *721 + repository: *723 + organization: *722 sender: *4 new_property_values: type: array @@ -123200,18 +126216,18 @@ webhooks: title: delete event type: object properties: - enterprise: *719 - installation: *720 - organization: *721 - pusher_type: *728 - ref: *729 + enterprise: *720 + installation: *721 + organization: *722 + pusher_type: *729 + ref: *730 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *722 + repository: *723 sender: *4 required: - ref @@ -123292,10 +126308,10 @@ webhooks: enum: - assignees_changed alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -123376,10 +126392,10 @@ webhooks: enum: - auto_dismissed alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -123461,10 +126477,10 @@ webhooks: enum: - auto_reopened alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -123546,10 +126562,10 @@ webhooks: enum: - created alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -123629,10 +126645,10 @@ webhooks: enum: - dismissed alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -123712,10 +126728,10 @@ webhooks: enum: - fixed alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -123796,10 +126812,10 @@ webhooks: enum: - reintroduced alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -123879,10 +126895,10 @@ webhooks: enum: - reopened alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -123959,9 +126975,9 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - key: &730 + enterprise: *720 + installation: *721 + key: &731 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -123999,8 +127015,8 @@ webhooks: - verified - created_at - read_only - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -124077,11 +127093,11 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - key: *730 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + key: *731 + organization: *722 + repository: *723 sender: *4 required: - action @@ -124648,12 +127664,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: &734 + workflow: &735 title: Workflow type: - object @@ -125408,9 +128424,9 @@ webhooks: pull_requests: type: array items: *575 - repository: *722 - organization: *721 - installation: *720 + repository: *723 + organization: *722 + installation: *721 sender: *4 responses: '200': @@ -125481,7 +128497,7 @@ webhooks: type: string enum: - approved - approver: &731 + approver: &732 type: object properties: avatar_url: @@ -125524,11 +128540,11 @@ webhooks: type: string comment: type: string - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - reviewers: &732 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + reviewers: &733 type: array items: type: object @@ -125609,7 +128625,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &733 + workflow_job_run: &734 type: object properties: conclusion: @@ -126355,18 +129371,18 @@ webhooks: type: string enum: - rejected - approver: *731 + approver: *732 comment: type: string - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - reviewers: *732 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + reviewers: *733 sender: *4 since: type: string - workflow_job_run: *733 + workflow_job_run: *734 workflow_job_runs: type: array items: @@ -127083,13 +130099,13 @@ webhooks: type: string enum: - requested - enterprise: *719 + enterprise: *720 environment: type: string - installation: *720 - organization: *721 - repository: *722 - requestor: &739 + installation: *721 + organization: *722 + repository: *723 + requestor: &740 title: User type: - object @@ -129022,12 +132038,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *734 + workflow: *735 workflow_run: title: Deployment Workflow Run type: @@ -129718,7 +132734,7 @@ webhooks: type: string enum: - answered - answer: &737 + answer: &738 type: object properties: author_association: @@ -129878,11 +132894,11 @@ webhooks: - created_at - updated_at - body - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -130009,11 +133025,11 @@ webhooks: - from required: - category - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -130096,11 +133112,11 @@ webhooks: type: string enum: - closed - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -130182,7 +133198,7 @@ webhooks: type: string enum: - created - comment: &736 + comment: &737 type: object properties: author_association: @@ -130342,11 +133358,11 @@ webhooks: - updated_at - body - reactions - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -130429,12 +133445,12 @@ webhooks: type: string enum: - deleted - comment: *736 - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + comment: *737 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -130529,12 +133545,12 @@ webhooks: - from required: - body - comment: *736 - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + comment: *737 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -130618,11 +133634,11 @@ webhooks: type: string enum: - created - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -130704,11 +133720,11 @@ webhooks: type: string enum: - deleted - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -130808,11 +133824,11 @@ webhooks: type: string required: - from - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -130894,10 +133910,10 @@ webhooks: type: string enum: - labeled - discussion: *735 - enterprise: *719 - installation: *720 - label: &738 + discussion: *736 + enterprise: *720 + installation: *721 + label: &739 title: Label type: object properties: @@ -130930,8 +133946,8 @@ webhooks: - color - default - description - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131014,11 +134030,11 @@ webhooks: type: string enum: - locked - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131100,11 +134116,11 @@ webhooks: type: string enum: - pinned - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131186,11 +134202,11 @@ webhooks: type: string enum: - reopened - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131275,16 +134291,16 @@ webhooks: changes: type: object properties: - new_discussion: *735 - new_repository: *722 + new_discussion: *736 + new_repository: *723 required: - new_discussion - new_repository - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131367,10 +134383,10 @@ webhooks: type: string enum: - unanswered - discussion: *735 - old_answer: *737 - organization: *721 - repository: *722 + discussion: *736 + old_answer: *738 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131452,12 +134468,12 @@ webhooks: type: string enum: - unlabeled - discussion: *735 - enterprise: *719 - installation: *720 - label: *738 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131540,11 +134556,11 @@ webhooks: type: string enum: - unlocked - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131626,11 +134642,11 @@ webhooks: type: string enum: - unpinned - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131703,7 +134719,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *719 + enterprise: *720 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -132381,9 +135397,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - forkee @@ -132529,9 +135545,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pages: description: The pages that were updated. type: array @@ -132569,7 +135585,7 @@ webhooks: - action - sha - html_url - repository: *722 + repository: *723 sender: *4 required: - pages @@ -132645,10 +135661,10 @@ webhooks: type: string enum: - created - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories: &740 + organization: *722 + repositories: &741 description: An array of repository objects that the installation can access. type: array @@ -132674,8 +135690,8 @@ webhooks: - name - full_name - private - repository: *722 - requester: *739 + repository: *723 + requester: *740 sender: *4 required: - action @@ -132750,11 +135766,11 @@ webhooks: type: string enum: - deleted - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories: *740 - repository: *722 + organization: *722 + repositories: *741 + repository: *723 requester: type: - 'null' @@ -132831,11 +135847,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories: *740 - repository: *722 + organization: *722 + repositories: *741 + repository: *723 requester: type: - 'null' @@ -132912,10 +135928,10 @@ webhooks: type: string enum: - added - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories_added: &741 + organization: *722 + repositories_added: &742 description: An array of repository objects, which were added to the installation. type: array @@ -132961,15 +135977,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *722 - repository_selection: &742 + repository: *723 + repository_selection: &743 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *739 + requester: *740 sender: *4 required: - action @@ -133048,10 +136064,10 @@ webhooks: type: string enum: - removed - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories_added: *741 + organization: *722 + repositories_added: *742 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -133078,9 +136094,9 @@ webhooks: - name - full_name - private - repository: *722 - repository_selection: *742 - requester: *739 + repository: *723 + repository_selection: *743 + requester: *740 sender: *4 required: - action @@ -133159,11 +136175,11 @@ webhooks: type: string enum: - suspend - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories: *740 - repository: *722 + organization: *722 + repositories: *741 + repository: *723 requester: type: - 'null' @@ -133345,10 +136361,10 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 target_type: type: string @@ -133427,11 +136443,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories: *740 - repository: *722 + organization: *722 + repositories: *741 + repository: *723 requester: type: - 'null' @@ -133683,8 +136699,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -134496,8 +137512,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134858,8 +137874,8 @@ webhooks: - state - locked - assignee - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -134939,7 +137955,7 @@ webhooks: type: string enum: - deleted - comment: &743 + comment: &744 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -135110,8 +138126,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -135919,8 +138935,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136283,8 +139299,8 @@ webhooks: - state - locked - assignee - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -136364,7 +139380,7 @@ webhooks: type: string enum: - edited - changes: &767 + changes: &768 description: The changes to the comment. type: object properties: @@ -136376,9 +139392,9 @@ webhooks: type: string required: - from - comment: *743 - enterprise: *719 - installation: *720 + comment: *744 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -137189,8 +140205,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137551,8 +140567,8 @@ webhooks: - state - locked - assignee - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -137633,9 +140649,9 @@ webhooks: type: string enum: - pinned - comment: *743 - enterprise: *719 - installation: *720 + comment: *744 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -138448,8 +141464,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138812,8 +141828,8 @@ webhooks: - state - locked - assignee - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -138893,9 +141909,9 @@ webhooks: type: string enum: - unpinned - comment: *743 - enterprise: *719 - installation: *720 + comment: *744 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -139708,8 +142724,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140072,8 +143088,8 @@ webhooks: - state - locked - assignee - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -140162,9 +143178,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -140253,9 +143269,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -140343,9 +143359,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -140434,9 +143450,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -140516,10 +143532,10 @@ webhooks: type: string enum: - assigned - assignee: *739 - enterprise: *719 - installation: *720 - issue: &744 + assignee: *740 + enterprise: *720 + installation: *721 + issue: &745 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -141330,8 +144346,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -141454,8 +144470,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -141535,8 +144551,8 @@ webhooks: type: string enum: - closed - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -142352,8 +145368,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -142619,8 +145635,8 @@ webhooks: required: - state - closed_at - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -142699,8 +145715,8 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -143507,8 +146523,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -143630,8 +146646,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -143710,8 +146726,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144541,8 +147557,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -144643,7 +147659,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &745 + milestone: &746 title: Milestone description: A collection of related issues and pull requests. type: object @@ -144786,8 +147802,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -144886,8 +147902,8 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -145698,8 +148714,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -145822,9 +148838,9 @@ webhooks: - active_lock_reason - body - reactions - label: *738 - organization: *721 - repository: *722 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -145904,9 +148920,9 @@ webhooks: type: string enum: - field_added - enterprise: *719 - installation: *720 - issue: *744 + enterprise: *720 + installation: *721 + issue: *745 issue_field: type: object description: The issue field whose value was set or updated on the @@ -146025,8 +149041,8 @@ webhooks: - id required: - from - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -146106,9 +149122,9 @@ webhooks: type: string enum: - field_removed - enterprise: *719 - installation: *720 - issue: *744 + enterprise: *720 + installation: *721 + issue: *745 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -146171,8 +149187,8 @@ webhooks: - 'null' required: - id - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -146252,8 +149268,8 @@ webhooks: type: string enum: - labeled - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147063,8 +150079,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -147187,9 +150203,9 @@ webhooks: - active_lock_reason - body - reactions - label: *738 - organization: *721 - repository: *722 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147269,8 +150285,8 @@ webhooks: type: string enum: - locked - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -148105,8 +151121,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -148206,8 +151222,8 @@ webhooks: format: uri user_view_type: type: string - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -148286,8 +151302,8 @@ webhooks: type: string enum: - milestoned - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -149116,8 +152132,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -149217,9 +152233,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *745 - organization: *721 - repository: *722 + milestone: *746 + organization: *722 + repository: *723 sender: *4 required: - action @@ -150106,8 +153122,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -150702,8 +153718,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -151510,8 +154526,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -151637,8 +154653,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -151718,9 +154734,9 @@ webhooks: type: string enum: - pinned - enterprise: *719 - installation: *720 - issue: &746 + enterprise: *720 + installation: *721 + issue: &747 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -152525,8 +155541,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -152648,8 +155664,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -152728,8 +155744,8 @@ webhooks: type: string enum: - reopened - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -153562,8 +156578,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -153664,8 +156680,8 @@ webhooks: user_view_type: type: string type: *236 - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -154553,8 +157569,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -155167,11 +158183,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *719 - installation: *720 - issue: *746 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + issue: *747 + organization: *722 + repository: *723 sender: *4 required: - action @@ -155251,12 +158267,12 @@ webhooks: type: string enum: - typed - enterprise: *719 - installation: *720 - issue: *744 + enterprise: *720 + installation: *721 + issue: *745 type: *236 - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -155337,7 +158353,7 @@ webhooks: type: string enum: - unassigned - assignee: &770 + assignee: &771 title: User type: - object @@ -155409,11 +158425,11 @@ webhooks: required: - login - id - enterprise: *719 - installation: *720 - issue: *744 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + issue: *745 + organization: *722 + repository: *723 sender: *4 required: - action @@ -155492,12 +158508,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *719 - installation: *720 - issue: *744 - label: *738 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + issue: *745 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -155577,8 +158593,8 @@ webhooks: type: string enum: - unlocked - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -156411,8 +159427,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -156512,8 +159528,8 @@ webhooks: format: uri user_view_type: type: string - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -156593,11 +159609,11 @@ webhooks: type: string enum: - unpinned - enterprise: *719 - installation: *720 - issue: *746 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + issue: *747 + organization: *722 + repository: *723 sender: *4 required: - action @@ -156676,12 +159692,12 @@ webhooks: type: string enum: - untyped - enterprise: *719 - installation: *720 - issue: *744 + enterprise: *720 + installation: *721 + issue: *745 type: *236 - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -156761,11 +159777,11 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - label: *738 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -156843,11 +159859,11 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - label: *738 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -156957,11 +159973,11 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - label: *738 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -157043,9 +160059,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *719 - installation: *720 - marketplace_purchase: &747 + enterprise: *720 + installation: *721 + marketplace_purchase: &748 title: Marketplace Purchase type: object required: @@ -157133,8 +160149,8 @@ webhooks: type: integer unit_count: type: integer - organization: *721 - previous_marketplace_purchase: &748 + organization: *722 + previous_marketplace_purchase: &749 title: Marketplace Purchase type: object properties: @@ -157218,7 +160234,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *722 + repository: *723 sender: *4 required: - action @@ -157298,10 +160314,10 @@ webhooks: - changed effective_date: type: string - enterprise: *719 - installation: *720 - marketplace_purchase: *747 - organization: *721 + enterprise: *720 + installation: *721 + marketplace_purchase: *748 + organization: *722 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -157389,7 +160405,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *722 + repository: *723 sender: *4 required: - action @@ -157471,10 +160487,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *719 - installation: *720 - marketplace_purchase: *747 - organization: *721 + enterprise: *720 + installation: *721 + marketplace_purchase: *748 + organization: *722 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -157560,7 +160576,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *722 + repository: *723 sender: *4 required: - action @@ -157641,8 +160657,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 marketplace_purchase: title: Marketplace Purchase type: object @@ -157728,9 +160744,9 @@ webhooks: type: integer unit_count: type: integer - organization: *721 - previous_marketplace_purchase: *748 - repository: *722 + organization: *722 + previous_marketplace_purchase: *749 + repository: *723 sender: *4 required: - action @@ -157810,12 +160826,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *719 - installation: *720 - marketplace_purchase: *747 - organization: *721 - previous_marketplace_purchase: *748 - repository: *722 + enterprise: *720 + installation: *721 + marketplace_purchase: *748 + organization: *722 + previous_marketplace_purchase: *749 + repository: *723 sender: *4 required: - action @@ -157917,11 +160933,11 @@ webhooks: type: string required: - to - enterprise: *719 - installation: *720 - member: *739 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 sender: *4 required: - action @@ -158023,11 +161039,11 @@ webhooks: type: - string - 'null' - enterprise: *719 - installation: *720 - member: *739 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 sender: *4 required: - action @@ -158106,11 +161122,11 @@ webhooks: type: string enum: - removed - enterprise: *719 - installation: *720 - member: *739 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 sender: *4 required: - action @@ -158188,11 +161204,11 @@ webhooks: type: string enum: - added - enterprise: *719 - installation: *720 - member: *739 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 scope: description: The scope of the membership. Currently, can only be `team`. @@ -158270,7 +161286,7 @@ webhooks: required: - login - id - team: &749 + team: &750 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -158500,11 +161516,11 @@ webhooks: type: string enum: - removed - enterprise: *719 - installation: *720 - member: *739 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 scope: description: The scope of the membership. Currently, can only be `team`. @@ -158583,7 +161599,7 @@ webhooks: required: - login - id - team: *749 + team: *750 required: - action - scope @@ -158665,8 +161681,8 @@ webhooks: type: string enum: - checks_requested - installation: *720 - merge_group: &750 + installation: *721 + merge_group: &751 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -158692,8 +161708,8 @@ webhooks: - base_sha - base_ref - head_commit - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -158779,10 +161795,10 @@ webhooks: - merged - invalidated - dequeued - installation: *720 - merge_group: *750 - organization: *721 - repository: *722 + installation: *721 + merge_group: *751 + organization: *722 + repository: *723 sender: *4 required: - action @@ -158855,7 +161871,7 @@ webhooks: type: string enum: - deleted - enterprise: *719 + enterprise: *720 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -158964,12 +161980,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *720 - organization: *721 + installation: *721 + organization: *722 repository: anyOf: - type: 'null' - - *722 + - *723 sender: *4 required: - action @@ -159049,11 +162065,11 @@ webhooks: type: string enum: - closed - enterprise: *719 - installation: *720 - milestone: *745 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + milestone: *746 + organization: *722 + repository: *723 sender: *4 required: - action @@ -159132,9 +162148,9 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - milestone: &751 + enterprise: *720 + installation: *721 + milestone: &752 title: Milestone description: A collection of related issues and pull requests. type: object @@ -159276,8 +162292,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -159356,11 +162372,11 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - milestone: *745 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + milestone: *746 + organization: *722 + repository: *723 sender: *4 required: - action @@ -159470,11 +162486,11 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - milestone: *745 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + milestone: *746 + organization: *722 + repository: *723 sender: *4 required: - action @@ -159554,11 +162570,11 @@ webhooks: type: string enum: - opened - enterprise: *719 - installation: *720 - milestone: *751 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + milestone: *752 + organization: *722 + repository: *723 sender: *4 required: - action @@ -159637,11 +162653,11 @@ webhooks: type: string enum: - blocked - blocked_user: *739 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + blocked_user: *740 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -159720,11 +162736,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *739 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + blocked_user: *740 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -159803,9 +162819,9 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - membership: &752 + enterprise: *720 + installation: *721 + membership: &753 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -159915,8 +162931,8 @@ webhooks: - role - organization_url - user - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -159994,11 +163010,11 @@ webhooks: type: string enum: - member_added - enterprise: *719 - installation: *720 - membership: *752 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + membership: *753 + organization: *722 + repository: *723 sender: *4 required: - action @@ -160077,8 +163093,8 @@ webhooks: type: string enum: - member_invited - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -160200,10 +163216,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 - user: *739 + user: *740 required: - action - invitation @@ -160281,11 +163297,11 @@ webhooks: type: string enum: - member_removed - enterprise: *719 - installation: *720 - membership: *752 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + membership: *753 + organization: *722 + repository: *723 sender: *4 required: - action @@ -160372,11 +163388,11 @@ webhooks: properties: from: type: string - enterprise: *719 - installation: *720 - membership: *752 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + membership: *753 + organization: *722 + repository: *723 sender: *4 required: - action @@ -160453,9 +163469,9 @@ webhooks: type: string enum: - published - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 package: description: Information about the package. type: object @@ -160978,7 +163994,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &753 + items: &754 title: Ruby Gems metadata type: object properties: @@ -161075,7 +164091,7 @@ webhooks: - owner - package_version - registry - repository: *722 + repository: *723 sender: *4 required: - action @@ -161151,9 +164167,9 @@ webhooks: type: string enum: - updated - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 package: description: Information about the package. type: object @@ -161515,7 +164531,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *753 + items: *754 source_url: type: string format: uri @@ -161586,7 +164602,7 @@ webhooks: - owner - package_version - registry - repository: *722 + repository: *723 sender: *4 required: - action @@ -161766,12 +164782,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *719 + enterprise: *720 id: type: integer - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - id @@ -161848,7 +164864,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &754 + personal_access_token_request: &755 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -161998,10 +165014,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *719 - organization: *721 + enterprise: *720 + organization: *722 sender: *4 - installation: *720 + installation: *721 required: - action - personal_access_token_request @@ -162078,11 +165094,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *754 - enterprise: *719 - organization: *721 + personal_access_token_request: *755 + enterprise: *720 + organization: *722 sender: *4 - installation: *720 + installation: *721 required: - action - personal_access_token_request @@ -162158,11 +165174,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *754 - enterprise: *719 - organization: *721 + personal_access_token_request: *755 + enterprise: *720 + organization: *722 sender: *4 - installation: *720 + installation: *721 required: - action - personal_access_token_request @@ -162237,11 +165253,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *754 - organization: *721 - enterprise: *719 + personal_access_token_request: *755 + organization: *722 + enterprise: *720 sender: *4 - installation: *720 + installation: *721 required: - action - personal_access_token_request @@ -162346,7 +165362,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *755 + last_response: *756 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -162378,8 +165394,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 zen: description: Random string of GitHub zen. @@ -162624,10 +165640,10 @@ webhooks: - from required: - note - enterprise: *719 - installation: *720 - organization: *721 - project_card: &756 + enterprise: *720 + installation: *721 + organization: *722 + project_card: &757 title: Project Card type: object properties: @@ -162750,7 +165766,7 @@ webhooks: - creator - created_at - updated_at - repository: *722 + repository: *723 sender: *4 required: - action @@ -162831,11 +165847,11 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - project_card: *756 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project_card: *757 + repository: *723 sender: *4 required: - action @@ -162915,9 +165931,9 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 project_card: title: Project Card type: object @@ -163047,7 +166063,7 @@ webhooks: repository: anyOf: - type: 'null' - - *722 + - *723 sender: *4 required: - action @@ -163141,11 +166157,11 @@ webhooks: - from required: - note - enterprise: *719 - installation: *720 - organization: *721 - project_card: *756 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project_card: *757 + repository: *723 sender: *4 required: - action @@ -163239,9 +166255,9 @@ webhooks: - from required: - column_id - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 project_card: allOf: - title: Project Card @@ -163438,7 +166454,7 @@ webhooks: type: string required: - after_id - repository: *722 + repository: *723 sender: *4 required: - action @@ -163518,10 +166534,10 @@ webhooks: type: string enum: - closed - enterprise: *719 - installation: *720 - organization: *721 - project: &758 + enterprise: *720 + installation: *721 + organization: *722 + project: &759 title: Project type: object properties: @@ -163648,7 +166664,7 @@ webhooks: - creator - created_at - updated_at - repository: *722 + repository: *723 sender: *4 required: - action @@ -163728,10 +166744,10 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - project_column: &757 + enterprise: *720 + installation: *721 + organization: *722 + project_column: &758 title: Project Column type: object properties: @@ -163771,7 +166787,7 @@ webhooks: - name - created_at - updated_at - repository: *722 + repository: *723 sender: *4 required: - action @@ -163850,14 +166866,14 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - project_column: *757 + enterprise: *720 + installation: *721 + organization: *722 + project_column: *758 repository: anyOf: - type: 'null' - - *722 + - *723 sender: *4 required: - action @@ -163946,11 +166962,11 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - organization: *721 - project_column: *757 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project_column: *758 + repository: *723 sender: *4 required: - action @@ -164030,11 +167046,11 @@ webhooks: type: string enum: - moved - enterprise: *719 - installation: *720 - organization: *721 - project_column: *757 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project_column: *758 + repository: *723 sender: *4 required: - action @@ -164114,11 +167130,11 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - project: *758 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project: *759 + repository: *723 sender: *4 required: - action @@ -164198,14 +167214,14 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - project: *758 + enterprise: *720 + installation: *721 + organization: *722 + project: *759 repository: anyOf: - type: 'null' - - *722 + - *723 sender: *4 required: - action @@ -164306,11 +167322,11 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - organization: *721 - project: *758 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project: *759 + repository: *723 sender: *4 required: - action @@ -164389,11 +167405,11 @@ webhooks: type: string enum: - reopened - enterprise: *719 - installation: *720 - organization: *721 - project: *758 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project: *759 + repository: *723 sender: *4 required: - action @@ -164474,8 +167490,8 @@ webhooks: type: string enum: - closed - installation: *720 - organization: *721 + installation: *721 + organization: *722 projects_v2: *269 sender: *4 required: @@ -164557,8 +167573,8 @@ webhooks: type: string enum: - created - installation: *720 - organization: *721 + installation: *721 + organization: *722 projects_v2: *269 sender: *4 required: @@ -164640,8 +167656,8 @@ webhooks: type: string enum: - deleted - installation: *720 - organization: *721 + installation: *721 + organization: *722 projects_v2: *269 sender: *4 required: @@ -164763,8 +167779,8 @@ webhooks: type: string to: type: string - installation: *720 - organization: *721 + installation: *721 + organization: *722 projects_v2: *269 sender: *4 required: @@ -164848,7 +167864,7 @@ webhooks: type: string enum: - archived - changes: &762 + changes: &763 type: object properties: archived_at: @@ -164864,9 +167880,9 @@ webhooks: - string - 'null' format: date-time - installation: *720 - organization: *721 - projects_v2_item: &759 + installation: *721 + organization: *722 + projects_v2_item: &760 title: Projects v2 Item description: An item belonging to a project type: object @@ -165006,9 +168022,9 @@ webhooks: - 'null' to: type: string - installation: *720 - organization: *721 - projects_v2_item: *759 + installation: *721 + organization: *722 + projects_v2_item: *760 sender: *4 required: - action @@ -165090,9 +168106,9 @@ webhooks: type: string enum: - created - installation: *720 - organization: *721 - projects_v2_item: *759 + installation: *721 + organization: *722 + projects_v2_item: *760 sender: *4 required: - action @@ -165173,9 +168189,9 @@ webhooks: type: string enum: - deleted - installation: *720 - organization: *721 - projects_v2_item: *759 + installation: *721 + organization: *722 + projects_v2_item: *760 sender: *4 required: - action @@ -165280,7 +168296,7 @@ webhooks: oneOf: - type: string - type: integer - - &760 + - &761 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -165304,7 +168320,7 @@ webhooks: required: - id - name - - &761 + - &762 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -165344,8 +168360,8 @@ webhooks: oneOf: - type: string - type: integer - - *760 - *761 + - *762 type: - 'null' - string @@ -165368,9 +168384,9 @@ webhooks: - 'null' required: - body - installation: *720 - organization: *721 - projects_v2_item: *759 + installation: *721 + organization: *722 + projects_v2_item: *760 sender: *4 required: - action @@ -165467,9 +168483,9 @@ webhooks: type: - string - 'null' - installation: *720 - organization: *721 - projects_v2_item: *759 + installation: *721 + organization: *722 + projects_v2_item: *760 sender: *4 required: - action @@ -165552,10 +168568,10 @@ webhooks: type: string enum: - restored - changes: *762 - installation: *720 - organization: *721 - projects_v2_item: *759 + changes: *763 + installation: *721 + organization: *722 + projects_v2_item: *760 sender: *4 required: - action @@ -165637,8 +168653,8 @@ webhooks: type: string enum: - reopened - installation: *720 - organization: *721 + installation: *721 + organization: *722 projects_v2: *269 sender: *4 required: @@ -165720,9 +168736,9 @@ webhooks: type: string enum: - created - installation: *720 - organization: *721 - projects_v2_status_update: *763 + installation: *721 + organization: *722 + projects_v2_status_update: *764 sender: *4 required: - action @@ -165803,9 +168819,9 @@ webhooks: type: string enum: - deleted - installation: *720 - organization: *721 - projects_v2_status_update: *763 + installation: *721 + organization: *722 + projects_v2_status_update: *764 sender: *4 required: - action @@ -165951,9 +168967,9 @@ webhooks: - string - 'null' format: date - installation: *720 - organization: *721 - projects_v2_status_update: *763 + installation: *721 + organization: *722 + projects_v2_status_update: *764 sender: *4 required: - action @@ -166024,10 +169040,10 @@ webhooks: title: public event type: object properties: - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - repository @@ -166104,13 +169120,13 @@ webhooks: type: string enum: - assigned - assignee: *739 - enterprise: *719 - installation: *720 - number: &764 + assignee: *740 + enterprise: *720 + installation: *721 + number: &765 description: The pull request number. type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -168462,7 +171478,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -168544,11 +171560,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -170893,7 +173909,7 @@ webhooks: - draft reason: type: string - repository: *722 + repository: *723 sender: *4 required: - action @@ -170975,11 +173991,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -173324,7 +176340,7 @@ webhooks: - draft reason: type: string - repository: *722 + repository: *723 sender: *4 required: - action @@ -173406,11 +176422,11 @@ webhooks: type: string enum: - closed - enterprise: *719 - installation: *720 - number: *764 - organization: *721 - pull_request: &765 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 + pull_request: &766 allOf: - *575 - type: object @@ -173474,7 +176490,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *722 + repository: *723 sender: *4 required: - action @@ -173555,12 +176571,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *719 - installation: *720 - number: *764 - organization: *721 - pull_request: *765 - repository: *722 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 + pull_request: *766 + repository: *723 sender: *4 required: - action @@ -173640,11 +176656,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *719 + enterprise: *720 milestone: *272 - number: *764 - organization: *721 - pull_request: &766 + number: *765 + organization: *722 + pull_request: &767 title: Pull Request type: object properties: @@ -175988,7 +179004,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -176067,11 +179083,11 @@ webhooks: type: string enum: - dequeued - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -178434,7 +181450,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *722 + repository: *723 sender: *4 required: - action @@ -178558,12 +181574,12 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - number: *764 - organization: *721 - pull_request: *765 - repository: *722 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 + pull_request: *766 + repository: *723 sender: *4 required: - action @@ -178643,11 +181659,11 @@ webhooks: type: string enum: - enqueued - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -180995,7 +184011,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -181075,11 +184091,11 @@ webhooks: type: string enum: - labeled - enterprise: *719 - installation: *720 - label: *738 - number: *764 - organization: *721 + enterprise: *720 + installation: *721 + label: *739 + number: *765 + organization: *722 pull_request: title: Pull Request type: object @@ -183430,7 +186446,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -183511,10 +186527,10 @@ webhooks: type: string enum: - locked - enterprise: *719 - installation: *720 - number: *764 - organization: *721 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 pull_request: title: Pull Request type: object @@ -185863,7 +188879,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -185943,12 +188959,12 @@ webhooks: type: string enum: - milestoned - enterprise: *719 + enterprise: *720 milestone: *272 - number: *764 - organization: *721 - pull_request: *766 - repository: *722 + number: *765 + organization: *722 + pull_request: *767 + repository: *723 sender: *4 required: - action @@ -186027,12 +189043,12 @@ webhooks: type: string enum: - opened - enterprise: *719 - installation: *720 - number: *764 - organization: *721 - pull_request: *765 - repository: *722 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 + pull_request: *766 + repository: *723 sender: *4 required: - action @@ -186113,12 +189129,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *719 - installation: *720 - number: *764 - organization: *721 - pull_request: *765 - repository: *722 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 + pull_request: *766 + repository: *723 sender: *4 required: - action @@ -186198,12 +189214,12 @@ webhooks: type: string enum: - reopened - enterprise: *719 - installation: *720 - number: *764 - organization: *721 - pull_request: *765 - repository: *722 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 + pull_request: *766 + repository: *723 sender: *4 required: - action @@ -186578,9 +189594,9 @@ webhooks: - start_side - side - reactions - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: type: object properties: @@ -188813,7 +191829,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *722 + repository: *723 sender: *4 required: - action @@ -188893,7 +191909,7 @@ webhooks: type: string enum: - deleted - comment: &768 + comment: &769 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -189186,9 +192202,9 @@ webhooks: - start_side - side - reactions - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: type: object properties: @@ -191409,7 +194425,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *722 + repository: *723 sender: *4 required: - action @@ -191489,11 +194505,11 @@ webhooks: type: string enum: - edited - changes: *767 - comment: *768 - enterprise: *719 - installation: *720 - organization: *721 + changes: *768 + comment: *769 + enterprise: *720 + installation: *721 + organization: *722 pull_request: type: object properties: @@ -193717,7 +196733,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *722 + repository: *723 sender: *4 required: - action @@ -193798,9 +196814,9 @@ webhooks: type: string enum: - dismissed - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -196036,7 +199052,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *722 + repository: *723 review: description: The review that was affected. type: object @@ -196287,9 +199303,9 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -198398,8 +201414,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *722 - review: &769 + repository: *723 + review: &770 description: The review that was affected. type: object properties: @@ -198637,12 +201653,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -200992,7 +204008,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 requested_reviewer: title: User type: @@ -201078,12 +204094,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -203440,7 +206456,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 requested_team: title: Team description: Groups of organization members that gives permissions @@ -203635,12 +206651,12 @@ webhooks: type: string enum: - review_requested - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -205992,7 +209008,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 requested_reviewer: title: User type: @@ -206079,12 +209095,12 @@ webhooks: type: string enum: - review_requested - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -208427,7 +211443,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 requested_team: title: Team description: Groups of organization members that gives permissions @@ -208611,9 +211627,9 @@ webhooks: type: string enum: - submitted - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -210852,8 +213868,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *722 - review: *769 + repository: *723 + review: *770 sender: *4 required: - action @@ -210933,9 +213949,9 @@ webhooks: type: string enum: - resolved - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -213083,7 +216099,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *722 + repository: *723 sender: *4 thread: type: object @@ -213480,9 +216496,9 @@ webhooks: type: string enum: - unresolved - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -215613,7 +218629,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *722 + repository: *723 sender: *4 thread: type: object @@ -216012,10 +219028,10 @@ webhooks: type: string before: type: string - enterprise: *719 - installation: *720 - number: *764 - organization: *721 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 pull_request: title: Pull Request type: object @@ -218353,7 +221369,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -218435,11 +221451,11 @@ webhooks: type: string enum: - unassigned - assignee: *770 - enterprise: *719 - installation: *720 - number: *764 - organization: *721 + assignee: *771 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 pull_request: title: Pull Request type: object @@ -220792,7 +223808,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -220871,11 +223887,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *719 - installation: *720 - label: *738 - number: *764 - organization: *721 + enterprise: *720 + installation: *721 + label: *739 + number: *765 + organization: *722 pull_request: title: Pull Request type: object @@ -223217,7 +226233,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -223298,10 +226314,10 @@ webhooks: type: string enum: - unlocked - enterprise: *719 - installation: *720 - number: *764 - organization: *721 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 pull_request: title: Pull Request type: object @@ -225633,7 +228649,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -225836,7 +228852,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *719 + enterprise: *720 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -225931,8 +228947,8 @@ webhooks: - url - author - committer - installation: *720 - organization: *721 + installation: *721 + organization: *722 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -226531,9 +229547,9 @@ webhooks: type: string enum: - published - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 registry_package: type: object properties: @@ -227010,7 +230026,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *753 + items: *754 summary: type: string tag_name: @@ -227066,7 +230082,7 @@ webhooks: - owner - package_version - registry - repository: *722 + repository: *723 sender: *4 required: - action @@ -227144,9 +230160,9 @@ webhooks: type: string enum: - updated - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 registry_package: type: object properties: @@ -227458,7 +230474,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *753 + items: *754 summary: type: string tag_name: @@ -227508,7 +230524,7 @@ webhooks: - owner - package_version - registry - repository: *722 + repository: *723 sender: *4 required: - action @@ -227585,10 +230601,10 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - release: &771 + enterprise: *720 + installation: *721 + organization: *722 + release: &772 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -227919,7 +230935,7 @@ webhooks: - updated_at - zipball_url - body - repository: *722 + repository: *723 sender: *4 required: - action @@ -227996,11 +231012,11 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - release: *771 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + release: *772 + repository: *723 sender: *4 required: - action @@ -228117,11 +231133,11 @@ webhooks: type: boolean required: - to - enterprise: *719 - installation: *720 - organization: *721 - release: *771 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + release: *772 + repository: *723 sender: *4 required: - action @@ -228199,9 +231215,9 @@ webhooks: type: string enum: - prereleased - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -228537,7 +231553,7 @@ webhooks: - string - 'null' format: uri - repository: *722 + repository: *723 sender: *4 required: - action @@ -228613,10 +231629,10 @@ webhooks: type: string enum: - published - enterprise: *719 - installation: *720 - organization: *721 - release: &772 + enterprise: *720 + installation: *721 + organization: *722 + release: &773 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -228949,7 +231965,7 @@ webhooks: - string - 'null' format: uri - repository: *722 + repository: *723 sender: *4 required: - action @@ -229025,11 +232041,11 @@ webhooks: type: string enum: - released - enterprise: *719 - installation: *720 - organization: *721 - release: *771 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + release: *772 + repository: *723 sender: *4 required: - action @@ -229105,11 +232121,11 @@ webhooks: type: string enum: - unpublished - enterprise: *719 - installation: *720 - organization: *721 - release: *772 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + release: *773 + repository: *723 sender: *4 required: - action @@ -229185,11 +232201,11 @@ webhooks: type: string enum: - published - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - repository_advisory: *642 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + repository_advisory: *643 sender: *4 required: - action @@ -229265,11 +232281,11 @@ webhooks: type: string enum: - reported - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - repository_advisory: *642 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + repository_advisory: *643 sender: *4 required: - action @@ -229345,10 +232361,10 @@ webhooks: type: string enum: - archived - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -229425,10 +232441,10 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -229506,10 +232522,10 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -229594,10 +232610,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -229712,10 +232728,10 @@ webhooks: - 'null' items: type: string - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -229787,10 +232803,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 status: type: string @@ -229871,10 +232887,10 @@ webhooks: type: string enum: - privatized - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -229951,10 +232967,10 @@ webhooks: type: string enum: - publicized - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -230048,10 +233064,10 @@ webhooks: - name required: - repository - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -230131,10 +233147,10 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 repository_ruleset: *314 sender: *4 required: @@ -230213,10 +233229,10 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 repository_ruleset: *314 sender: *4 required: @@ -230295,10 +233311,10 @@ webhooks: type: string enum: - edited - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 repository_ruleset: *314 changes: type: object @@ -230606,10 +233622,10 @@ webhooks: - from required: - owner - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -230687,10 +233703,10 @@ webhooks: type: string enum: - unarchived - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -230768,7 +233784,7 @@ webhooks: type: string enum: - create - alert: &773 + alert: &774 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -230893,10 +233909,10 @@ webhooks: enum: - auto_dismissed - open - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -231106,10 +234122,10 @@ webhooks: type: string enum: - dismissed - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -231187,11 +234203,11 @@ webhooks: type: string enum: - reopen - alert: *773 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + alert: *774 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -231393,10 +234409,10 @@ webhooks: enum: - fixed - open - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -231474,7 +234490,7 @@ webhooks: type: string enum: - assigned - alert: &774 + alert: &775 type: object properties: number: *171 @@ -231614,10 +234630,10 @@ webhooks: - type: 'null' - *4 assignee: *4 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -231695,11 +234711,11 @@ webhooks: type: string enum: - created - alert: *774 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + alert: *775 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -231780,11 +234796,11 @@ webhooks: type: string enum: - created - alert: *774 - installation: *720 - location: *775 - organization: *721 - repository: *722 + alert: *775 + installation: *721 + location: *776 + organization: *722 + repository: *723 sender: *4 required: - location @@ -232022,11 +235038,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *774 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + alert: *775 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -232104,11 +235120,11 @@ webhooks: type: string enum: - reopened - alert: *774 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + alert: *775 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -232186,11 +235202,11 @@ webhooks: type: string enum: - resolved - alert: *774 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + alert: *775 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -232268,12 +235284,12 @@ webhooks: type: string enum: - unassigned - alert: *774 + alert: *775 assignee: *4 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -232351,11 +235367,11 @@ webhooks: type: string enum: - validated - alert: *774 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + alert: *775 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -232485,10 +235501,10 @@ webhooks: - organization - enterprise - - repository: *722 - enterprise: *719 - installation: *720 - organization: *721 + repository: *723 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -232566,11 +235582,11 @@ webhooks: type: string enum: - published - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - security_advisory: &776 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + security_advisory: &777 description: The details of the security advisory, including summary, description, and severity. type: object @@ -232743,11 +235759,11 @@ webhooks: type: string enum: - updated - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - security_advisory: *776 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + security_advisory: *777 sender: *4 required: - action @@ -232820,10 +235836,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -232997,9 +236013,9 @@ webhooks: type: object properties: security_and_analysis: *287 - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 repository: *334 sender: *4 required: @@ -233078,12 +236094,12 @@ webhooks: type: string enum: - cancelled - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: &777 + sponsorship: &778 type: object properties: created_at: @@ -233388,12 +236404,12 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *777 + sponsorship: *778 required: - action - sponsorship @@ -233481,12 +236497,12 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *777 + sponsorship: *778 required: - action - changes @@ -233563,17 +236579,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &778 + effective_date: &779 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *777 + sponsorship: *778 required: - action - sponsorship @@ -233647,7 +236663,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &779 + changes: &780 type: object properties: tier: @@ -233691,13 +236707,13 @@ webhooks: - from required: - tier - effective_date: *778 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + effective_date: *779 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *777 + sponsorship: *778 required: - action - changes @@ -233774,13 +236790,13 @@ webhooks: type: string enum: - tier_changed - changes: *779 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + changes: *780 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *777 + sponsorship: *778 required: - action - changes @@ -233854,10 +236870,10 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -233941,10 +236957,10 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -234378,15 +237394,15 @@ webhooks: type: - string - 'null' - enterprise: *719 + enterprise: *720 id: description: The unique identifier of the status. type: integer - installation: *720 + installation: *721 name: type: string - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 sha: description: The Commit SHA. @@ -234502,9 +237518,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -234594,9 +237610,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -234686,9 +237702,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -234778,9 +237794,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -234857,12 +237873,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - team: &780 + team: &781 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -235092,9 +238108,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -235564,7 +238580,7 @@ webhooks: - topics - visibility sender: *4 - team: *780 + team: *781 required: - action - team @@ -235640,9 +238656,9 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -236112,7 +239128,7 @@ webhooks: - topics - visibility sender: *4 - team: *780 + team: *781 required: - action - team @@ -236189,9 +239205,9 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -236661,7 +239677,7 @@ webhooks: - topics - visibility sender: *4 - team: *780 + team: *781 required: - action - team @@ -236805,9 +239821,9 @@ webhooks: - from required: - permissions - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -237277,7 +240293,7 @@ webhooks: - topics - visibility sender: *4 - team: *780 + team: *781 required: - action - changes @@ -237355,9 +240371,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -237827,7 +240843,7 @@ webhooks: - topics - visibility sender: *4 - team: *780 + team: *781 required: - action - team @@ -237903,10 +240919,10 @@ webhooks: type: string enum: - started - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -237979,17 +240995,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *719 + enterprise: *720 inputs: type: - object - 'null' additionalProperties: true - installation: *720 - organization: *721 + installation: *721 + organization: *722 ref: type: string - repository: *722 + repository: *723 sender: *4 workflow: type: string @@ -238071,10 +241087,10 @@ webhooks: type: string enum: - completed - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: allOf: @@ -238409,10 +241425,10 @@ webhooks: type: string enum: - in_progress - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: allOf: @@ -238773,10 +241789,10 @@ webhooks: type: string enum: - queued - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: type: object @@ -239001,10 +242017,10 @@ webhooks: type: string enum: - waiting - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: type: object @@ -239231,12 +242247,12 @@ webhooks: type: string enum: - completed - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *734 + workflow: *735 workflow_run: title: Workflow Run type: object @@ -240255,12 +243271,12 @@ webhooks: type: string enum: - in_progress - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *734 + workflow: *735 workflow_run: title: Workflow Run type: object @@ -241264,12 +244280,12 @@ webhooks: type: string enum: - requested - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *734 + workflow: *735 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 7541edcc0..57b0cd242 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -2352,6 +2352,3174 @@ } } }, + "/agents/repos/{owner}/{repo}/tasks": { + "get": { + "summary": "List tasks for repository", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n\n**Fine-grained access tokens for \"List tasks for repository\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Start a task", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nStarts a new Copilot cloud agent task for a repository.\n\nThis endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription.\n\n**Fine-grained access tokens for \"Start a task\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read and write)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/create-task-in-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#start-a-task" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + } + ], + "requestBody": { + "required": true, + "description": "The task creation parameters, including the user's prompt and optional agent settings.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "prompt" + ], + "properties": { + "prompt": { + "type": "string", + "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`" + }, + "create_pull_request": { + "type": "boolean", + "description": "Whether to create a PR.", + "default": false + }, + "base_ref": { + "type": "string", + "description": "Base ref for new branch/PR" + } + } + }, + "examples": { + "default": { + "value": { + "prompt": "Fix the login button on the homepage", + "base_ref": "main" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Task created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "queued", + "session_count": 1, + "artifacts": [], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "400": { + "description": "Problems parsing JSON", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/repos/{owner}/{repo}/tasks/{task_id}": { + "get": { + "summary": "Get a task by repo", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n\n**Fine-grained access tokens for \"Get a task by repo\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-repo-and-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "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": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks": { + "get": { + "summary": "List tasks", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n\n**Fine-grained access tokens for \"List tasks\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks/{task_id}": { + "get": { + "summary": "Get a task by ID", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n\n**Fine-grained access tokens for \"Get a task by ID\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "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": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, "/app": { "get": { "summary": "Get the authenticated app", @@ -109469,7 +112637,7 @@ "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { "post": { "summary": "Set cluster deployment records", - "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.", + "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.\nNote: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments\narray resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use\nthe artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can\nonly have one name and version.", "tags": [ "orgs" ], @@ -109528,20 +112696,20 @@ "properties": { "name": { "type": "string", - "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", + "description": "The name of the artifact.", "minLength": 1, "maxLength": 256 }, "digest": { "type": "string", - "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", + "description": "The hex encoded digest of the artifact.", "minLength": 71, "maxLength": 71, "pattern": "^sha256:[a-f0-9]{64}$" }, "version": { "type": "string", - "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", + "description": "The artifact version.", "maxLength": 100, "x-multi-segment": true, "examples": [ @@ -201271,7 +204439,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -201356,6 +204525,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -201508,7 +204685,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -201599,7 +204776,7 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication.", "type": "string", "enum": [ "token", @@ -201607,7 +204784,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -201643,7 +204821,7 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { @@ -201661,6 +204839,14 @@ "api_host": { "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", "type": "string" + }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). Required when `auth_type` is `oidc_gcp`.", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).", + "type": "string" } }, "required": [ @@ -201719,6 +204905,17 @@ "service_slug": "my-service-account", "audience": "https://github.com/my-org" } + }, + "org-private-registry-with-oidc-gcp": { + "summary": "Example of an OIDC private registry configuration using Google Cloud Artifact Registry", + "value": { + "registry_type": "docker_registry", + "url": "https://us-docker.pkg.dev/my-project/my-repo", + "auth_type": "oidc_gcp", + "visibility": "all", + "workload_identity_provider": "projects/123456789/locations/global/workloadIdentityPools/github-pool/providers/github-provider", + "service_account": "dependabot@my-project.iam.gserviceaccount.com" + } } } } @@ -201770,7 +204967,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -201859,6 +205057,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -202198,7 +205404,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -202283,6 +205490,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -202351,7 +205566,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -202459,7 +205674,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -202495,7 +205711,7 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { @@ -202513,6 +205729,14 @@ "api_host": { "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", "type": "string" + }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). Required when `auth_type` is `oidc_gcp`.", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).", + "type": "string" } } }, @@ -252521,6 +255745,15 @@ "type": "boolean", "default": false } + }, + { + "name": "is_bypassed", + "in": "query", + "description": "A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -282481,25 +285714,547 @@ } }, { - "name": "cache_id", - "description": "The unique identifier of the GitHub Actions cache.", + "name": "cache_id", + "description": "The unique identifier of the GitHub Actions cache.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/concurrency_groups": { + "get": { + "summary": "List concurrency groups for a repository", + "description": "Lists the active concurrency groups for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-concurrency-groups-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Concurrency Group List", + "description": "A list of active concurrency groups for a repository.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "last_acquired_at" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "last_acquired_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "last_acquired_at": "2026-01-15T16:14:23Z" + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "last_acquired_at": "2026-01-15T16:13:55Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "concurrency-groups" + } + } + }, + "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}": { + "get": { + "summary": "Get a concurrency group for a repository", + "description": "Gets a specific concurrency group for a repository, including all instances in the group's queue.\nReturns 404 if the group is inactive or does not exist.\n\nOptionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items\nahead of the specified workflow run or job in the queue, plus the specified item itself\n(returned as the last element). This is useful for determining what is blocking a particular\nrun or job. Returns 422 if the specified run or job is not in this concurrency group.\n\nWhen using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow\nleases held on behalf of that run. Job-level leases within the run are not considered to\nblock the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow\nleases on the job's ancestor paths.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/get-concurrency-group-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "concurrency_group_name", + "description": "The name of the concurrency group.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "ahead_of_run", + "description": "Filter to items ahead of this workflow run ID in the queue, plus the run itself.\nMatches workflow-level concurrency and reusable-workflow leases held on behalf of\nthe run. Mutually exclusive with `ahead_of_job`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + }, + { + "name": "ahead_of_job", + "description": "Filter to items ahead of this job ID in the queue, plus the job itself.\nMatches job-level concurrency and reusable-workflow leases on the job's\nancestor paths. Mutually exclusive with `ahead_of_run`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 } } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Concurrency Group", + "description": "A concurrency group with the workflow runs and jobs that are either currently holding\nor waiting for the concurrency group lease.", + "type": "object", + "required": [ + "group_name", + "group_url", + "total_count", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "total_count": { + "type": "integer" + }, + "group_members": { + "type": "array", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "job_id": { + "type": "integer", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "total_count": 3, + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress" + }, + { + "run_id": 30433643, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433643", + "status": "pending" + }, + { + "run_id": 30433644, + "run_name": "Deploy hotfix", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644", + "job_id": 798245260, + "job_name": "deploy", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260", + "status": "pending" + } + ] + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "concurrency-groups" } } }, @@ -300137,99 +303892,386 @@ } }, { - "name": "attempt_number", - "description": "The attempt number of the workflow run.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "302": { - "description": "Response", - "headers": { - "Location": { - "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "workflow-runs" - } - } - }, - "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { - "post": { - "summary": "Cancel a workflow run", - "description": "Cancels a workflow run using its `id`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/cancel-workflow-run", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "attempt_number", + "description": "The attempt number of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + "post": { + "summary": "Cancel a workflow run", + "description": "Cancels a workflow run using its `id`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/cancel-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The unique identifier of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups": { + "get": { + "summary": "List concurrency groups for a workflow run", + "description": "Lists all concurrency groups associated with a workflow run or its jobs.\n\nThe set of groups is derived from the run's configuration, so a group is\nincluded even when the run no longer has any items currently holding or\nwaiting in it. In that case the `group_members` array will be empty.\n`total_count` reflects the number of groups the run participates in by\nconfiguration, not the number with active items.\n\nThis differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`,\nwhich returns 404 when a group has no active items. That endpoint reports\nthe live state of a group repo-wide, while this endpoint reports the\ngroups associated with a specific run by configuration.\n\nResults are sorted by group name and support cursor-based pagination via\n`before` and `after`. The `after` cursor paginates forward only and does\nnot emit a `rel=\"prev\"` Link; use `before` to page backward from a\nforward page's `next` cursor.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-concurrency-groups-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The unique identifier of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 } }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, "schema": { "type": "string" } }, { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "path", - "required": true, + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, "schema": { - "type": "integer" + "type": "string" } } ], "responses": { - "202": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", + "title": "Concurrency Group Run List", + "description": "A list of concurrency groups associated with a workflow run.", "type": "object", - "properties": {}, - "additionalProperties": false + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer", + "description": "The total number of concurrency groups this workflow run participates in,\nderived from the run's configuration. This count is not filtered by\nwhether the run currently holds or is waiting in each group, so it can\ninclude groups whose `group_members` array is empty (for example, when\nthe run has already released its lease in that group)." + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group. May return 404 if the group\nhas no active items at the time it is requested, since the\nget-by-name endpoint reports the live repo-wide state of a group\nwhile this endpoint lists groups associated with a run by\nconfiguration." + }, + "group_members": { + "type": "array", + "description": "Items belonging to this workflow run that are either currently holding or\nwaiting for the concurrency group lease. May be empty if the run no\nlonger has any active or queued items in this group.", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status", + "position", + "position_url" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "position": { + "type": "integer", + "description": "Queue position. 0 means the item holds the concurrency lease (in_progress), 1 or higher means queued (pending)." + }, + "position_url": { + "type": "string", + "format": "uri", + "description": "API URL to get items ahead of this item in the concurrency group." + }, + "job_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": [ + "string", + "null" + ], + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } }, "examples": { "default": { - "value": null + "value": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress", + "position": 0, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642" + } + ] + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "pending", + "position": 2, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260", + "job_id": 798245260, + "job_name": "build", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260" + } + ] + } + ] + } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, - "409": { - "description": "Conflict", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -300253,13 +304295,88 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "workflow-runs" + "subcategory": "concurrency-groups" } } }, @@ -646097,6 +650214,15 @@ "type": "boolean", "default": false } + }, + { + "name": "is_bypassed", + "in": "query", + "description": "A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index e34dac270..85e366e51 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -1129,7 +1129,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &644 + - &645 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1225,6 +1225,2530 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories + "/agents/repos/{owner}/{repo}/tasks": + get: + summary: List tasks for repository + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for a specific repository + + **Fine-grained access tokens for "List tasks for repository"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/list-tasks-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, + `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived + tasks. When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + - name: creator_id + in: query + schema: + type: integer + description: Filter tasks by creator user ID + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="prev" (when current page > 1), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; + rel="next", ; + rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + post: + summary: Start a task + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Starts a new Copilot cloud agent task for a repository. + + This endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription. + + **Fine-grained access tokens for "Start a task"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read and write) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/create-task-in-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#start-a-task + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + requestBody: + required: true + description: The task creation parameters, including the user's prompt and + optional agent settings. + content: + application/json: + schema: + type: object + required: + - prompt + properties: + prompt: + type: string + 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`' + create_pull_request: + type: boolean + description: Whether to create a PR. + default: false + base_ref: + type: string + description: Base ref for new branch/PR + examples: + default: + value: + prompt: Fix the login button on the homepage + base_ref: main + responses: + '201': + description: Task created successfully + content: + application/json: + schema: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: queued + session_count: 1 + artifacts: [] + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '400': + description: Problems parsing JSON + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/repos/{owner}/{repo}/tasks/{task_id}": + get: + summary: Get a task by repo + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID scoped to an owner/repo path + + **Fine-grained access tokens for "Get a task by repo"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-repo-and-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + allOf: + - type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + 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: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/tasks": + get: + summary: List tasks + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for the authenticated user + + **Fine-grained access tokens for "List tasks"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/list-tasks + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, + `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived + tasks. When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; rel="next", + ; rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/tasks/{task_id}": + get: + summary: Get a task by ID + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID with its associated sessions + + **Fine-grained access tokens for "Get a task by ID"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + allOf: + - type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + 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: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation "/app": get: summary: Get the authenticated app @@ -12085,7 +14609,7 @@ paths: properties: action: type: string - discussion: &735 + discussion: &736 title: Discussion description: A Discussion in a repository. type: object @@ -12869,7 +15393,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &655 + sub_issues_summary: &656 title: Sub-issues Summary type: object properties: @@ -12980,7 +15504,7 @@ paths: - url - created_at - updated_at - issue_dependencies_summary: &656 + issue_dependencies_summary: &657 title: Issue Dependencies Summary type: object properties: @@ -14537,7 +17061,7 @@ paths: url: type: string format: uri - user: &662 + user: &663 title: Public User description: Public User type: object @@ -19916,7 +22440,7 @@ paths: required: false schema: type: string - - &712 + - &713 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -20062,7 +22586,7 @@ paths: parameters: - *74 - *116 - - &713 + - &714 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -20174,7 +22698,7 @@ paths: - *116 - *118 - *117 - - &714 + - &715 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -20182,7 +22706,7 @@ paths: schema: type: string - *119 - - &715 + - &716 name: sku description: The SKU to query for usage. in: query @@ -26557,6 +29081,10 @@ paths: If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. If no existing records match, new records will be created. + Note: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments + array resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use + the artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can + only have one name and version. tags: - orgs operationId: orgs/set-cluster-deployment-records @@ -26599,24 +29127,18 @@ paths: properties: name: type: string - description: | - The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name parameter must also be identical across all entries. + description: The name of the artifact. minLength: 1 maxLength: 256 digest: type: string - description: | - The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name and version parameters must also be identical across all entries. + description: The hex encoded digest of the artifact. minLength: 71 maxLength: 71 pattern: "^sha256:[a-f0-9]{64}$" version: type: string - description: | - The artifact version. Note that if multiple deployments have identical 'digest' parameter values, - the version parameter must also be identical across all entries. + description: The artifact version. maxLength: 100 x-multi-segment: true examples: @@ -27093,12 +29615,12 @@ paths: required: - subject_digests examples: - default: &693 + default: &694 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &694 + withPredicateType: &695 value: subject_digests: - sha256:abc123 @@ -27157,7 +29679,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &695 + default: &696 value: attestations_subject_digests: - sha256:abc: @@ -39822,7 +42344,7 @@ paths: parameters: - *74 - *248 - - &676 + - &677 name: repo_name description: repo_name parameter in: path @@ -40901,7 +43423,7 @@ paths: - nuget - container - *74 - - &677 + - &678 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -40942,7 +43464,7 @@ paths: default: *254 '403': *27 '401': *23 - '400': &679 + '400': &680 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -42168,6 +44690,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -42238,6 +44761,15 @@ paths: api_host: description: The Cloudsmith API host. type: string + workload_identity_provider: + description: The full resource name of the GCP Workload + Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + type: string + service_account: + description: The GCP service account email to impersonate. + If omitted, the federated token is used directly (direct + WIF). + type: string created_at: type: string format: date-time @@ -42275,7 +44807,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -42369,7 +44901,477 @@ paths: auth_type: description: The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, - or `oidc_cloudsmith` for OIDC authentication. + `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication. + type: string + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + - oidc_cloudsmith + - oidc_gcp + tenant_id: + description: The tenant ID of the Azure AD application. Required + when `auth_type` is `oidc_azure`. + type: string + client_id: + description: The client ID of the Azure AD application. Required + when `auth_type` is `oidc_azure`. + type: string + aws_region: + description: The AWS region. Required when `auth_type` is `oidc_aws`. + type: string + account_id: + description: The AWS account ID. Required when `auth_type` is `oidc_aws`. + type: string + role_name: + description: The AWS IAM role name. Required when `auth_type` is + `oidc_aws`. + type: string + domain: + description: The CodeArtifact domain. Required when `auth_type` + is `oidc_aws`. + type: string + domain_owner: + description: The CodeArtifact domain owner (AWS account ID). Required + when `auth_type` is `oidc_aws`. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. Required when `auth_type` + is `oidc_jfrog`. + type: string + audience: + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and `oidc_gcp`, and required for `oidc_cloudsmith` auth types. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. Optional for `oidc_jfrog` + auth type. + type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + Required when `auth_type` is `oidc_gcp`. + type: string + service_account: + description: The GCP service account email to impersonate. Optional + for `oidc_gcp` auth type. If omitted, the federated token is used + directly (direct WIF). + type: string + required: + - registry_type + - url + - visibility + examples: + org-private-registry-with-private-visibility: + summary: Example of a private registry configuration with private + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + replaces_base: true + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: private + org-private-registry-with-selected-visibility: + summary: Example of a private registry configuration with selected + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + org-private-registry-with-oidc-azure: + summary: Example of an OIDC private registry configuration using Azure + value: + registry_type: docker_registry + url: https://myregistry.azurecr.io + auth_type: oidc_azure + visibility: all + tenant_id: 12345678-1234-1234-1234-123456789012 + client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org + org-private-registry-with-oidc-gcp: + summary: Example of an OIDC private registry configuration using Google + Cloud Artifact Registry + value: + registry_type: docker_registry + url: https://us-docker.pkg.dev/my-project/my-repo + auth_type: oidc_gcp + visibility: all + workload_identity_provider: projects/123456789/locations/global/workloadIdentityPools/github-pool/providers/github-provider + service_account: dependabot@my-project.iam.gserviceaccount.com + responses: + '201': + description: The organization private registry configuration + content: + application/json: + schema: + title: Organization private registry + description: Private registry configuration for an organization + type: object + properties: + name: + description: The name of the private registry configuration. + type: string + examples: + - MAVEN_REPOSITORY_SECRET + registry_type: + description: The registry type. + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + type: string + auth_type: + description: The authentication type for the private registry. + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + - oidc_cloudsmith + - oidc_gcp + type: string + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the + private registry. + type: string + examples: + - monalisa + replaces_base: + description: Whether this private registry replaces the base registry + (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, + Dependabot will only use this registry and will not fall back + to the public registry. When `false` (default), Dependabot will + use this registry for scoped packages but may fall back to the + public registry for other packages. + type: boolean + default: false + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + enum: + - all + - private + - selected + type: string + selected_repository_ids: + type: array + description: An array of repository IDs that can access the organization + private registry when `visibility` is set to `selected`. + items: + type: integer + tenant_id: + description: The tenant ID of the Azure AD application. + type: string + client_id: + description: The client ID of the Azure AD application. + type: string + aws_region: + description: The AWS region. + type: string + account_id: + description: The AWS account ID. + type: string + role_name: + description: The AWS IAM role name. + type: string + domain: + description: The CodeArtifact domain. + type: string + domain_owner: + description: The CodeArtifact domain owner. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. + type: string + audience: + description: The OIDC audience. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. + type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + type: string + service_account: + description: The GCP service account email to impersonate. If + omitted, the federated token is used directly (direct WIF). + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - registry_type + - visibility + - created_at + - updated_at + examples: + org-private-registry-with-selected-visibility: &268 + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: private + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + org-private-registry-with-private-visibility: + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/public-key": + get: + summary: Get private registries public key for an organization + description: |2- + + Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization + parameters: + - *74 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - key_id + - key + properties: + key_id: + description: The identifier for the key. + type: string + examples: + - '012345678912345678' + key: + description: The Base64 encoded public key. + type: string + examples: + - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + examples: + default: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + headers: + Link: *66 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/{secret_name}": + get: + summary: Get a private registry for an organization + description: |2- + + Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization + parameters: + - *74 + - *161 + responses: + '200': + description: The specified private registry configuration for the organization + content: + application/json: + schema: *267 + examples: + default: *268 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + patch: + summary: Update a private registry for an organization + description: |2- + + Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/update-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization + parameters: + - *74 + - *161 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + registry_type: + description: The registry type. + type: string + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the private + registry. This field should be omitted if the private registry + does not require a username for authentication. + type: + - string + - 'null' + replaces_base: + description: Whether this private registry should replace the base + registry (e.g., npmjs.org for npm, rubygems.org for rubygems). + When set to `true`, Dependabot will only use this registry and + will not fall back to the public registry. When set to `false` + (default), Dependabot will use this registry for scoped packages + but may fall back to the public registry for other packages. + type: boolean + default: false + encrypted_value: + description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get private registries + public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + endpoint. + type: string + pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + key_id: + description: The ID of the key you used to encrypt the secret. + type: string + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + type: string + enum: + - all + - private + - selected + selected_repository_ids: + description: An array of repository IDs that can access the organization + private registry. You can only provide a list of repository IDs + when `visibility` is set to `selected`. This field should be omitted + if `visibility` is set to `all` or `private`. + type: array + items: + type: integer + auth_type: + description: The authentication type for the private registry. This + field cannot be changed after creation. If provided, it must match + the existing `auth_type` of the configuration. To change the authentication + type, delete and recreate the configuration. type: string enum: - token @@ -42378,6 +45380,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -42410,7 +45413,7 @@ paths: type: string audience: description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, - and required for `oidc_cloudsmith` auth types. + and `oidc_gcp`, and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` @@ -42428,445 +45431,15 @@ paths: description: The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default. type: string - required: - - registry_type - - url - - visibility - examples: - org-private-registry-with-private-visibility: - summary: Example of a private registry configuration with private - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - replaces_base: true - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: private - org-private-registry-with-selected-visibility: - summary: Example of a private registry configuration with selected - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - org-private-registry-with-oidc-azure: - summary: Example of an OIDC private registry configuration using Azure - value: - registry_type: docker_registry - url: https://myregistry.azurecr.io - auth_type: oidc_azure - visibility: all - tenant_id: 12345678-1234-1234-1234-123456789012 - client_id: abcdef01-2345-6789-abcd-ef0123456789 - org-private-registry-with-oidc-cloudsmith: - summary: Example of an OIDC private registry configuration using Cloudsmith - value: - registry_type: npm_registry - url: https://npm.cloudsmith.io/my-org/my-repo/ - auth_type: oidc_cloudsmith - visibility: all - namespace: my-org - service_slug: my-service-account - audience: https://github.com/my-org - responses: - '201': - description: The organization private registry configuration - content: - application/json: - schema: - title: Organization private registry - description: Private registry configuration for an organization - type: object - properties: - name: - description: The name of the private registry configuration. - type: string - examples: - - MAVEN_REPOSITORY_SECRET - registry_type: - description: The registry type. - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - type: string - auth_type: - description: The authentication type for the private registry. - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - - oidc_cloudsmith - type: string - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with the - private registry. - type: string - examples: - - monalisa - replaces_base: - description: Whether this private registry replaces the base registry - (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, - Dependabot will only use this registry and will not fall back - to the public registry. When `false` (default), Dependabot will - use this registry for scoped packages but may fall back to the - public registry for other packages. - type: boolean - default: false - visibility: - description: Which type of organization repositories have access - to the private registry. `selected` means only the repositories - specified by `selected_repository_ids` can access the private - registry. - enum: - - all - - private - - selected - type: string - selected_repository_ids: - type: array - description: An array of repository IDs that can access the organization - private registry when `visibility` is set to `selected`. - items: - type: integer - tenant_id: - description: The tenant ID of the Azure AD application. - type: string - client_id: - description: The client ID of the Azure AD application. - type: string - aws_region: - description: The AWS region. - type: string - account_id: - description: The AWS account ID. - type: string - role_name: - description: The AWS IAM role name. - type: string - domain: - description: The CodeArtifact domain. - type: string - domain_owner: - description: The CodeArtifact domain owner. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. - type: string - audience: - description: The OIDC audience. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. - type: string - namespace: - description: The Cloudsmith organization namespace. - type: string - service_slug: - description: The Cloudsmith service account slug. - type: string - api_host: - description: The Cloudsmith API host. - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - name - - registry_type - - visibility - - created_at - - updated_at - examples: - org-private-registry-with-selected-visibility: &268 - value: - name: MAVEN_REPOSITORY_SECRET - registry_type: maven_repository - username: monalisa - visibility: private - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - org-private-registry-with-private-visibility: - value: - name: MAVEN_REPOSITORY_SECRET - registry_type: maven_repository - username: monalisa - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/public-key": - get: - summary: Get private registries public key for an organization - description: |2- - - Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization - parameters: - - *74 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - key_id - - key - properties: - key_id: - description: The identifier for the key. - type: string - examples: - - '012345678912345678' - key: - description: The Base64 encoded public key. - type: string - examples: - - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - examples: - default: - value: - key_id: '012345678912345678' - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - headers: - Link: *66 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/{secret_name}": - get: - summary: Get a private registry for an organization - description: |2- - - Get the configuration of a single private registry defined for an organization, omitting its encrypted value. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization - parameters: - - *74 - - *161 - responses: - '200': - description: The specified private registry configuration for the organization - content: - application/json: - schema: *267 - examples: - default: *268 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - patch: - summary: Update a private registry for an organization - description: |2- - - Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/update-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization - parameters: - - *74 - - *161 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - registry_type: - description: The registry type. + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + Required when `auth_type` is `oidc_gcp`. type: string - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with the private - registry. This field should be omitted if the private registry - does not require a username for authentication. - type: - - string - - 'null' - replaces_base: - description: Whether this private registry should replace the base - registry (e.g., npmjs.org for npm, rubygems.org for rubygems). - When set to `true`, Dependabot will only use this registry and - will not fall back to the public registry. When set to `false` - (default), Dependabot will use this registry for scoped packages - but may fall back to the public registry for other packages. - type: boolean - default: false - encrypted_value: - description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get private registries - public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) - endpoint. - type: string - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - description: The ID of the key you used to encrypt the secret. - type: string - visibility: - description: Which type of organization repositories have access - to the private registry. `selected` means only the repositories - specified by `selected_repository_ids` can access the private - registry. - type: string - enum: - - all - - private - - selected - selected_repository_ids: - description: An array of repository IDs that can access the organization - private registry. You can only provide a list of repository IDs - when `visibility` is set to `selected`. This field should be omitted - if `visibility` is set to `all` or `private`. - type: array - items: - type: integer - auth_type: - description: The authentication type for the private registry. This - field cannot be changed after creation. If provided, it must match - the existing `auth_type` of the configuration. To change the authentication - type, delete and recreate the configuration. - type: string - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - - oidc_cloudsmith - tenant_id: - description: The tenant ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - client_id: - description: The client ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - aws_region: - description: The AWS region. Required when `auth_type` is `oidc_aws`. - type: string - account_id: - description: The AWS account ID. Required when `auth_type` is `oidc_aws`. - type: string - role_name: - description: The AWS IAM role name. Required when `auth_type` is - `oidc_aws`. - type: string - domain: - description: The CodeArtifact domain. Required when `auth_type` - is `oidc_aws`. - type: string - domain_owner: - description: The CodeArtifact domain owner (AWS account ID). Required - when `auth_type` is `oidc_aws`. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. Required when `auth_type` - is `oidc_jfrog`. - type: string - audience: - description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, - and required for `oidc_cloudsmith` auth types. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. Optional for `oidc_jfrog` - auth type. - type: string - namespace: - description: The Cloudsmith organization namespace. Required when - `auth_type` is `oidc_cloudsmith`. - type: string - service_slug: - description: The Cloudsmith service account slug. Required when - `auth_type` is `oidc_cloudsmith`. - type: string - api_host: - description: The Cloudsmith API host. Optional for `oidc_cloudsmith` - auth type. If omitted, `api.cloudsmith.io` is used by default. + service_account: + description: The GCP service account email to impersonate. Optional + for `oidc_gcp` auth type. If omitted, the federated token is used + directly (direct WIF). type: string examples: secret-based-update: @@ -43022,7 +45595,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &763 + - &764 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -43992,7 +46565,7 @@ paths: - updated_at - project_url examples: - default: &699 + default: &700 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -44169,7 +46742,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &700 + items: &701 type: object properties: name: @@ -44206,7 +46779,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &701 + iteration_configuration: &702 type: object description: The configuration for iteration fields. properties: @@ -44256,7 +46829,7 @@ paths: value: name: Due date data_type: date - single_select_field: &702 + single_select_field: &703 summary: Create a single select field value: name: Priority @@ -44283,7 +46856,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &703 + iteration_field: &704 summary: Create an iteration field value: name: Sprint @@ -44309,7 +46882,7 @@ paths: application/json: schema: *274 examples: - text_field: &704 + text_field: &705 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -44318,7 +46891,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &705 + number_field: &706 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -44327,7 +46900,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &706 + date_field: &707 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -44336,7 +46909,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &707 + single_select_field: &708 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -44370,7 +46943,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &708 + iteration_field: &709 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -44416,7 +46989,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *271 - - &709 + - &710 name: field_id description: The unique identifier of the field. in: path @@ -44431,7 +47004,7 @@ paths: application/json: schema: *274 examples: - default: &710 + default: &711 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -45642,7 +48215,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &690 + schema: &691 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -45825,7 +48398,7 @@ paths: parameters: - *271 - *74 - - &711 + - &712 name: view_number description: The number that identifies the project view. in: path @@ -49980,6 +52553,17 @@ paths: schema: type: boolean default: false + - &622 + name: is_bypassed + in: query + description: A boolean value (`true` or `false`) indicating whether to filter + alerts by their push protection bypass status. When set to `true`, only + alerts that were created because a push protection rule was bypassed will + be returned. When set to `false`, only alerts that were not caused by a + push protection bypass will be returned. + required: false + schema: + type: boolean responses: '200': description: Response @@ -50003,14 +52587,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &622 + state: &623 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &623 + resolution: &624 type: - string - 'null' @@ -50129,14 +52713,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &624 + - &625 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &626 + - &627 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -50200,7 +52784,7 @@ paths: - blob_url - commit_sha - commit_url - - &627 + - &628 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -50261,7 +52845,7 @@ paths: - page_url - commit_sha - commit_url - - &628 + - &629 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -50283,7 +52867,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &629 + - &630 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -50305,7 +52889,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &630 + - &631 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -50327,7 +52911,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &631 + - &632 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -50342,7 +52926,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &632 + - &633 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -50357,7 +52941,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &633 + - &634 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -50372,7 +52956,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &634 + - &635 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -50394,7 +52978,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &635 + - &636 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -50416,7 +53000,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &636 + - &637 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -50438,7 +53022,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &637 + - &638 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -50460,7 +53044,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &638 + - &639 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -50981,7 +53565,7 @@ paths: application/json: schema: type: array - items: &642 + items: &643 description: A repository security advisory. type: object properties: @@ -51332,7 +53916,7 @@ paths: - private_fork version: '2026-03-10' examples: - default: &643 + default: &644 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -53418,7 +56002,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &658 + response-if-user-is-a-team-maintainer: &659 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -53483,7 +56067,7 @@ paths: application/json: schema: *330 examples: - response-if-users-membership-with-team-is-now-pending: &659 + response-if-users-membership-with-team-is-now-pending: &660 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -53597,7 +56181,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &660 + schema: &661 title: Team Repository description: A team's access to a repository. type: object @@ -54411,7 +56995,7 @@ paths: type: array items: *191 examples: - response-if-child-teams-exist: &661 + response-if-child-teams-exist: &662 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -56291,6 +58875,245 @@ paths: enabledForGitHubApps: true category: actions subcategory: cache + "/repos/{owner}/{repo}/actions/concurrency_groups": + get: + summary: List concurrency groups for a repository + description: |- + Lists the active concurrency groups for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-concurrency-groups-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository + parameters: + - *331 + - *332 + - *17 + - *46 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Concurrency Group List + description: A list of active concurrency groups for a repository. + type: object + required: + - total_count + - concurrency_groups + properties: + total_count: + type: integer + concurrency_groups: + type: array + items: + type: object + required: + - group_name + - group_url + - last_acquired_at + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: API URL for this concurrency group. + last_acquired_at: + type: + - string + - 'null' + format: date-time + examples: + default: + value: + total_count: 2 + concurrency_groups: + - group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + last_acquired_at: '2026-01-15T16:14:23Z' + - group_name: ci-build + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build + last_acquired_at: '2026-01-15T16:13:55Z' + headers: + Link: *66 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups + "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}": + get: + summary: Get a concurrency group for a repository + description: |- + Gets a specific concurrency group for a repository, including all instances in the group's queue. + Returns 404 if the group is inactive or does not exist. + + Optionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items + ahead of the specified workflow run or job in the queue, plus the specified item itself + (returned as the last element). This is useful for determining what is blocking a particular + run or job. Returns 422 if the specified run or job is not in this concurrency group. + + When using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow + leases held on behalf of that run. Job-level leases within the run are not considered to + block the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow + leases on the job's ancestor paths. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-concurrency-group-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository + parameters: + - *331 + - *332 + - name: concurrency_group_name + description: The name of the concurrency group. + in: path + required: true + schema: + type: string + - name: ahead_of_run + description: |- + Filter to items ahead of this workflow run ID in the queue, plus the run itself. + Matches workflow-level concurrency and reusable-workflow leases held on behalf of + the run. Mutually exclusive with `ahead_of_job`. + in: query + required: false + schema: + type: integer + minimum: 1 + - name: ahead_of_job + description: |- + Filter to items ahead of this job ID in the queue, plus the job itself. + Matches job-level concurrency and reusable-workflow leases on the job's + ancestor paths. Mutually exclusive with `ahead_of_run`. + in: query + required: false + schema: + type: integer + minimum: 1 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Concurrency Group + description: |- + A concurrency group with the workflow runs and jobs that are either currently holding + or waiting for the concurrency group lease. + type: object + required: + - group_name + - group_url + - total_count + - group_members + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: API URL for this concurrency group. + total_count: + type: integer + group_members: + type: array + items: + type: object + required: + - run_id + - run_name + - run_url + - run_html_url + - status + properties: + run_id: + type: integer + description: The ID of the workflow run. + run_name: + type: string + description: The name of the workflow run. + run_url: + type: + - string + - 'null' + format: uri + description: API URL for the workflow run. + run_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the workflow run. + job_id: + type: integer + description: The ID of the job, when the item represents + a job-level or reusable-workflow-level lease. + job_name: + type: string + description: The display name of the job, when the item + represents a job-level or reusable-workflow-level lease. + job_url: + type: + - string + - 'null' + format: uri + description: API URL for the job. + job_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the job. + status: + type: string + enum: + - in_progress + - pending + examples: + default: + value: + group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + total_count: 3 + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: in_progress + - run_id: 30433643 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433643 + status: pending + - run_id: 30433644 + run_name: Deploy hotfix + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433644 + job_id: 798245260 + job_name: deploy + job_url: https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260 + job_html_url: https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260 + status: pending + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups "/repos/{owner}/{repo}/actions/jobs/{job_id}": get: summary: Get a job for a workflow run @@ -59344,6 +62167,198 @@ paths: enabledForGitHubApps: true category: actions subcategory: workflow-runs + "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups": + get: + summary: List concurrency groups for a workflow run + description: |- + Lists all concurrency groups associated with a workflow run or its jobs. + + The set of groups is derived from the run's configuration, so a group is + included even when the run no longer has any items currently holding or + waiting in it. In that case the `group_members` array will be empty. + `total_count` reflects the number of groups the run participates in by + configuration, not the number with active items. + + This differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`, + which returns 404 when a group has no active items. That endpoint reports + the live state of a group repo-wide, while this endpoint reports the + groups associated with a specific run by configuration. + + Results are sorted by group name and support cursor-based pagination via + `before` and `after`. The `after` cursor paginates forward only and does + not emit a `rel="prev"` Link; use `before` to page backward from a + forward page's `next` cursor. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-concurrency-groups-for-workflow-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run + parameters: + - *331 + - *332 + - *369 + - *17 + - *45 + - *46 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Concurrency Group Run List + description: A list of concurrency groups associated with a workflow + run. + type: object + required: + - total_count + - concurrency_groups + properties: + total_count: + type: integer + description: |- + The total number of concurrency groups this workflow run participates in, + derived from the run's configuration. This count is not filtered by + whether the run currently holds or is waiting in each group, so it can + include groups whose `group_members` array is empty (for example, when + the run has already released its lease in that group). + concurrency_groups: + type: array + items: + type: object + required: + - group_name + - group_url + - group_members + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: |- + API URL for this concurrency group. May return 404 if the group + has no active items at the time it is requested, since the + get-by-name endpoint reports the live repo-wide state of a group + while this endpoint lists groups associated with a run by + configuration. + group_members: + type: array + description: |- + Items belonging to this workflow run that are either currently holding or + waiting for the concurrency group lease. May be empty if the run no + longer has any active or queued items in this group. + items: + type: object + required: + - run_id + - run_name + - run_url + - run_html_url + - status + - position + - position_url + properties: + run_id: + type: integer + description: The ID of the workflow run. + run_name: + type: string + description: The name of the workflow run. + run_url: + type: + - string + - 'null' + format: uri + description: API URL for the workflow run. + run_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the workflow run. + position: + type: integer + description: Queue position. 0 means the item holds + the concurrency lease (in_progress), 1 or higher + means queued (pending). + position_url: + type: string + format: uri + description: API URL to get items ahead of this item + in the concurrency group. + job_id: + type: + - integer + - 'null' + description: The ID of the job, when the item represents + a job-level or reusable-workflow-level lease. + job_name: + type: + - string + - 'null' + description: The display name of the job, when the + item represents a job-level or reusable-workflow-level + lease. + job_url: + type: + - string + - 'null' + format: uri + description: API URL for the job. + job_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the job. + status: + type: string + enum: + - in_progress + - pending + examples: + default: + value: + total_count: 2 + concurrency_groups: + - group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: in_progress + position: 0 + position_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642 + - group_name: ci-build + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: pending + position: 2 + position_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260 + job_id: 798245260 + job_name: build + job_url: https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260 + job_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260 + headers: + Link: *66 + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": post: summary: Review custom deployment protection rules for a workflow run @@ -65638,7 +68653,7 @@ paths: check. type: array items: *85 - deployment: &724 + deployment: &725 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -70910,7 +73925,7 @@ paths: type: array items: *452 examples: - default: &667 + default: &668 value: total_count: 2 machines: @@ -74087,7 +77102,7 @@ paths: application/json: schema: type: array - items: &647 + items: &648 title: Status description: The status of a commit. type: object @@ -75743,7 +78758,7 @@ paths: items: type: object properties: - placeholder_id: &639 + placeholder_id: &640 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -81744,7 +84759,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &755 + last_response: &756 title: Hook Response type: object properties: @@ -82813,7 +85828,7 @@ paths: parameters: - *331 - *332 - - &688 + - &689 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -83247,7 +86262,7 @@ paths: type: array items: *528 examples: - default: &681 + default: &682 value: - id: 1 repository: @@ -97804,6 +100819,7 @@ paths: - *619 - *620 - *621 + - *622 responses: '200': description: Response @@ -97811,7 +100827,7 @@ paths: application/json: schema: type: array - items: &625 + items: &626 type: object properties: number: *171 @@ -97827,8 +100843,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *622 - resolution: *623 + state: *623 + resolution: *624 resolved_at: type: - string @@ -97934,7 +100950,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *624 + - *625 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -98102,7 +101118,7 @@ paths: description: Response content: application/json: - schema: *625 + schema: *626 examples: default: value: @@ -98166,8 +101182,8 @@ paths: schema: type: object properties: - state: *622 - resolution: *623 + state: *623 + resolution: *624 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -98215,7 +101231,7 @@ paths: description: Response content: application/json: - schema: *625 + schema: *626 examples: default: value: @@ -98324,7 +101340,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &775 + items: &776 type: object properties: type: @@ -98351,7 +101367,6 @@ paths: - commit details: oneOf: - - *626 - *627 - *628 - *629 @@ -98364,6 +101379,7 @@ paths: - *636 - *637 - *638 + - *639 examples: default: value: @@ -98458,14 +101474,14 @@ paths: schema: type: object properties: - reason: &640 + reason: &641 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *639 + placeholder_id: *640 required: - reason - placeholder_id @@ -98482,7 +101498,7 @@ paths: schema: type: object properties: - reason: *640 + reason: *641 expire_at: type: - string @@ -98545,7 +101561,7 @@ paths: properties: incremental_scans: type: array - items: &641 + items: &642 description: Information on a single scan performed by secret scanning on the repository type: object @@ -98573,15 +101589,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *641 + items: *642 backfill_scans: type: array - items: *641 + items: *642 custom_pattern_backfill_scans: type: array items: allOf: - - *641 + - *642 - type: object properties: pattern_name: @@ -98594,7 +101610,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *641 + items: *642 examples: default: value: @@ -98704,9 +101720,9 @@ paths: application/json: schema: type: array - items: *642 + items: *643 examples: - default: *643 + default: *644 '400': *14 '404': *6 x-github: @@ -98900,9 +101916,9 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: &645 + default: &646 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -99255,7 +102271,7 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: default: value: @@ -99410,15 +102426,15 @@ paths: parameters: - *331 - *332 - - *644 + - *645 responses: '200': description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: *645 + default: *646 '403': *27 '404': *6 x-github: @@ -99444,7 +102460,7 @@ paths: parameters: - *331 - *332 - - *644 + - *645 requestBody: required: true content: @@ -99615,10 +102631,10 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: *645 - add_credit: *645 + default: *646 + add_credit: *646 '403': *27 '404': *6 '422': @@ -99658,7 +102674,7 @@ paths: parameters: - *331 - *332 - - *644 + - *645 responses: '202': *37 '400': *14 @@ -99687,7 +102703,7 @@ paths: parameters: - *331 - *332 - - *644 + - *645 responses: '202': description: Response @@ -99828,7 +102844,7 @@ paths: application/json: schema: type: array - items: &646 + items: &647 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -100201,7 +103217,7 @@ paths: application/json: schema: type: array - items: *646 + items: *647 examples: default: value: @@ -100291,7 +103307,7 @@ paths: description: Response content: application/json: - schema: *647 + schema: *648 examples: default: value: @@ -100385,7 +103401,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &648 + schema: &649 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -100485,7 +103501,7 @@ paths: description: Response content: application/json: - schema: *648 + schema: *649 examples: default: value: @@ -100695,7 +103711,7 @@ paths: description: Response content: application/json: - schema: &649 + schema: &650 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -100707,7 +103723,7 @@ paths: required: - names examples: - default: &650 + default: &651 value: names: - octocat @@ -100762,9 +103778,9 @@ paths: description: Response content: application/json: - schema: *649 + schema: *650 examples: - default: *650 + default: *651 '404': *6 '422': *7 x-github: @@ -100787,7 +103803,7 @@ paths: parameters: - *331 - *332 - - &651 + - &652 name: per description: The time frame to display results for. in: query @@ -100818,7 +103834,7 @@ paths: - 128 clones: type: array - items: &652 + items: &653 title: Traffic type: object properties: @@ -101066,7 +104082,7 @@ paths: parameters: - *331 - *332 - - *651 + - *652 responses: '200': description: Response @@ -101087,7 +104103,7 @@ paths: - 3782 views: type: array - items: *652 + items: *653 required: - uniques - count @@ -101866,7 +104882,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &653 + text_matches: &654 title: Search Result Text Matches type: array items: @@ -102029,7 +105045,7 @@ paths: enum: - author-date - committer-date - - &654 + - &655 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -102149,7 +105165,7 @@ paths: type: number node_id: type: string - text_matches: *653 + text_matches: *654 required: - sha - node_id @@ -102341,7 +105357,7 @@ paths: - interactions - created - updated - - *654 + - *655 - *17 - *19 - name: advanced_search @@ -102455,8 +105471,8 @@ paths: type: - string - 'null' - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -102487,7 +105503,7 @@ paths: - string - 'null' format: date-time - text_matches: *653 + text_matches: *654 pull_request: type: object properties: @@ -102787,7 +105803,7 @@ paths: enum: - created - updated - - *654 + - *655 - *17 - *19 responses: @@ -102832,7 +105848,7 @@ paths: - 'null' score: type: number - text_matches: *653 + text_matches: *654 required: - id - node_id @@ -102917,7 +105933,7 @@ paths: - forks - help-wanted-issues - updated - - *654 + - *655 - *17 - *19 responses: @@ -103163,7 +106179,7 @@ paths: - admin - pull - push - text_matches: *653 + text_matches: *654 temp_clone_token: type: string allow_merge_commit: @@ -103471,7 +106487,7 @@ paths: - string - 'null' format: uri - text_matches: *653 + text_matches: *654 related: type: - array @@ -103664,7 +106680,7 @@ paths: - followers - repositories - joined - - *654 + - *655 - *17 - *19 responses: @@ -103774,7 +106790,7 @@ paths: type: - boolean - 'null' - text_matches: *653 + text_matches: *654 blog: type: - string @@ -103856,7 +106872,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &657 + - &658 name: team_id description: The unique identifier of the team. in: path @@ -103897,7 +106913,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *657 + - *658 requestBody: required: true content: @@ -103998,7 +107014,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *657 + - *658 responses: '204': description: Response @@ -104027,7 +107043,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *657 + - *658 - *17 - *19 responses: @@ -104065,7 +107081,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *657 + - *658 - name: role description: Filters members returned by their role in the team. in: query @@ -104116,7 +107132,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *657 + - *658 - *70 responses: '204': @@ -104153,7 +107169,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *657 + - *658 - *70 responses: '204': @@ -104193,7 +107209,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *657 + - *658 - *70 responses: '204': @@ -104230,7 +107246,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *657 + - *658 - *70 responses: '200': @@ -104239,7 +107255,7 @@ paths: application/json: schema: *330 examples: - response-if-user-is-a-team-maintainer: *658 + response-if-user-is-a-team-maintainer: *659 '404': *6 x-github: githubCloudOnly: false @@ -104272,7 +107288,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *657 + - *658 - *70 requestBody: required: false @@ -104300,7 +107316,7 @@ paths: application/json: schema: *330 examples: - response-if-users-membership-with-team-is-now-pending: *659 + response-if-users-membership-with-team-is-now-pending: *660 '403': description: Forbidden if team synchronization is set up '422': @@ -104334,7 +107350,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *657 + - *658 - *70 responses: '204': @@ -104362,7 +107378,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *657 + - *658 - *17 - *19 responses: @@ -104404,7 +107420,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *657 + - *658 - *331 - *332 responses: @@ -104412,7 +107428,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *660 + schema: *661 examples: alternative-response-with-extra-repository-information: value: @@ -104569,7 +107585,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *657 + - *658 - *331 - *332 requestBody: @@ -104621,7 +107637,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *657 + - *658 - *331 - *332 responses: @@ -104648,7 +107664,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *657 + - *658 - *17 - *19 responses: @@ -104660,7 +107676,7 @@ paths: type: array items: *191 examples: - response-if-child-teams-exist: *661 + response-if-child-teams-exist: *662 headers: Link: *66 '404': *6 @@ -104693,7 +107709,7 @@ paths: application/json: schema: oneOf: - - &663 + - &664 title: Private User description: Private User type: object @@ -104943,7 +107959,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *662 + - *663 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -105103,7 +108119,7 @@ paths: description: Response content: application/json: - schema: *663 + schema: *664 examples: default: value: @@ -105501,7 +108517,7 @@ paths: type: integer secrets: type: array - items: &664 + items: &665 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -105621,7 +108637,7 @@ paths: description: Response content: application/json: - schema: *664 + schema: *665 examples: default: value: @@ -106034,7 +109050,7 @@ paths: description: Response content: application/json: - schema: &665 + schema: &666 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -106087,7 +109103,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &666 + default: &667 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -106132,9 +109148,9 @@ paths: description: Response content: application/json: - schema: *665 + schema: *666 examples: - default: *666 + default: *667 '404': *6 x-github: githubCloudOnly: false @@ -106173,7 +109189,7 @@ paths: type: array items: *452 examples: - default: *667 + default: *668 '304': *35 '500': *53 '401': *23 @@ -107139,7 +110155,7 @@ paths: type: array items: *253 examples: - default: &678 + default: &679 value: - id: 197 name: hello_docker @@ -107240,7 +110256,7 @@ paths: application/json: schema: type: array - items: &668 + items: &669 title: Email description: Email type: object @@ -107310,9 +110326,9 @@ paths: application/json: schema: type: array - items: *668 + items: *669 examples: - default: &680 + default: &681 value: - email: octocat@github.com verified: true @@ -107389,7 +110405,7 @@ paths: application/json: schema: type: array - items: *668 + items: *669 examples: default: value: @@ -107647,7 +110663,7 @@ paths: application/json: schema: type: array - items: &669 + items: &670 title: GPG Key description: A unique encryption key type: object @@ -107792,7 +110808,7 @@ paths: - subkeys - revoked examples: - default: &697 + default: &698 value: - id: 3 name: Octocat's GPG Key @@ -107877,9 +110893,9 @@ paths: description: Response content: application/json: - schema: *669 + schema: *670 examples: - default: &670 + default: &671 value: id: 3 name: Octocat's GPG Key @@ -107936,7 +110952,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &671 + - &672 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -107948,9 +110964,9 @@ paths: description: Response content: application/json: - schema: *669 + schema: *670 examples: - default: *670 + default: *671 '404': *6 '304': *35 '403': *27 @@ -107973,7 +110989,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *671 + - *672 responses: '204': description: Response @@ -108431,7 +111447,7 @@ paths: application/json: schema: type: array - items: &672 + items: &673 title: Key description: Key type: object @@ -108534,9 +111550,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: &673 + default: &674 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -108575,9 +111591,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: *673 + default: *674 '404': *6 '304': *35 '403': *27 @@ -108633,7 +111649,7 @@ paths: application/json: schema: type: array - items: &674 + items: &675 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -108712,7 +111728,7 @@ paths: - account - plan examples: - default: &675 + default: &676 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -108774,9 +111790,9 @@ paths: application/json: schema: type: array - items: *674 + items: *675 examples: - default: *675 + default: *676 headers: Link: *66 '304': *35 @@ -109794,7 +112810,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *248 - - *676 + - *677 responses: '204': description: Response @@ -109927,7 +112943,7 @@ paths: - docker - nuget - container - - *677 + - *678 - *19 - *17 responses: @@ -109939,8 +112955,8 @@ paths: type: array items: *253 examples: - default: *678 - '400': *679 + default: *679 + '400': *680 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -109969,7 +112985,7 @@ paths: application/json: schema: *253 examples: - default: &698 + default: &699 value: id: 40201 name: octo-name @@ -110331,9 +113347,9 @@ paths: application/json: schema: type: array - items: *668 + items: *669 examples: - default: *680 + default: *681 headers: Link: *66 '304': *35 @@ -110446,7 +113462,7 @@ paths: type: array items: *78 examples: - default: &687 + default: &688 summary: Default response value: - id: 1296269 @@ -110812,7 +113828,7 @@ paths: type: array items: *528 examples: - default: *681 + default: *682 headers: Link: *66 '304': *35 @@ -110897,7 +113913,7 @@ paths: application/json: schema: type: array - items: &682 + items: &683 title: Social account description: Social media account type: object @@ -110914,7 +113930,7 @@ paths: - provider - url examples: - default: &683 + default: &684 value: - provider: twitter url: https://twitter.com/github @@ -110977,9 +113993,9 @@ paths: application/json: schema: type: array - items: *682 + items: *683 examples: - default: *683 + default: *684 '422': *15 '304': *35 '404': *6 @@ -111067,7 +114083,7 @@ paths: application/json: schema: type: array - items: &684 + items: &685 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -111087,7 +114103,7 @@ paths: - title - created_at examples: - default: &716 + default: &717 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -111152,9 +114168,9 @@ paths: description: Response content: application/json: - schema: *684 + schema: *685 examples: - default: &685 + default: &686 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -111184,7 +114200,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &686 + - &687 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -111196,9 +114212,9 @@ paths: description: Response content: application/json: - schema: *684 + schema: *685 examples: - default: *685 + default: *686 '404': *6 '304': *35 '403': *27 @@ -111221,7 +114237,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *686 + - *687 responses: '204': description: Response @@ -111250,7 +114266,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &717 + - &718 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -111275,11 +114291,11 @@ paths: type: array items: *78 examples: - default-response: *687 + default-response: *688 application/vnd.github.v3.star+json: schema: type: array - items: &718 + items: &719 title: Starred Repository description: Starred Repository type: object @@ -111648,10 +114664,10 @@ paths: application/json: schema: oneOf: + - *664 - *663 - - *662 examples: - default-response: &691 + default-response: &692 summary: Default response value: login: octocat @@ -111686,7 +114702,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &692 + response-with-git-hub-plan-information: &693 summary: Response with GitHub plan information value: login: octocat @@ -111743,7 +114759,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &689 + - &690 name: user_id description: The unique identifier of the user. in: path @@ -111809,7 +114825,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *688 + - *689 - *17 responses: '200': @@ -111844,7 +114860,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *689 + - *690 - *271 requestBody: required: true @@ -111919,7 +114935,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *690 + schema: *691 examples: table_view: summary: Response for creating a table view @@ -111971,11 +114987,11 @@ paths: application/json: schema: oneOf: + - *664 - *663 - - *662 examples: - default-response: *691 - response-with-git-hub-plan-information: *692 + default-response: *692 + response-with-git-hub-plan-information: *693 '404': *6 x-github: githubCloudOnly: false @@ -112025,8 +115041,8 @@ paths: required: - subject_digests examples: - default: *693 - withPredicateType: *694 + default: *694 + withPredicateType: *695 responses: '200': description: Response @@ -112080,7 +115096,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *695 + default: *696 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -112598,7 +115614,7 @@ paths: application/json: schema: *187 examples: - default: &696 + default: &697 summary: Example response for a user copilot space value: id: 42 @@ -112699,7 +115715,7 @@ paths: application/json: schema: *187 examples: - default: *696 + default: *697 '403': *27 '404': *6 x-github: @@ -112825,7 +115841,7 @@ paths: application/json: schema: *187 examples: - default: *696 + default: *697 '403': *27 '404': *6 '422': *15 @@ -113593,7 +116609,7 @@ paths: type: array items: *253 examples: - default: *678 + default: *679 '403': *27 '401': *23 x-github: @@ -113977,9 +116993,9 @@ paths: application/json: schema: type: array - items: *669 + items: *670 examples: - default: *697 + default: *698 headers: Link: *66 x-github: @@ -114208,7 +117224,7 @@ paths: - docker - nuget - container - - *677 + - *678 - *70 - *19 - *17 @@ -114221,10 +117237,10 @@ paths: type: array items: *253 examples: - default: *678 + default: *679 '403': *27 '401': *23 - '400': *679 + '400': *680 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -114254,7 +117270,7 @@ paths: application/json: schema: *253 examples: - default: *698 + default: *699 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -114603,7 +117619,7 @@ paths: type: array items: *274 examples: - default: *699 + default: *700 headers: Link: *66 '304': *35 @@ -114663,7 +117679,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *700 + items: *701 required: - name - data_type @@ -114679,7 +117695,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *701 + iteration_configuration: *702 required: - name - data_type @@ -114701,8 +117717,8 @@ paths: value: name: Due date data_type: date - single_select_field: *702 - iteration_field: *703 + single_select_field: *703 + iteration_field: *704 responses: '201': description: Response @@ -114710,11 +117726,11 @@ paths: application/json: schema: *274 examples: - text_field: *704 - number_field: *705 - date_field: *706 - single_select_field: *707 - iteration_field: *708 + text_field: *705 + number_field: *706 + date_field: *707 + single_select_field: *708 + iteration_field: *709 '304': *35 '403': *27 '401': *23 @@ -114736,7 +117752,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *271 - - *709 + - *710 - *70 responses: '200': @@ -114745,7 +117761,7 @@ paths: application/json: schema: *274 examples: - default: *710 + default: *711 headers: Link: *66 '304': *35 @@ -115102,7 +118118,7 @@ paths: parameters: - *271 - *70 - - *711 + - *712 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -115377,7 +118393,7 @@ paths: - *116 - *118 - *117 - - *712 + - *713 - *119 responses: '200': @@ -115508,7 +118524,7 @@ paths: parameters: - *70 - *116 - - *713 + - *714 - *117 responses: '200': @@ -115607,9 +118623,9 @@ paths: - *116 - *118 - *117 - - *714 - - *119 - *715 + - *119 + - *716 responses: '200': description: Response when getting a billing usage summary @@ -115743,9 +118759,9 @@ paths: application/json: schema: type: array - items: *682 + items: *683 examples: - default: *683 + default: *684 headers: Link: *66 x-github: @@ -115775,9 +118791,9 @@ paths: application/json: schema: type: array - items: *684 + items: *685 examples: - default: *716 + default: *717 headers: Link: *66 x-github: @@ -115802,7 +118818,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *70 - - *717 + - *718 - *60 - *17 - *19 @@ -115814,11 +118830,11 @@ paths: schema: anyOf: - type: array - items: *718 + items: *719 - type: array items: *78 examples: - default-response: *687 + default-response: *688 headers: Link: *66 x-github: @@ -115978,7 +118994,7 @@ webhooks: type: string enum: - disabled - enterprise: &719 + enterprise: &720 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -116047,7 +119063,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &720 + installation: &721 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -116068,7 +119084,7 @@ webhooks: required: - id - node_id - organization: &721 + organization: &722 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -116141,7 +119157,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &722 + repository: &723 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -117081,10 +120097,10 @@ webhooks: type: string enum: - enabled - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -117160,11 +120176,11 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - rule: &723 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + rule: &724 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -117387,11 +120403,11 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - rule: *723 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + rule: *724 sender: *4 required: - action @@ -117579,11 +120595,11 @@ webhooks: - everyone required: - from - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - rule: *723 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + rule: *724 sender: *4 required: - action @@ -117667,7 +120683,7 @@ webhooks: type: string enum: - completed - check_run: &725 + check_run: &726 title: CheckRun description: A check performed on the code of a given code change type: object @@ -117777,7 +120793,7 @@ webhooks: - examples: - neutral - deployment: *724 + deployment: *725 details_url: type: string examples: @@ -117875,10 +120891,10 @@ webhooks: - output - app - pull_requests - installation: *720 - enterprise: *719 - organization: *721 - repository: *722 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 sender: *4 required: - check_run @@ -118269,11 +121285,11 @@ webhooks: type: string enum: - created - check_run: *725 - installation: *720 - enterprise: *719 - organization: *721 - repository: *722 + check_run: *726 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 sender: *4 required: - check_run @@ -118667,11 +121683,11 @@ webhooks: type: string enum: - requested_action - check_run: *725 - installation: *720 - enterprise: *719 - organization: *721 - repository: *722 + check_run: *726 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 requested_action: description: The action requested by the user. type: object @@ -119074,11 +122090,11 @@ webhooks: type: string enum: - rerequested - check_run: *725 - installation: *720 - enterprise: *719 - organization: *721 - repository: *722 + check_run: *726 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 sender: *4 required: - check_run @@ -120063,10 +123079,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -120770,10 +123786,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -121471,10 +124487,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -121795,20 +124811,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &726 + commit_oid: &727 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *719 - installation: *720 - organization: *721 - ref: &727 + enterprise: *720 + installation: *721 + organization: *722 + ref: &728 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *722 + repository: *723 sender: *4 required: - action @@ -122216,12 +125232,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *726 - enterprise: *719 - installation: *720 - organization: *721 - ref: *727 - repository: *722 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -122504,12 +125520,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *726 - enterprise: *719 - installation: *720 - organization: *721 - ref: *727 - repository: *722 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -122855,12 +125871,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *726 - enterprise: *719 - installation: *720 - organization: *721 - ref: *727 - repository: *722 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -123150,9 +126166,9 @@ webhooks: type: - string - 'null' - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -123160,7 +126176,7 @@ webhooks: type: - string - 'null' - repository: *722 + repository: *723 sender: *4 required: - action @@ -123406,12 +126422,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *726 - enterprise: *719 - installation: *720 - organization: *721 - ref: *727 - repository: *722 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -123732,10 +126748,10 @@ webhooks: - dismissed_reason - rule - tool - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -123995,10 +127011,10 @@ webhooks: - updated_at - author_association - body - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -124079,18 +127095,18 @@ webhooks: type: - string - 'null' - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *721 - pusher_type: &728 + organization: *722 + pusher_type: &729 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &729 + ref: &730 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -124100,7 +127116,7 @@ webhooks: enum: - tag - branch - repository: *722 + repository: *723 sender: *4 required: - ref @@ -124183,9 +127199,9 @@ webhooks: enum: - created definition: *282 - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -124270,9 +127286,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -124350,9 +127366,9 @@ webhooks: enum: - promote_to_enterprise definition: *282 - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -124430,9 +127446,9 @@ webhooks: enum: - updated definition: *282 - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -124509,10 +127525,10 @@ webhooks: type: string enum: - updated - enterprise: *719 - installation: *720 - repository: *722 - organization: *721 + enterprise: *720 + installation: *721 + repository: *723 + organization: *722 sender: *4 new_property_values: type: array @@ -124597,18 +127613,18 @@ webhooks: title: delete event type: object properties: - enterprise: *719 - installation: *720 - organization: *721 - pusher_type: *728 - ref: *729 + enterprise: *720 + installation: *721 + organization: *722 + pusher_type: *729 + ref: *730 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *722 + repository: *723 sender: *4 required: - ref @@ -124689,10 +127705,10 @@ webhooks: enum: - assignees_changed alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -124773,10 +127789,10 @@ webhooks: enum: - auto_dismissed alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -124858,10 +127874,10 @@ webhooks: enum: - auto_reopened alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -124943,10 +127959,10 @@ webhooks: enum: - created alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -125026,10 +128042,10 @@ webhooks: enum: - dismissed alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -125109,10 +128125,10 @@ webhooks: enum: - fixed alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -125193,10 +128209,10 @@ webhooks: enum: - reintroduced alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -125276,10 +128292,10 @@ webhooks: enum: - reopened alert: *483 - installation: *720 - organization: *721 - enterprise: *719 - repository: *722 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -125356,9 +128372,9 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - key: &730 + enterprise: *720 + installation: *721 + key: &731 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -125396,8 +128412,8 @@ webhooks: - verified - created_at - read_only - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -125474,11 +128490,11 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - key: *730 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + key: *731 + organization: *722 + repository: *723 sender: *4 required: - action @@ -126045,12 +129061,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: &734 + workflow: &735 title: Workflow type: - object @@ -126805,9 +129821,9 @@ webhooks: pull_requests: type: array items: *575 - repository: *722 - organization: *721 - installation: *720 + repository: *723 + organization: *722 + installation: *721 sender: *4 responses: '200': @@ -126878,7 +129894,7 @@ webhooks: type: string enum: - approved - approver: &731 + approver: &732 type: object properties: avatar_url: @@ -126921,11 +129937,11 @@ webhooks: type: string comment: type: string - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - reviewers: &732 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + reviewers: &733 type: array items: type: object @@ -127006,7 +130022,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &733 + workflow_job_run: &734 type: object properties: conclusion: @@ -127752,18 +130768,18 @@ webhooks: type: string enum: - rejected - approver: *731 + approver: *732 comment: type: string - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - reviewers: *732 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + reviewers: *733 sender: *4 since: type: string - workflow_job_run: *733 + workflow_job_run: *734 workflow_job_runs: type: array items: @@ -128480,13 +131496,13 @@ webhooks: type: string enum: - requested - enterprise: *719 + enterprise: *720 environment: type: string - installation: *720 - organization: *721 - repository: *722 - requestor: &739 + installation: *721 + organization: *722 + repository: *723 + requestor: &740 title: User type: - object @@ -130419,12 +133435,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *734 + workflow: *735 workflow_run: title: Deployment Workflow Run type: @@ -131115,7 +134131,7 @@ webhooks: type: string enum: - answered - answer: &737 + answer: &738 type: object properties: author_association: @@ -131275,11 +134291,11 @@ webhooks: - created_at - updated_at - body - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131406,11 +134422,11 @@ webhooks: - from required: - category - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131493,11 +134509,11 @@ webhooks: type: string enum: - closed - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131579,7 +134595,7 @@ webhooks: type: string enum: - created - comment: &736 + comment: &737 type: object properties: author_association: @@ -131739,11 +134755,11 @@ webhooks: - updated_at - body - reactions - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131826,12 +134842,12 @@ webhooks: type: string enum: - deleted - comment: *736 - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + comment: *737 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131926,12 +134942,12 @@ webhooks: - from required: - body - comment: *736 - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + comment: *737 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -132015,11 +135031,11 @@ webhooks: type: string enum: - created - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -132101,11 +135117,11 @@ webhooks: type: string enum: - deleted - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -132205,11 +135221,11 @@ webhooks: type: string required: - from - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -132291,10 +135307,10 @@ webhooks: type: string enum: - labeled - discussion: *735 - enterprise: *719 - installation: *720 - label: &738 + discussion: *736 + enterprise: *720 + installation: *721 + label: &739 title: Label type: object properties: @@ -132327,8 +135343,8 @@ webhooks: - color - default - description - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -132411,11 +135427,11 @@ webhooks: type: string enum: - locked - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -132497,11 +135513,11 @@ webhooks: type: string enum: - pinned - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -132583,11 +135599,11 @@ webhooks: type: string enum: - reopened - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -132672,16 +135688,16 @@ webhooks: changes: type: object properties: - new_discussion: *735 - new_repository: *722 + new_discussion: *736 + new_repository: *723 required: - new_discussion - new_repository - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -132764,10 +135780,10 @@ webhooks: type: string enum: - unanswered - discussion: *735 - old_answer: *737 - organization: *721 - repository: *722 + discussion: *736 + old_answer: *738 + organization: *722 + repository: *723 sender: *4 required: - action @@ -132849,12 +135865,12 @@ webhooks: type: string enum: - unlabeled - discussion: *735 - enterprise: *719 - installation: *720 - label: *738 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -132937,11 +135953,11 @@ webhooks: type: string enum: - unlocked - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -133023,11 +136039,11 @@ webhooks: type: string enum: - unpinned - discussion: *735 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -133100,7 +136116,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *719 + enterprise: *720 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -133778,9 +136794,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - forkee @@ -133926,9 +136942,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pages: description: The pages that were updated. type: array @@ -133966,7 +136982,7 @@ webhooks: - action - sha - html_url - repository: *722 + repository: *723 sender: *4 required: - pages @@ -134042,10 +137058,10 @@ webhooks: type: string enum: - created - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories: &740 + organization: *722 + repositories: &741 description: An array of repository objects that the installation can access. type: array @@ -134071,8 +137087,8 @@ webhooks: - name - full_name - private - repository: *722 - requester: *739 + repository: *723 + requester: *740 sender: *4 required: - action @@ -134147,11 +137163,11 @@ webhooks: type: string enum: - deleted - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories: *740 - repository: *722 + organization: *722 + repositories: *741 + repository: *723 requester: type: - 'null' @@ -134228,11 +137244,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories: *740 - repository: *722 + organization: *722 + repositories: *741 + repository: *723 requester: type: - 'null' @@ -134309,10 +137325,10 @@ webhooks: type: string enum: - added - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories_added: &741 + organization: *722 + repositories_added: &742 description: An array of repository objects, which were added to the installation. type: array @@ -134358,15 +137374,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *722 - repository_selection: &742 + repository: *723 + repository_selection: &743 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *739 + requester: *740 sender: *4 required: - action @@ -134445,10 +137461,10 @@ webhooks: type: string enum: - removed - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories_added: *741 + organization: *722 + repositories_added: *742 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -134475,9 +137491,9 @@ webhooks: - name - full_name - private - repository: *722 - repository_selection: *742 - requester: *739 + repository: *723 + repository_selection: *743 + requester: *740 sender: *4 required: - action @@ -134556,11 +137572,11 @@ webhooks: type: string enum: - suspend - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories: *740 - repository: *722 + organization: *722 + repositories: *741 + repository: *723 requester: type: - 'null' @@ -134742,10 +137758,10 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 target_type: type: string @@ -134824,11 +137840,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *719 + enterprise: *720 installation: *20 - organization: *721 - repositories: *740 - repository: *722 + organization: *722 + repositories: *741 + repository: *723 requester: type: - 'null' @@ -135080,8 +138096,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -135893,8 +138909,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136255,8 +139271,8 @@ webhooks: - state - locked - assignee - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -136336,7 +139352,7 @@ webhooks: type: string enum: - deleted - comment: &743 + comment: &744 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -136507,8 +139523,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -137316,8 +140332,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137680,8 +140696,8 @@ webhooks: - state - locked - assignee - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -137761,7 +140777,7 @@ webhooks: type: string enum: - edited - changes: &767 + changes: &768 description: The changes to the comment. type: object properties: @@ -137773,9 +140789,9 @@ webhooks: type: string required: - from - comment: *743 - enterprise: *719 - installation: *720 + comment: *744 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -138586,8 +141602,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138948,8 +141964,8 @@ webhooks: - state - locked - assignee - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -139030,9 +142046,9 @@ webhooks: type: string enum: - pinned - comment: *743 - enterprise: *719 - installation: *720 + comment: *744 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -139845,8 +142861,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140209,8 +143225,8 @@ webhooks: - state - locked - assignee - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -140290,9 +143306,9 @@ webhooks: type: string enum: - unpinned - comment: *743 - enterprise: *719 - installation: *720 + comment: *744 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -141105,8 +144121,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141469,8 +144485,8 @@ webhooks: - state - locked - assignee - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -141559,9 +144575,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -141650,9 +144666,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -141740,9 +144756,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -141831,9 +144847,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -141913,10 +144929,10 @@ webhooks: type: string enum: - assigned - assignee: *739 - enterprise: *719 - installation: *720 - issue: &744 + assignee: *740 + enterprise: *720 + installation: *721 + issue: &745 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -142727,8 +145743,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -142851,8 +145867,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -142932,8 +145948,8 @@ webhooks: type: string enum: - closed - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -143749,8 +146765,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -144016,8 +147032,8 @@ webhooks: required: - state - closed_at - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -144096,8 +147112,8 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144904,8 +147920,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -145027,8 +148043,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -145107,8 +148123,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -145938,8 +148954,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -146040,7 +149056,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &745 + milestone: &746 title: Milestone description: A collection of related issues and pull requests. type: object @@ -146183,8 +149199,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -146283,8 +149299,8 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147095,8 +150111,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -147219,9 +150235,9 @@ webhooks: - active_lock_reason - body - reactions - label: *738 - organization: *721 - repository: *722 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147301,9 +150317,9 @@ webhooks: type: string enum: - field_added - enterprise: *719 - installation: *720 - issue: *744 + enterprise: *720 + installation: *721 + issue: *745 issue_field: type: object description: The issue field whose value was set or updated on the @@ -147422,8 +150438,8 @@ webhooks: - id required: - from - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147503,9 +150519,9 @@ webhooks: type: string enum: - field_removed - enterprise: *719 - installation: *720 - issue: *744 + enterprise: *720 + installation: *721 + issue: *745 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -147568,8 +150584,8 @@ webhooks: - 'null' required: - id - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147649,8 +150665,8 @@ webhooks: type: string enum: - labeled - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -148460,8 +151476,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -148584,9 +151600,9 @@ webhooks: - active_lock_reason - body - reactions - label: *738 - organization: *721 - repository: *722 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -148666,8 +151682,8 @@ webhooks: type: string enum: - locked - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -149502,8 +152518,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -149603,8 +152619,8 @@ webhooks: format: uri user_view_type: type: string - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -149683,8 +152699,8 @@ webhooks: type: string enum: - milestoned - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -150513,8 +153529,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -150614,9 +153630,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *745 - organization: *721 - repository: *722 + milestone: *746 + organization: *722 + repository: *723 sender: *4 required: - action @@ -151503,8 +154519,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -152099,8 +155115,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -152907,8 +155923,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -153034,8 +156050,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -153115,9 +156131,9 @@ webhooks: type: string enum: - pinned - enterprise: *719 - installation: *720 - issue: &746 + enterprise: *720 + installation: *721 + issue: &747 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -153922,8 +156938,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -154045,8 +157061,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -154125,8 +157141,8 @@ webhooks: type: string enum: - reopened - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -154959,8 +157975,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -155061,8 +158077,8 @@ webhooks: user_view_type: type: string type: *236 - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -155950,8 +158966,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -156564,11 +159580,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *719 - installation: *720 - issue: *746 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + issue: *747 + organization: *722 + repository: *723 sender: *4 required: - action @@ -156648,12 +159664,12 @@ webhooks: type: string enum: - typed - enterprise: *719 - installation: *720 - issue: *744 + enterprise: *720 + installation: *721 + issue: *745 type: *236 - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -156734,7 +159750,7 @@ webhooks: type: string enum: - unassigned - assignee: &770 + assignee: &771 title: User type: - object @@ -156806,11 +159822,11 @@ webhooks: required: - login - id - enterprise: *719 - installation: *720 - issue: *744 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + issue: *745 + organization: *722 + repository: *723 sender: *4 required: - action @@ -156889,12 +159905,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *719 - installation: *720 - issue: *744 - label: *738 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + issue: *745 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -156974,8 +159990,8 @@ webhooks: type: string enum: - unlocked - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -157808,8 +160824,8 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *655 - issue_dependencies_summary: *656 + sub_issues_summary: *656 + issue_dependencies_summary: *657 issue_field_values: type: array items: *538 @@ -157909,8 +160925,8 @@ webhooks: format: uri user_view_type: type: string - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -157990,11 +161006,11 @@ webhooks: type: string enum: - unpinned - enterprise: *719 - installation: *720 - issue: *746 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + issue: *747 + organization: *722 + repository: *723 sender: *4 required: - action @@ -158073,12 +161089,12 @@ webhooks: type: string enum: - untyped - enterprise: *719 - installation: *720 - issue: *744 + enterprise: *720 + installation: *721 + issue: *745 type: *236 - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -158158,11 +161174,11 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - label: *738 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -158240,11 +161256,11 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - label: *738 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -158354,11 +161370,11 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - label: *738 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -158440,9 +161456,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *719 - installation: *720 - marketplace_purchase: &747 + enterprise: *720 + installation: *721 + marketplace_purchase: &748 title: Marketplace Purchase type: object required: @@ -158530,8 +161546,8 @@ webhooks: type: integer unit_count: type: integer - organization: *721 - previous_marketplace_purchase: &748 + organization: *722 + previous_marketplace_purchase: &749 title: Marketplace Purchase type: object properties: @@ -158615,7 +161631,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *722 + repository: *723 sender: *4 required: - action @@ -158695,10 +161711,10 @@ webhooks: - changed effective_date: type: string - enterprise: *719 - installation: *720 - marketplace_purchase: *747 - organization: *721 + enterprise: *720 + installation: *721 + marketplace_purchase: *748 + organization: *722 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -158786,7 +161802,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *722 + repository: *723 sender: *4 required: - action @@ -158868,10 +161884,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *719 - installation: *720 - marketplace_purchase: *747 - organization: *721 + enterprise: *720 + installation: *721 + marketplace_purchase: *748 + organization: *722 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -158957,7 +161973,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *722 + repository: *723 sender: *4 required: - action @@ -159038,8 +162054,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 marketplace_purchase: title: Marketplace Purchase type: object @@ -159125,9 +162141,9 @@ webhooks: type: integer unit_count: type: integer - organization: *721 - previous_marketplace_purchase: *748 - repository: *722 + organization: *722 + previous_marketplace_purchase: *749 + repository: *723 sender: *4 required: - action @@ -159207,12 +162223,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *719 - installation: *720 - marketplace_purchase: *747 - organization: *721 - previous_marketplace_purchase: *748 - repository: *722 + enterprise: *720 + installation: *721 + marketplace_purchase: *748 + organization: *722 + previous_marketplace_purchase: *749 + repository: *723 sender: *4 required: - action @@ -159314,11 +162330,11 @@ webhooks: type: string required: - to - enterprise: *719 - installation: *720 - member: *739 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 sender: *4 required: - action @@ -159420,11 +162436,11 @@ webhooks: type: - string - 'null' - enterprise: *719 - installation: *720 - member: *739 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 sender: *4 required: - action @@ -159503,11 +162519,11 @@ webhooks: type: string enum: - removed - enterprise: *719 - installation: *720 - member: *739 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 sender: *4 required: - action @@ -159585,11 +162601,11 @@ webhooks: type: string enum: - added - enterprise: *719 - installation: *720 - member: *739 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 scope: description: The scope of the membership. Currently, can only be `team`. @@ -159667,7 +162683,7 @@ webhooks: required: - login - id - team: &749 + team: &750 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -159897,11 +162913,11 @@ webhooks: type: string enum: - removed - enterprise: *719 - installation: *720 - member: *739 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 scope: description: The scope of the membership. Currently, can only be `team`. @@ -159980,7 +162996,7 @@ webhooks: required: - login - id - team: *749 + team: *750 required: - action - scope @@ -160062,8 +163078,8 @@ webhooks: type: string enum: - checks_requested - installation: *720 - merge_group: &750 + installation: *721 + merge_group: &751 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -160089,8 +163105,8 @@ webhooks: - base_sha - base_ref - head_commit - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -160176,10 +163192,10 @@ webhooks: - merged - invalidated - dequeued - installation: *720 - merge_group: *750 - organization: *721 - repository: *722 + installation: *721 + merge_group: *751 + organization: *722 + repository: *723 sender: *4 required: - action @@ -160252,7 +163268,7 @@ webhooks: type: string enum: - deleted - enterprise: *719 + enterprise: *720 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -160361,12 +163377,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *720 - organization: *721 + installation: *721 + organization: *722 repository: anyOf: - type: 'null' - - *722 + - *723 sender: *4 required: - action @@ -160446,11 +163462,11 @@ webhooks: type: string enum: - closed - enterprise: *719 - installation: *720 - milestone: *745 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + milestone: *746 + organization: *722 + repository: *723 sender: *4 required: - action @@ -160529,9 +163545,9 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - milestone: &751 + enterprise: *720 + installation: *721 + milestone: &752 title: Milestone description: A collection of related issues and pull requests. type: object @@ -160673,8 +163689,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -160753,11 +163769,11 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - milestone: *745 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + milestone: *746 + organization: *722 + repository: *723 sender: *4 required: - action @@ -160867,11 +163883,11 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - milestone: *745 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + milestone: *746 + organization: *722 + repository: *723 sender: *4 required: - action @@ -160951,11 +163967,11 @@ webhooks: type: string enum: - opened - enterprise: *719 - installation: *720 - milestone: *751 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + milestone: *752 + organization: *722 + repository: *723 sender: *4 required: - action @@ -161034,11 +164050,11 @@ webhooks: type: string enum: - blocked - blocked_user: *739 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + blocked_user: *740 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -161117,11 +164133,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *739 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + blocked_user: *740 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -161200,9 +164216,9 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - membership: &752 + enterprise: *720 + installation: *721 + membership: &753 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -161312,8 +164328,8 @@ webhooks: - role - organization_url - user - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 required: - action @@ -161391,11 +164407,11 @@ webhooks: type: string enum: - member_added - enterprise: *719 - installation: *720 - membership: *752 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + membership: *753 + organization: *722 + repository: *723 sender: *4 required: - action @@ -161474,8 +164490,8 @@ webhooks: type: string enum: - member_invited - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -161597,10 +164613,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 - user: *739 + user: *740 required: - action - invitation @@ -161678,11 +164694,11 @@ webhooks: type: string enum: - member_removed - enterprise: *719 - installation: *720 - membership: *752 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + membership: *753 + organization: *722 + repository: *723 sender: *4 required: - action @@ -161769,11 +164785,11 @@ webhooks: properties: from: type: string - enterprise: *719 - installation: *720 - membership: *752 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + membership: *753 + organization: *722 + repository: *723 sender: *4 required: - action @@ -161850,9 +164866,9 @@ webhooks: type: string enum: - published - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 package: description: Information about the package. type: object @@ -162375,7 +165391,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &753 + items: &754 title: Ruby Gems metadata type: object properties: @@ -162472,7 +165488,7 @@ webhooks: - owner - package_version - registry - repository: *722 + repository: *723 sender: *4 required: - action @@ -162548,9 +165564,9 @@ webhooks: type: string enum: - updated - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 package: description: Information about the package. type: object @@ -162912,7 +165928,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *753 + items: *754 source_url: type: string format: uri @@ -162983,7 +165999,7 @@ webhooks: - owner - package_version - registry - repository: *722 + repository: *723 sender: *4 required: - action @@ -163163,12 +166179,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *719 + enterprise: *720 id: type: integer - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - id @@ -163245,7 +166261,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &754 + personal_access_token_request: &755 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -163395,10 +166411,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *719 - organization: *721 + enterprise: *720 + organization: *722 sender: *4 - installation: *720 + installation: *721 required: - action - personal_access_token_request @@ -163475,11 +166491,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *754 - enterprise: *719 - organization: *721 + personal_access_token_request: *755 + enterprise: *720 + organization: *722 sender: *4 - installation: *720 + installation: *721 required: - action - personal_access_token_request @@ -163555,11 +166571,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *754 - enterprise: *719 - organization: *721 + personal_access_token_request: *755 + enterprise: *720 + organization: *722 sender: *4 - installation: *720 + installation: *721 required: - action - personal_access_token_request @@ -163634,11 +166650,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *754 - organization: *721 - enterprise: *719 + personal_access_token_request: *755 + organization: *722 + enterprise: *720 sender: *4 - installation: *720 + installation: *721 required: - action - personal_access_token_request @@ -163743,7 +166759,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *755 + last_response: *756 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -163775,8 +166791,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 zen: description: Random string of GitHub zen. @@ -164021,10 +167037,10 @@ webhooks: - from required: - note - enterprise: *719 - installation: *720 - organization: *721 - project_card: &756 + enterprise: *720 + installation: *721 + organization: *722 + project_card: &757 title: Project Card type: object properties: @@ -164147,7 +167163,7 @@ webhooks: - creator - created_at - updated_at - repository: *722 + repository: *723 sender: *4 required: - action @@ -164228,11 +167244,11 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - project_card: *756 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project_card: *757 + repository: *723 sender: *4 required: - action @@ -164312,9 +167328,9 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 project_card: title: Project Card type: object @@ -164444,7 +167460,7 @@ webhooks: repository: anyOf: - type: 'null' - - *722 + - *723 sender: *4 required: - action @@ -164538,11 +167554,11 @@ webhooks: - from required: - note - enterprise: *719 - installation: *720 - organization: *721 - project_card: *756 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project_card: *757 + repository: *723 sender: *4 required: - action @@ -164636,9 +167652,9 @@ webhooks: - from required: - column_id - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 project_card: allOf: - title: Project Card @@ -164835,7 +167851,7 @@ webhooks: type: string required: - after_id - repository: *722 + repository: *723 sender: *4 required: - action @@ -164915,10 +167931,10 @@ webhooks: type: string enum: - closed - enterprise: *719 - installation: *720 - organization: *721 - project: &758 + enterprise: *720 + installation: *721 + organization: *722 + project: &759 title: Project type: object properties: @@ -165045,7 +168061,7 @@ webhooks: - creator - created_at - updated_at - repository: *722 + repository: *723 sender: *4 required: - action @@ -165125,10 +168141,10 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - project_column: &757 + enterprise: *720 + installation: *721 + organization: *722 + project_column: &758 title: Project Column type: object properties: @@ -165168,7 +168184,7 @@ webhooks: - name - created_at - updated_at - repository: *722 + repository: *723 sender: *4 required: - action @@ -165247,14 +168263,14 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - project_column: *757 + enterprise: *720 + installation: *721 + organization: *722 + project_column: *758 repository: anyOf: - type: 'null' - - *722 + - *723 sender: *4 required: - action @@ -165343,11 +168359,11 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - organization: *721 - project_column: *757 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project_column: *758 + repository: *723 sender: *4 required: - action @@ -165427,11 +168443,11 @@ webhooks: type: string enum: - moved - enterprise: *719 - installation: *720 - organization: *721 - project_column: *757 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project_column: *758 + repository: *723 sender: *4 required: - action @@ -165511,11 +168527,11 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - project: *758 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project: *759 + repository: *723 sender: *4 required: - action @@ -165595,14 +168611,14 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - project: *758 + enterprise: *720 + installation: *721 + organization: *722 + project: *759 repository: anyOf: - type: 'null' - - *722 + - *723 sender: *4 required: - action @@ -165703,11 +168719,11 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - organization: *721 - project: *758 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project: *759 + repository: *723 sender: *4 required: - action @@ -165786,11 +168802,11 @@ webhooks: type: string enum: - reopened - enterprise: *719 - installation: *720 - organization: *721 - project: *758 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + project: *759 + repository: *723 sender: *4 required: - action @@ -165871,8 +168887,8 @@ webhooks: type: string enum: - closed - installation: *720 - organization: *721 + installation: *721 + organization: *722 projects_v2: *269 sender: *4 required: @@ -165954,8 +168970,8 @@ webhooks: type: string enum: - created - installation: *720 - organization: *721 + installation: *721 + organization: *722 projects_v2: *269 sender: *4 required: @@ -166037,8 +169053,8 @@ webhooks: type: string enum: - deleted - installation: *720 - organization: *721 + installation: *721 + organization: *722 projects_v2: *269 sender: *4 required: @@ -166160,8 +169176,8 @@ webhooks: type: string to: type: string - installation: *720 - organization: *721 + installation: *721 + organization: *722 projects_v2: *269 sender: *4 required: @@ -166245,7 +169261,7 @@ webhooks: type: string enum: - archived - changes: &762 + changes: &763 type: object properties: archived_at: @@ -166261,9 +169277,9 @@ webhooks: - string - 'null' format: date-time - installation: *720 - organization: *721 - projects_v2_item: &759 + installation: *721 + organization: *722 + projects_v2_item: &760 title: Projects v2 Item description: An item belonging to a project type: object @@ -166403,9 +169419,9 @@ webhooks: - 'null' to: type: string - installation: *720 - organization: *721 - projects_v2_item: *759 + installation: *721 + organization: *722 + projects_v2_item: *760 sender: *4 required: - action @@ -166487,9 +169503,9 @@ webhooks: type: string enum: - created - installation: *720 - organization: *721 - projects_v2_item: *759 + installation: *721 + organization: *722 + projects_v2_item: *760 sender: *4 required: - action @@ -166570,9 +169586,9 @@ webhooks: type: string enum: - deleted - installation: *720 - organization: *721 - projects_v2_item: *759 + installation: *721 + organization: *722 + projects_v2_item: *760 sender: *4 required: - action @@ -166677,7 +169693,7 @@ webhooks: oneOf: - type: string - type: integer - - &760 + - &761 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -166701,7 +169717,7 @@ webhooks: required: - id - name - - &761 + - &762 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -166741,8 +169757,8 @@ webhooks: oneOf: - type: string - type: integer - - *760 - *761 + - *762 type: - 'null' - string @@ -166765,9 +169781,9 @@ webhooks: - 'null' required: - body - installation: *720 - organization: *721 - projects_v2_item: *759 + installation: *721 + organization: *722 + projects_v2_item: *760 sender: *4 required: - action @@ -166864,9 +169880,9 @@ webhooks: type: - string - 'null' - installation: *720 - organization: *721 - projects_v2_item: *759 + installation: *721 + organization: *722 + projects_v2_item: *760 sender: *4 required: - action @@ -166949,10 +169965,10 @@ webhooks: type: string enum: - restored - changes: *762 - installation: *720 - organization: *721 - projects_v2_item: *759 + changes: *763 + installation: *721 + organization: *722 + projects_v2_item: *760 sender: *4 required: - action @@ -167034,8 +170050,8 @@ webhooks: type: string enum: - reopened - installation: *720 - organization: *721 + installation: *721 + organization: *722 projects_v2: *269 sender: *4 required: @@ -167117,9 +170133,9 @@ webhooks: type: string enum: - created - installation: *720 - organization: *721 - projects_v2_status_update: *763 + installation: *721 + organization: *722 + projects_v2_status_update: *764 sender: *4 required: - action @@ -167200,9 +170216,9 @@ webhooks: type: string enum: - deleted - installation: *720 - organization: *721 - projects_v2_status_update: *763 + installation: *721 + organization: *722 + projects_v2_status_update: *764 sender: *4 required: - action @@ -167348,9 +170364,9 @@ webhooks: - string - 'null' format: date - installation: *720 - organization: *721 - projects_v2_status_update: *763 + installation: *721 + organization: *722 + projects_v2_status_update: *764 sender: *4 required: - action @@ -167421,10 +170437,10 @@ webhooks: title: public event type: object properties: - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - repository @@ -167501,13 +170517,13 @@ webhooks: type: string enum: - assigned - assignee: *739 - enterprise: *719 - installation: *720 - number: &764 + assignee: *740 + enterprise: *720 + installation: *721 + number: &765 description: The pull request number. type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -169878,7 +172894,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -169975,11 +172991,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -172343,7 +175359,7 @@ webhooks: - draft reason: type: string - repository: *722 + repository: *723 sender: *4 required: - action @@ -172440,11 +175456,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -174808,7 +177824,7 @@ webhooks: - draft reason: type: string - repository: *722 + repository: *723 sender: *4 required: - action @@ -174905,11 +177921,11 @@ webhooks: type: string enum: - closed - enterprise: *719 - installation: *720 - number: *764 - organization: *721 - pull_request: &765 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 + pull_request: &766 allOf: - *575 - type: object @@ -174973,7 +177989,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *722 + repository: *723 sender: *4 required: - action @@ -175054,12 +178070,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *719 - installation: *720 - number: *764 - organization: *721 - pull_request: *765 - repository: *722 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 + pull_request: *766 + repository: *723 sender: *4 required: - action @@ -175139,11 +178155,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *719 + enterprise: *720 milestone: *272 - number: *764 - organization: *721 - pull_request: &766 + number: *765 + organization: *722 + pull_request: &767 title: Pull Request type: object properties: @@ -177534,7 +180550,7 @@ webhooks: - active_lock_reason - draft version: '2026-03-10' - repository: *722 + repository: *723 sender: *4 required: - action @@ -177613,11 +180629,11 @@ webhooks: type: string enum: - dequeued - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -179985,7 +183001,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *722 + repository: *723 sender: *4 required: - action @@ -180117,12 +183133,12 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - number: *764 - organization: *721 - pull_request: *765 - repository: *722 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 + pull_request: *766 + repository: *723 sender: *4 required: - action @@ -180202,11 +183218,11 @@ webhooks: type: string enum: - enqueued - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -182559,7 +185575,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -182647,11 +185663,11 @@ webhooks: type: string enum: - labeled - enterprise: *719 - installation: *720 - label: *738 - number: *764 - organization: *721 + enterprise: *720 + installation: *721 + label: *739 + number: *765 + organization: *722 pull_request: title: Pull Request type: object @@ -185021,7 +188037,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -185117,10 +188133,10 @@ webhooks: type: string enum: - locked - enterprise: *719 - installation: *720 - number: *764 - organization: *721 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 pull_request: title: Pull Request type: object @@ -187488,7 +190504,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -187583,12 +190599,12 @@ webhooks: type: string enum: - milestoned - enterprise: *719 + enterprise: *720 milestone: *272 - number: *764 - organization: *721 - pull_request: *766 - repository: *722 + number: *765 + organization: *722 + pull_request: *767 + repository: *723 sender: *4 required: - action @@ -187667,12 +190683,12 @@ webhooks: type: string enum: - opened - enterprise: *719 - installation: *720 - number: *764 - organization: *721 - pull_request: *765 - repository: *722 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 + pull_request: *766 + repository: *723 sender: *4 required: - action @@ -187753,12 +190769,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *719 - installation: *720 - number: *764 - organization: *721 - pull_request: *765 - repository: *722 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 + pull_request: *766 + repository: *723 sender: *4 required: - action @@ -187838,12 +190854,12 @@ webhooks: type: string enum: - reopened - enterprise: *719 - installation: *720 - number: *764 - organization: *721 - pull_request: *765 - repository: *722 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 + pull_request: *766 + repository: *723 sender: *4 required: - action @@ -188218,9 +191234,9 @@ webhooks: - start_side - side - reactions - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: type: object properties: @@ -190472,7 +193488,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *722 + repository: *723 sender: *4 required: - action @@ -190567,7 +193583,7 @@ webhooks: type: string enum: - deleted - comment: &768 + comment: &769 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -190860,9 +193876,9 @@ webhooks: - start_side - side - reactions - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: type: object properties: @@ -193102,7 +196118,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *722 + repository: *723 sender: *4 required: - action @@ -193197,11 +196213,11 @@ webhooks: type: string enum: - edited - changes: *767 - comment: *768 - enterprise: *719 - installation: *720 - organization: *721 + changes: *768 + comment: *769 + enterprise: *720 + installation: *721 + organization: *722 pull_request: type: object properties: @@ -195444,7 +198460,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *722 + repository: *723 sender: *4 required: - action @@ -195540,9 +198556,9 @@ webhooks: type: string enum: - dismissed - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -197797,7 +200813,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *722 + repository: *723 review: description: The review that was affected. type: object @@ -198063,9 +201079,9 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -200179,8 +203195,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *722 - review: &769 + repository: *723 + review: &770 description: The review that was affected. type: object properties: @@ -200426,12 +203442,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -202800,7 +205816,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 requested_reviewer: title: User type: @@ -202886,12 +205902,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -205267,7 +208283,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 requested_team: title: Team description: Groups of organization members that gives permissions @@ -205485,12 +208501,12 @@ webhooks: type: string enum: - review_requested - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -207861,7 +210877,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 requested_reviewer: title: User type: @@ -207948,12 +210964,12 @@ webhooks: type: string enum: - review_requested - enterprise: *719 - installation: *720 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *721 + organization: *722 pull_request: title: Pull Request type: object @@ -210315,7 +213331,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 requested_team: title: Team description: Groups of organization members that gives permissions @@ -210522,9 +213538,9 @@ webhooks: type: string enum: - submitted - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -212782,8 +215798,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *722 - review: *769 + repository: *723 + review: *770 sender: *4 required: - action @@ -212878,9 +215894,9 @@ webhooks: type: string enum: - resolved - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -215033,7 +218049,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *722 + repository: *723 sender: *4 thread: type: object @@ -215438,9 +218454,9 @@ webhooks: type: string enum: - unresolved - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -217576,7 +220592,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *722 + repository: *723 sender: *4 thread: type: object @@ -217983,10 +220999,10 @@ webhooks: type: string before: type: string - enterprise: *719 - installation: *720 - number: *764 - organization: *721 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 pull_request: title: Pull Request type: object @@ -220343,7 +223359,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -220440,11 +223456,11 @@ webhooks: type: string enum: - unassigned - assignee: *770 - enterprise: *719 - installation: *720 - number: *764 - organization: *721 + assignee: *771 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 pull_request: title: Pull Request type: object @@ -222816,7 +225832,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -222910,11 +225926,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *719 - installation: *720 - label: *738 - number: *764 - organization: *721 + enterprise: *720 + installation: *721 + label: *739 + number: *765 + organization: *722 pull_request: title: Pull Request type: object @@ -225275,7 +228291,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -225371,10 +228387,10 @@ webhooks: type: string enum: - unlocked - enterprise: *719 - installation: *720 - number: *764 - organization: *721 + enterprise: *720 + installation: *721 + number: *765 + organization: *722 pull_request: title: Pull Request type: object @@ -227725,7 +230741,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *722 + repository: *723 sender: *4 required: - action @@ -227943,7 +230959,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *719 + enterprise: *720 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -228038,8 +231054,8 @@ webhooks: - url - author - committer - installation: *720 - organization: *721 + installation: *721 + organization: *722 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -228638,9 +231654,9 @@ webhooks: type: string enum: - published - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 registry_package: type: object properties: @@ -229117,7 +232133,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *753 + items: *754 summary: type: string tag_name: @@ -229173,7 +232189,7 @@ webhooks: - owner - package_version - registry - repository: *722 + repository: *723 sender: *4 required: - action @@ -229251,9 +232267,9 @@ webhooks: type: string enum: - updated - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 registry_package: type: object properties: @@ -229565,7 +232581,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *753 + items: *754 summary: type: string tag_name: @@ -229615,7 +232631,7 @@ webhooks: - owner - package_version - registry - repository: *722 + repository: *723 sender: *4 required: - action @@ -229692,10 +232708,10 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - release: &771 + enterprise: *720 + installation: *721 + organization: *722 + release: &772 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -230026,7 +233042,7 @@ webhooks: - updated_at - zipball_url - body - repository: *722 + repository: *723 sender: *4 required: - action @@ -230103,11 +233119,11 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - release: *771 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + release: *772 + repository: *723 sender: *4 required: - action @@ -230224,11 +233240,11 @@ webhooks: type: boolean required: - to - enterprise: *719 - installation: *720 - organization: *721 - release: *771 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + release: *772 + repository: *723 sender: *4 required: - action @@ -230306,9 +233322,9 @@ webhooks: type: string enum: - prereleased - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -230644,7 +233660,7 @@ webhooks: - string - 'null' format: uri - repository: *722 + repository: *723 sender: *4 required: - action @@ -230720,10 +233736,10 @@ webhooks: type: string enum: - published - enterprise: *719 - installation: *720 - organization: *721 - release: &772 + enterprise: *720 + installation: *721 + organization: *722 + release: &773 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -231056,7 +234072,7 @@ webhooks: - string - 'null' format: uri - repository: *722 + repository: *723 sender: *4 required: - action @@ -231132,11 +234148,11 @@ webhooks: type: string enum: - released - enterprise: *719 - installation: *720 - organization: *721 - release: *771 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + release: *772 + repository: *723 sender: *4 required: - action @@ -231212,11 +234228,11 @@ webhooks: type: string enum: - unpublished - enterprise: *719 - installation: *720 - organization: *721 - release: *772 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + release: *773 + repository: *723 sender: *4 required: - action @@ -231292,11 +234308,11 @@ webhooks: type: string enum: - published - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - repository_advisory: *642 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + repository_advisory: *643 sender: *4 required: - action @@ -231372,11 +234388,11 @@ webhooks: type: string enum: - reported - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - repository_advisory: *642 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + repository_advisory: *643 sender: *4 required: - action @@ -231452,10 +234468,10 @@ webhooks: type: string enum: - archived - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -231532,10 +234548,10 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -231613,10 +234629,10 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -231701,10 +234717,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -231819,10 +234835,10 @@ webhooks: - 'null' items: type: string - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -231894,10 +234910,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 status: type: string @@ -231978,10 +234994,10 @@ webhooks: type: string enum: - privatized - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -232058,10 +235074,10 @@ webhooks: type: string enum: - publicized - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -232155,10 +235171,10 @@ webhooks: - name required: - repository - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -232238,10 +235254,10 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 repository_ruleset: *314 sender: *4 required: @@ -232320,10 +235336,10 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 repository_ruleset: *314 sender: *4 required: @@ -232402,10 +235418,10 @@ webhooks: type: string enum: - edited - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 repository_ruleset: *314 changes: type: object @@ -232713,10 +235729,10 @@ webhooks: - from required: - owner - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -232794,10 +235810,10 @@ webhooks: type: string enum: - unarchived - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -232875,7 +235891,7 @@ webhooks: type: string enum: - create - alert: &773 + alert: &774 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -233000,10 +236016,10 @@ webhooks: enum: - auto_dismissed - open - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -233213,10 +236229,10 @@ webhooks: type: string enum: - dismissed - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -233294,11 +236310,11 @@ webhooks: type: string enum: - reopen - alert: *773 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + alert: *774 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -233500,10 +236516,10 @@ webhooks: enum: - fixed - open - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -233581,7 +236597,7 @@ webhooks: type: string enum: - assigned - alert: &774 + alert: &775 type: object properties: number: *171 @@ -233721,10 +236737,10 @@ webhooks: - type: 'null' - *4 assignee: *4 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -233802,11 +236818,11 @@ webhooks: type: string enum: - created - alert: *774 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + alert: *775 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -233887,11 +236903,11 @@ webhooks: type: string enum: - created - alert: *774 - installation: *720 - location: *775 - organization: *721 - repository: *722 + alert: *775 + installation: *721 + location: *776 + organization: *722 + repository: *723 sender: *4 required: - location @@ -234129,11 +237145,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *774 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + alert: *775 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -234211,11 +237227,11 @@ webhooks: type: string enum: - reopened - alert: *774 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + alert: *775 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -234293,11 +237309,11 @@ webhooks: type: string enum: - resolved - alert: *774 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + alert: *775 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -234375,12 +237391,12 @@ webhooks: type: string enum: - unassigned - alert: *774 + alert: *775 assignee: *4 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -234458,11 +237474,11 @@ webhooks: type: string enum: - validated - alert: *774 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + alert: *775 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -234592,10 +237608,10 @@ webhooks: - organization - enterprise - - repository: *722 - enterprise: *719 - installation: *720 - organization: *721 + repository: *723 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -234673,11 +237689,11 @@ webhooks: type: string enum: - published - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - security_advisory: &776 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + security_advisory: &777 description: The details of the security advisory, including summary, description, and severity. type: object @@ -234881,11 +237897,11 @@ webhooks: type: string enum: - updated - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 - security_advisory: *776 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + security_advisory: *777 sender: *4 required: - action @@ -234958,10 +237974,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -235156,9 +238172,9 @@ webhooks: type: object properties: security_and_analysis: *287 - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 repository: *334 sender: *4 required: @@ -235237,12 +238253,12 @@ webhooks: type: string enum: - cancelled - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: &777 + sponsorship: &778 type: object properties: created_at: @@ -235547,12 +238563,12 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *777 + sponsorship: *778 required: - action - sponsorship @@ -235640,12 +238656,12 @@ webhooks: type: string required: - from - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *777 + sponsorship: *778 required: - action - changes @@ -235722,17 +238738,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &778 + effective_date: &779 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *777 + sponsorship: *778 required: - action - sponsorship @@ -235806,7 +238822,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &779 + changes: &780 type: object properties: tier: @@ -235850,13 +238866,13 @@ webhooks: - from required: - tier - effective_date: *778 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + effective_date: *779 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *777 + sponsorship: *778 required: - action - changes @@ -235933,13 +238949,13 @@ webhooks: type: string enum: - tier_changed - changes: *779 - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + changes: *780 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *777 + sponsorship: *778 required: - action - changes @@ -236013,10 +239029,10 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -236100,10 +239116,10 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -236537,15 +239553,15 @@ webhooks: type: - string - 'null' - enterprise: *719 + enterprise: *720 id: description: The unique identifier of the status. type: integer - installation: *720 + installation: *721 name: type: string - organization: *721 - repository: *722 + organization: *722 + repository: *723 sender: *4 sha: description: The Commit SHA. @@ -236661,9 +239677,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -236753,9 +239769,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -236845,9 +239861,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -236937,9 +239953,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *720 - organization: *721 - repository: *722 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -237016,12 +240032,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - team: &780 + team: &781 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -237251,9 +240267,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -237723,7 +240739,7 @@ webhooks: - topics - visibility sender: *4 - team: *780 + team: *781 required: - action - team @@ -237799,9 +240815,9 @@ webhooks: type: string enum: - created - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -238271,7 +241287,7 @@ webhooks: - topics - visibility sender: *4 - team: *780 + team: *781 required: - action - team @@ -238348,9 +241364,9 @@ webhooks: type: string enum: - deleted - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -238820,7 +241836,7 @@ webhooks: - topics - visibility sender: *4 - team: *780 + team: *781 required: - action - team @@ -238964,9 +241980,9 @@ webhooks: - from required: - permissions - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -239436,7 +242452,7 @@ webhooks: - topics - visibility sender: *4 - team: *780 + team: *781 required: - action - changes @@ -239514,9 +242530,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *719 - installation: *720 - organization: *721 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -239986,7 +243002,7 @@ webhooks: - topics - visibility sender: *4 - team: *780 + team: *781 required: - action - team @@ -240062,10 +243078,10 @@ webhooks: type: string enum: - started - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -240138,17 +243154,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *719 + enterprise: *720 inputs: type: - object - 'null' additionalProperties: true - installation: *720 - organization: *721 + installation: *721 + organization: *722 ref: type: string - repository: *722 + repository: *723 sender: *4 workflow: type: string @@ -240230,10 +243246,10 @@ webhooks: type: string enum: - completed - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: allOf: @@ -240568,10 +243584,10 @@ webhooks: type: string enum: - in_progress - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: allOf: @@ -240932,10 +243948,10 @@ webhooks: type: string enum: - queued - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: type: object @@ -241160,10 +244176,10 @@ webhooks: type: string enum: - waiting - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: type: object @@ -241390,12 +244406,12 @@ webhooks: type: string enum: - completed - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *734 + workflow: *735 workflow_run: title: Workflow Run type: object @@ -242414,12 +245430,12 @@ webhooks: type: string enum: - in_progress - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *734 + workflow: *735 workflow_run: title: Workflow Run type: object @@ -243423,12 +246439,12 @@ webhooks: type: string enum: - requested - enterprise: *719 - installation: *720 - organization: *721 - repository: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *734 + workflow: *735 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 540dc227f..1ed6a03c5 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -2244,6 +2244,3174 @@ } } }, + "/agents/repos/{owner}/{repo}/tasks": { + "get": { + "summary": "List tasks for repository", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n\n**Fine-grained access tokens for \"List tasks for repository\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#list-tasks-for-repository" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Start a task", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nStarts a new Copilot cloud agent task for a repository.\n\nThis endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription.\n\n**Fine-grained access tokens for \"Start a task\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read and write)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/create-task-in-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#start-a-task" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + } + ], + "requestBody": { + "required": true, + "description": "The task creation parameters, including the user's prompt and optional agent settings.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "prompt" + ], + "properties": { + "prompt": { + "type": "string", + "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`" + }, + "create_pull_request": { + "type": "boolean", + "description": "Whether to create a PR.", + "default": false + }, + "base_ref": { + "type": "string", + "description": "Base ref for new branch/PR" + } + } + }, + "examples": { + "default": { + "value": { + "prompt": "Fix the login button on the homepage", + "base_ref": "main" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Task created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "queued", + "session_count": 1, + "artifacts": [], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "400": { + "description": "Problems parsing JSON", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/repos/{owner}/{repo}/tasks/{task_id}": { + "get": { + "summary": "Get a task by repo", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n\n**Fine-grained access tokens for \"Get a task by repo\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-repo-and-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#get-a-task-by-repo" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "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": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks": { + "get": { + "summary": "List tasks", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n\n**Fine-grained access tokens for \"List tasks\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#list-tasks" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks/{task_id}": { + "get": { + "summary": "Get a task by ID", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n\n**Fine-grained access tokens for \"Get a task by ID\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#get-a-task-by-id" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "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": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, "/app": { "get": { "summary": "Get the authenticated app", @@ -70633,6 +73801,15 @@ "type": "boolean", "default": false } + }, + { + "name": "is_bypassed", + "in": "query", + "description": "A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -158008,7 +161185,7 @@ "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { "post": { "summary": "Set cluster deployment records", - "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.", + "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.\nNote: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments\narray resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use\nthe artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can\nonly have one name and version.", "tags": [ "orgs" ], @@ -158067,20 +161244,20 @@ "properties": { "name": { "type": "string", - "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", + "description": "The name of the artifact.", "minLength": 1, "maxLength": 256 }, "digest": { "type": "string", - "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", + "description": "The hex encoded digest of the artifact.", "minLength": 71, "maxLength": 71, "pattern": "^sha256:[a-f0-9]{64}$" }, "version": { "type": "string", - "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", + "description": "The artifact version.", "maxLength": 100, "x-multi-segment": true, "examples": [ @@ -254165,7 +257342,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -254250,6 +257428,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -254402,7 +257588,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -254493,7 +257679,7 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication.", "type": "string", "enum": [ "token", @@ -254501,7 +257687,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -254537,7 +257724,7 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { @@ -254555,6 +257742,14 @@ "api_host": { "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", "type": "string" + }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). Required when `auth_type` is `oidc_gcp`.", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).", + "type": "string" } }, "required": [ @@ -254613,6 +257808,17 @@ "service_slug": "my-service-account", "audience": "https://github.com/my-org" } + }, + "org-private-registry-with-oidc-gcp": { + "summary": "Example of an OIDC private registry configuration using Google Cloud Artifact Registry", + "value": { + "registry_type": "docker_registry", + "url": "https://us-docker.pkg.dev/my-project/my-repo", + "auth_type": "oidc_gcp", + "visibility": "all", + "workload_identity_provider": "projects/123456789/locations/global/workloadIdentityPools/github-pool/providers/github-provider", + "service_account": "dependabot@my-project.iam.gserviceaccount.com" + } } } } @@ -254664,7 +257870,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -254753,6 +257960,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -255092,7 +258307,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -255177,6 +258393,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -255245,7 +258469,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -255353,7 +258577,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -255389,7 +258614,7 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { @@ -255407,6 +258632,14 @@ "api_host": { "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", "type": "string" + }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). Required when `auth_type` is `oidc_gcp`.", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).", + "type": "string" } } }, @@ -304188,6 +307421,15 @@ "type": "boolean", "default": false } + }, + { + "name": "is_bypassed", + "in": "query", + "description": "A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -334428,25 +337670,547 @@ } }, { - "name": "cache_id", - "description": "The unique identifier of the GitHub Actions cache.", + "name": "cache_id", + "description": "The unique identifier of the GitHub Actions cache.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/concurrency_groups": { + "get": { + "summary": "List concurrency groups for a repository", + "description": "Lists the active concurrency groups for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-concurrency-groups-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Concurrency Group List", + "description": "A list of active concurrency groups for a repository.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "last_acquired_at" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "last_acquired_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "last_acquired_at": "2026-01-15T16:14:23Z" + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "last_acquired_at": "2026-01-15T16:13:55Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "concurrency-groups" + } + } + }, + "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}": { + "get": { + "summary": "Get a concurrency group for a repository", + "description": "Gets a specific concurrency group for a repository, including all instances in the group's queue.\nReturns 404 if the group is inactive or does not exist.\n\nOptionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items\nahead of the specified workflow run or job in the queue, plus the specified item itself\n(returned as the last element). This is useful for determining what is blocking a particular\nrun or job. Returns 422 if the specified run or job is not in this concurrency group.\n\nWhen using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow\nleases held on behalf of that run. Job-level leases within the run are not considered to\nblock the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow\nleases on the job's ancestor paths.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/get-concurrency-group-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "concurrency_group_name", + "description": "The name of the concurrency group.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "ahead_of_run", + "description": "Filter to items ahead of this workflow run ID in the queue, plus the run itself.\nMatches workflow-level concurrency and reusable-workflow leases held on behalf of\nthe run. Mutually exclusive with `ahead_of_job`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + }, + { + "name": "ahead_of_job", + "description": "Filter to items ahead of this job ID in the queue, plus the job itself.\nMatches job-level concurrency and reusable-workflow leases on the job's\nancestor paths. Mutually exclusive with `ahead_of_run`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 } } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Concurrency Group", + "description": "A concurrency group with the workflow runs and jobs that are either currently holding\nor waiting for the concurrency group lease.", + "type": "object", + "required": [ + "group_name", + "group_url", + "total_count", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "total_count": { + "type": "integer" + }, + "group_members": { + "type": "array", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "job_id": { + "type": "integer", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "total_count": 3, + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress" + }, + { + "run_id": 30433643, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433643", + "status": "pending" + }, + { + "run_id": 30433644, + "run_name": "Deploy hotfix", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644", + "job_id": 798245260, + "job_name": "deploy", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260", + "status": "pending" + } + ] + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "concurrency-groups" } } }, @@ -351886,99 +355650,386 @@ } }, { - "name": "attempt_number", - "description": "The attempt number of the workflow run.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "302": { - "description": "Response", - "headers": { - "Location": { - "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "workflow-runs" - } - } - }, - "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { - "post": { - "summary": "Cancel a workflow run", - "description": "Cancels a workflow run using its `id`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/cancel-workflow-run", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#cancel-a-workflow-run" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "attempt_number", + "description": "The attempt number of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + "post": { + "summary": "Cancel a workflow run", + "description": "Cancels a workflow run using its `id`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/cancel-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#cancel-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The unique identifier of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups": { + "get": { + "summary": "List concurrency groups for a workflow run", + "description": "Lists all concurrency groups associated with a workflow run or its jobs.\n\nThe set of groups is derived from the run's configuration, so a group is\nincluded even when the run no longer has any items currently holding or\nwaiting in it. In that case the `group_members` array will be empty.\n`total_count` reflects the number of groups the run participates in by\nconfiguration, not the number with active items.\n\nThis differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`,\nwhich returns 404 when a group has no active items. That endpoint reports\nthe live state of a group repo-wide, while this endpoint reports the\ngroups associated with a specific run by configuration.\n\nResults are sorted by group name and support cursor-based pagination via\n`before` and `after`. The `after` cursor paginates forward only and does\nnot emit a `rel=\"prev\"` Link; use `before` to page backward from a\nforward page's `next` cursor.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-concurrency-groups-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The unique identifier of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 } }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, "schema": { "type": "string" } }, { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "path", - "required": true, + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, "schema": { - "type": "integer" + "type": "string" } } ], "responses": { - "202": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", + "title": "Concurrency Group Run List", + "description": "A list of concurrency groups associated with a workflow run.", "type": "object", - "properties": {}, - "additionalProperties": false + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer", + "description": "The total number of concurrency groups this workflow run participates in,\nderived from the run's configuration. This count is not filtered by\nwhether the run currently holds or is waiting in each group, so it can\ninclude groups whose `group_members` array is empty (for example, when\nthe run has already released its lease in that group)." + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group. May return 404 if the group\nhas no active items at the time it is requested, since the\nget-by-name endpoint reports the live repo-wide state of a group\nwhile this endpoint lists groups associated with a run by\nconfiguration." + }, + "group_members": { + "type": "array", + "description": "Items belonging to this workflow run that are either currently holding or\nwaiting for the concurrency group lease. May be empty if the run no\nlonger has any active or queued items in this group.", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status", + "position", + "position_url" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "position": { + "type": "integer", + "description": "Queue position. 0 means the item holds the concurrency lease (in_progress), 1 or higher means queued (pending)." + }, + "position_url": { + "type": "string", + "format": "uri", + "description": "API URL to get items ahead of this item in the concurrency group." + }, + "job_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": [ + "string", + "null" + ], + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } }, "examples": { "default": { - "value": null + "value": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress", + "position": 0, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642" + } + ] + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "pending", + "position": 2, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260", + "job_id": 798245260, + "job_name": "build", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260" + } + ] + } + ] + } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, - "409": { - "description": "Conflict", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -352002,13 +356053,88 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "workflow-runs" + "subcategory": "concurrency-groups" } } }, @@ -698035,6 +702161,15 @@ "type": "boolean", "default": false } + }, + { + "name": "is_bypassed", + "in": "query", + "description": "A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 8f3d45e06..fecc731fd 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -920,7 +920,7 @@ paths: - subscriptions_url - type - url - type: &449 + type: &450 type: string description: The type of credit the user is receiving. enum: @@ -1086,7 +1086,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &755 + - &756 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1176,6 +1176,2530 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories + "/agents/repos/{owner}/{repo}/tasks": + get: + summary: List tasks for repository + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for a specific repository + + **Fine-grained access tokens for "List tasks for repository"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/list-tasks-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#list-tasks-for-repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, + `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived + tasks. When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + - name: creator_id + in: query + schema: + type: integer + description: Filter tasks by creator user ID + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="prev" (when current page > 1), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; + rel="next", ; + rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + post: + summary: Start a task + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Starts a new Copilot cloud agent task for a repository. + + This endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription. + + **Fine-grained access tokens for "Start a task"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read and write) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/create-task-in-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#start-a-task + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + requestBody: + required: true + description: The task creation parameters, including the user's prompt and + optional agent settings. + content: + application/json: + schema: + type: object + required: + - prompt + properties: + prompt: + type: string + 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`' + create_pull_request: + type: boolean + description: Whether to create a PR. + default: false + base_ref: + type: string + description: Base ref for new branch/PR + examples: + default: + value: + prompt: Fix the login button on the homepage + base_ref: main + responses: + '201': + description: Task created successfully + content: + application/json: + schema: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: queued + session_count: 1 + artifacts: [] + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '400': + description: Problems parsing JSON + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/repos/{owner}/{repo}/tasks/{task_id}": + get: + summary: Get a task by repo + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID scoped to an owner/repo path + + **Fine-grained access tokens for "Get a task by repo"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-repo-and-id + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#get-a-task-by-repo + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + allOf: + - type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + 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: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/tasks": + get: + summary: List tasks + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for the authenticated user + + **Fine-grained access tokens for "List tasks"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/list-tasks + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#list-tasks + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, + `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived + tasks. When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; rel="next", + ; rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/tasks/{task_id}": + get: + summary: Get a task by ID + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID with its associated sessions + + **Fine-grained access tokens for "Get a task by ID"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#get-a-task-by-id + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + allOf: + - type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + 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: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation "/app": get: summary: Get the authenticated app @@ -1828,7 +4352,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &764 + schema: &765 title: Scim Error description: Scim Error type: object @@ -9468,7 +11992,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &765 + '401': &766 description: Authorization failure '404': *6 x-github: @@ -13741,7 +16265,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &538 + instances_url: &539 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13777,7 +16301,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &539 + dismissed_reason: &540 type: - string - 'null' @@ -13788,14 +16312,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &540 + dismissed_comment: &541 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &541 + rule: &542 type: object properties: id: @@ -13856,7 +16380,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &542 + tool: &543 type: object properties: name: *111 @@ -13867,26 +16391,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *112 - most_recent_instance: &543 + most_recent_instance: &544 type: object properties: - ref: &536 + ref: &537 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &553 + analysis_key: &554 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - environment: &554 + environment: &555 type: string description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &555 + category: &556 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -13906,7 +16430,7 @@ paths: with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance. - location: &556 + location: &557 type: object description: Describe a region within a file for the alert. properties: @@ -13927,7 +16451,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &557 + items: &558 type: - string - 'null' @@ -18461,7 +20985,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &596 + - &597 name: has in: query description: |- @@ -18588,7 +21112,7 @@ paths: - transitive - inconclusive - - security_advisory: &597 + security_advisory: &598 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -18831,7 +21355,7 @@ paths: dismissal. maxLength: 280 fixed_at: *137 - auto_dismissed_at: &598 + auto_dismissed_at: &599 type: - string - 'null' @@ -18839,7 +21363,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &599 + dismissal_request: &600 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -20645,7 +23169,7 @@ paths: - name - created_on examples: - default: &453 + default: &454 value: total_count: 2 network_configurations: @@ -20896,7 +23420,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *39 - - &454 + - &455 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -20908,7 +23432,7 @@ paths: description: Response content: application/json: - schema: &455 + schema: &456 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -20947,7 +23471,7 @@ paths: - subnet_id - region examples: - default: &456 + default: &457 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -23053,7 +25577,7 @@ paths: - object rules: type: array - items: &721 + items: &722 title: Repository Rule type: object description: A repository rule. @@ -23062,7 +25586,7 @@ paths: - *167 - *168 - *169 - - &719 + - &720 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -23632,6 +26156,17 @@ paths: schema: type: boolean default: false + - &445 + name: is_bypassed + in: query + description: A boolean value (`true` or `false`) indicating whether to filter + alerts by their push protection bypass status. When set to `true`, only + alerts that were created because a push protection rule was bypassed will + be returned. When set to `false`, only alerts that were not caused by a + push protection bypass will be returned. + required: false + schema: + type: boolean responses: '200': description: Response @@ -23639,7 +26174,7 @@ paths: application/json: schema: type: array - items: &445 + items: &446 type: object properties: number: *127 @@ -23655,14 +26190,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &733 + state: &734 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &734 + resolution: &735 type: - string - 'null' @@ -23781,14 +26316,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &735 + - &736 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &737 + - &738 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -23852,7 +26387,7 @@ paths: - blob_url - commit_sha - commit_url - - &738 + - &739 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -23913,7 +26448,7 @@ paths: - page_url - commit_sha - commit_url - - &739 + - &740 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -23935,7 +26470,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &740 + - &741 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -23957,7 +26492,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &741 + - &742 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -23979,7 +26514,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &742 + - &743 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -23994,7 +26529,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &743 + - &744 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -24009,7 +26544,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &744 + - &745 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -24024,7 +26559,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &745 + - &746 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -24046,7 +26581,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &746 + - &747 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -24068,7 +26603,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &747 + - &748 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -24090,7 +26625,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &748 + - &749 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -24112,7 +26647,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &749 + - &750 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -24158,7 +26693,7 @@ paths: - type: 'null' - *4 examples: - default: &446 + default: &447 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -24367,7 +26902,7 @@ paths: description: Response content: application/json: - schema: &447 + schema: &448 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -24454,7 +26989,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *193 examples: - default: &448 + default: &449 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -24590,7 +27125,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *39 - - &450 + - &451 name: advanced_security_product in: query description: | @@ -24610,7 +27145,7 @@ paths: description: Success content: application/json: - schema: &451 + schema: &452 type: object properties: total_advanced_security_committers: @@ -24673,7 +27208,7 @@ paths: required: - repositories examples: - default: &452 + default: &453 value: total_advanced_security_committers: 2 total_count: 2 @@ -27833,7 +30368,7 @@ paths: properties: action: type: string - discussion: &870 + discussion: &871 title: Discussion description: A Discussion in a repository. type: object @@ -28617,7 +31152,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &792 + sub_issues_summary: &793 title: Sub-issues Summary type: object properties: @@ -28701,7 +31236,7 @@ paths: pin: anyOf: - type: 'null' - - &678 + - &679 title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. @@ -28728,7 +31263,7 @@ paths: - url - created_at - updated_at - issue_dependencies_summary: &793 + issue_dependencies_summary: &794 title: Issue Dependencies Summary type: object properties: @@ -28747,7 +31282,7 @@ paths: - total_blocking issue_field_values: type: array - items: &662 + items: &663 title: Issue Field Value description: A value assigned to an issue field type: object @@ -29528,7 +32063,7 @@ paths: type: string release: allOf: - - &712 + - &713 title: Release description: A release. type: object @@ -29610,7 +32145,7 @@ paths: author: *4 assets: type: array - items: &713 + items: &714 title: Release Asset description: Data related to a release. type: object @@ -30201,7 +32736,7 @@ paths: url: type: string format: uri - user: &799 + user: &800 title: Public User description: Public User type: object @@ -33554,14 +36089,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &465 + - &466 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &466 + - &467 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -33623,7 +36158,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &471 + '301': &472 description: Moved permanently content: application/json: @@ -33645,7 +36180,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &686 + - &687 name: all description: If `true`, show notifications marked as read. in: query @@ -33653,7 +36188,7 @@ paths: schema: type: boolean default: false - - &687 + - &688 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -33663,7 +36198,7 @@ paths: type: boolean default: false - *224 - - &688 + - &689 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -34264,7 +36799,7 @@ paths: - url - subscription_url examples: - default: &689 + default: &690 value: - id: '1' repository: @@ -35127,7 +37662,7 @@ paths: type: array items: *152 examples: - default: &695 + default: &696 value: - property_name: environment value: production @@ -35177,7 +37712,7 @@ paths: required: - properties examples: - default: &696 + default: &697 value: properties: - property_name: environment @@ -36068,7 +38603,7 @@ paths: type: integer repository_cache_usages: type: array - items: &478 + items: &479 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -39385,7 +41920,7 @@ paths: description: Response content: application/json: - schema: &498 + schema: &499 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -39420,7 +41955,7 @@ paths: - key_id - key examples: - default: &499 + default: &500 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -39833,7 +42368,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-organization-variables parameters: - *87 - - &483 + - &484 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -40608,6 +43143,10 @@ paths: If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. If no existing records match, new records will be created. + Note: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments + array resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use + the artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can + only have one name and version. tags: - orgs operationId: orgs/set-cluster-deployment-records @@ -40650,24 +43189,18 @@ paths: properties: name: type: string - description: | - The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name parameter must also be identical across all entries. + description: The name of the artifact. minLength: 1 maxLength: 256 digest: type: string - description: | - The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name and version parameters must also be identical across all entries. + description: The hex encoded digest of the artifact. minLength: 71 maxLength: 71 pattern: "^sha256:[a-f0-9]{64}$" version: type: string - description: | - The artifact version. Note that if multiple deployments have identical 'digest' parameter values, - the version parameter must also be identical across all entries. + description: The artifact version. maxLength: 100 x-multi-segment: true examples: @@ -41144,12 +43677,12 @@ paths: required: - subject_digests examples: - default: &830 + default: &831 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &831 + withPredicateType: &832 value: subject_digests: - sha256:abc123 @@ -41208,7 +43741,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &832 + default: &833 value: attestations_subject_digests: - sha256:abc: @@ -41559,7 +44092,7 @@ paths: initiator: type: string examples: - default: &512 + default: &513 value: attestations: - bundle: @@ -42481,7 +45014,7 @@ paths: be returned. in: query required: false - schema: &537 + schema: &538 type: string description: Severity of a code scanning alert. enum: @@ -43583,7 +46116,7 @@ paths: machine: anyOf: - type: 'null' - - &569 + - &570 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -44535,7 +47068,7 @@ paths: - updated_at - visibility examples: - default: &570 + default: &571 value: total_count: 2 secrets: @@ -44573,7 +47106,7 @@ paths: description: Response content: application/json: - schema: &571 + schema: &572 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -44608,7 +47141,7 @@ paths: - key_id - key examples: - default: &572 + default: &573 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -44640,7 +47173,7 @@ paths: application/json: schema: *321 examples: - default: &574 + default: &575 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -48721,7 +51254,7 @@ paths: description: Response content: application/json: - schema: &602 + schema: &603 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -48740,7 +51273,7 @@ paths: - key_id - key examples: - default: &603 + default: &604 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -49068,7 +51601,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *87 - - &612 + - &613 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -49076,7 +51609,7 @@ paths: required: false schema: type: string - - &613 + - &614 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -49084,7 +51617,7 @@ paths: required: false schema: type: string - - &614 + - &615 name: time_period description: |- The time period to filter by. @@ -49100,7 +51633,7 @@ paths: - week - month default: month - - &615 + - &616 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -49125,7 +51658,7 @@ paths: application/json: schema: type: array - items: &616 + items: &617 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -49288,7 +51821,7 @@ paths: examples: - https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &617 + default: &618 value: - id: 21 number: 42 @@ -49390,7 +51923,7 @@ paths: application/json: schema: type: array - items: &618 + items: &619 title: Dependabot alert dismissal request description: Alert dismissal request made by a user asking to dismiss a Dependabot alert. @@ -49513,7 +52046,7 @@ paths: examples: - https://github.com/octo-org/smile/security/dependabot/1 examples: - default: &619 + default: &620 value: - id: 21 number: 42 @@ -49901,7 +52434,7 @@ paths: description: Response content: application/json: - schema: &462 + schema: &463 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -49991,7 +52524,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &463 + default: &464 value: group_id: '123' group_name: Octocat admins @@ -50046,7 +52579,7 @@ paths: description: Response content: application/json: - schema: &459 + schema: &460 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -50086,7 +52619,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &460 + default: &461 value: groups: - group_id: '123' @@ -51598,7 +54131,7 @@ paths: required: true content: application/json: - schema: &650 + schema: &651 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -52934,7 +55467,7 @@ paths: application/json: schema: *385 examples: - default: &568 + default: &569 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -54196,7 +56729,7 @@ paths: parameters: - *87 - *391 - - &813 + - &814 name: repo_name description: repo_name parameter in: path @@ -55544,7 +58077,7 @@ paths: - nuget - container - *87 - - &814 + - &815 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -55585,7 +58118,7 @@ paths: default: *396 '403': *27 '401': *23 - '400': &816 + '400': &817 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -56811,6 +59344,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -56881,6 +59415,15 @@ paths: api_host: description: The Cloudsmith API host. type: string + workload_identity_provider: + description: The full resource name of the GCP Workload + Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + type: string + service_account: + description: The GCP service account email to impersonate. + If omitted, the federated token is used directly (direct + WIF). + type: string created_at: type: string format: date-time @@ -56918,7 +59461,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -57012,7 +59555,477 @@ paths: auth_type: description: The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, - or `oidc_cloudsmith` for OIDC authentication. + `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication. + type: string + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + - oidc_cloudsmith + - oidc_gcp + tenant_id: + description: The tenant ID of the Azure AD application. Required + when `auth_type` is `oidc_azure`. + type: string + client_id: + description: The client ID of the Azure AD application. Required + when `auth_type` is `oidc_azure`. + type: string + aws_region: + description: The AWS region. Required when `auth_type` is `oidc_aws`. + type: string + account_id: + description: The AWS account ID. Required when `auth_type` is `oidc_aws`. + type: string + role_name: + description: The AWS IAM role name. Required when `auth_type` is + `oidc_aws`. + type: string + domain: + description: The CodeArtifact domain. Required when `auth_type` + is `oidc_aws`. + type: string + domain_owner: + description: The CodeArtifact domain owner (AWS account ID). Required + when `auth_type` is `oidc_aws`. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. Required when `auth_type` + is `oidc_jfrog`. + type: string + audience: + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and `oidc_gcp`, and required for `oidc_cloudsmith` auth types. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. Optional for `oidc_jfrog` + auth type. + type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + Required when `auth_type` is `oidc_gcp`. + type: string + service_account: + description: The GCP service account email to impersonate. Optional + for `oidc_gcp` auth type. If omitted, the federated token is used + directly (direct WIF). + type: string + required: + - registry_type + - url + - visibility + examples: + org-private-registry-with-private-visibility: + summary: Example of a private registry configuration with private + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + replaces_base: true + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: private + org-private-registry-with-selected-visibility: + summary: Example of a private registry configuration with selected + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + org-private-registry-with-oidc-azure: + summary: Example of an OIDC private registry configuration using Azure + value: + registry_type: docker_registry + url: https://myregistry.azurecr.io + auth_type: oidc_azure + visibility: all + tenant_id: 12345678-1234-1234-1234-123456789012 + client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org + org-private-registry-with-oidc-gcp: + summary: Example of an OIDC private registry configuration using Google + Cloud Artifact Registry + value: + registry_type: docker_registry + url: https://us-docker.pkg.dev/my-project/my-repo + auth_type: oidc_gcp + visibility: all + workload_identity_provider: projects/123456789/locations/global/workloadIdentityPools/github-pool/providers/github-provider + service_account: dependabot@my-project.iam.gserviceaccount.com + responses: + '201': + description: The organization private registry configuration + content: + application/json: + schema: + title: Organization private registry + description: Private registry configuration for an organization + type: object + properties: + name: + description: The name of the private registry configuration. + type: string + examples: + - MAVEN_REPOSITORY_SECRET + registry_type: + description: The registry type. + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + type: string + auth_type: + description: The authentication type for the private registry. + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + - oidc_cloudsmith + - oidc_gcp + type: string + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the + private registry. + type: string + examples: + - monalisa + replaces_base: + description: Whether this private registry replaces the base registry + (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, + Dependabot will only use this registry and will not fall back + to the public registry. When `false` (default), Dependabot will + use this registry for scoped packages but may fall back to the + public registry for other packages. + type: boolean + default: false + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + enum: + - all + - private + - selected + type: string + selected_repository_ids: + type: array + description: An array of repository IDs that can access the organization + private registry when `visibility` is set to `selected`. + items: + type: integer + tenant_id: + description: The tenant ID of the Azure AD application. + type: string + client_id: + description: The client ID of the Azure AD application. + type: string + aws_region: + description: The AWS region. + type: string + account_id: + description: The AWS account ID. + type: string + role_name: + description: The AWS IAM role name. + type: string + domain: + description: The CodeArtifact domain. + type: string + domain_owner: + description: The CodeArtifact domain owner. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. + type: string + audience: + description: The OIDC audience. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. + type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + type: string + service_account: + description: The GCP service account email to impersonate. If + omitted, the federated token is used directly (direct WIF). + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - registry_type + - visibility + - created_at + - updated_at + examples: + org-private-registry-with-selected-visibility: &410 + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: private + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + org-private-registry-with-private-visibility: + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/public-key": + get: + summary: Get private registries public key for an organization + description: |2- + + Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization + parameters: + - *87 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - key_id + - key + properties: + key_id: + description: The identifier for the key. + type: string + examples: + - '012345678912345678' + key: + description: The Base64 encoded public key. + type: string + examples: + - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + examples: + default: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + headers: + Link: *45 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/{secret_name}": + get: + summary: Get a private registry for an organization + description: |2- + + Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization + parameters: + - *87 + - *288 + responses: + '200': + description: The specified private registry configuration for the organization + content: + application/json: + schema: *409 + examples: + default: *410 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + patch: + summary: Update a private registry for an organization + description: |2- + + Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/update-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization + parameters: + - *87 + - *288 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + registry_type: + description: The registry type. + type: string + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the private + registry. This field should be omitted if the private registry + does not require a username for authentication. + type: + - string + - 'null' + replaces_base: + description: Whether this private registry should replace the base + registry (e.g., npmjs.org for npm, rubygems.org for rubygems). + When set to `true`, Dependabot will only use this registry and + will not fall back to the public registry. When set to `false` + (default), Dependabot will use this registry for scoped packages + but may fall back to the public registry for other packages. + type: boolean + default: false + encrypted_value: + description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get private registries + public key for an organization](https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + endpoint. + type: string + pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + key_id: + description: The ID of the key you used to encrypt the secret. + type: string + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + type: string + enum: + - all + - private + - selected + selected_repository_ids: + description: An array of repository IDs that can access the organization + private registry. You can only provide a list of repository IDs + when `visibility` is set to `selected`. This field should be omitted + if `visibility` is set to `all` or `private`. + type: array + items: + type: integer + auth_type: + description: The authentication type for the private registry. This + field cannot be changed after creation. If provided, it must match + the existing `auth_type` of the configuration. To change the authentication + type, delete and recreate the configuration. type: string enum: - token @@ -57021,6 +60034,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -57053,7 +60067,7 @@ paths: type: string audience: description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, - and required for `oidc_cloudsmith` auth types. + and `oidc_gcp`, and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` @@ -57071,445 +60085,15 @@ paths: description: The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default. type: string - required: - - registry_type - - url - - visibility - examples: - org-private-registry-with-private-visibility: - summary: Example of a private registry configuration with private - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - replaces_base: true - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: private - org-private-registry-with-selected-visibility: - summary: Example of a private registry configuration with selected - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - org-private-registry-with-oidc-azure: - summary: Example of an OIDC private registry configuration using Azure - value: - registry_type: docker_registry - url: https://myregistry.azurecr.io - auth_type: oidc_azure - visibility: all - tenant_id: 12345678-1234-1234-1234-123456789012 - client_id: abcdef01-2345-6789-abcd-ef0123456789 - org-private-registry-with-oidc-cloudsmith: - summary: Example of an OIDC private registry configuration using Cloudsmith - value: - registry_type: npm_registry - url: https://npm.cloudsmith.io/my-org/my-repo/ - auth_type: oidc_cloudsmith - visibility: all - namespace: my-org - service_slug: my-service-account - audience: https://github.com/my-org - responses: - '201': - description: The organization private registry configuration - content: - application/json: - schema: - title: Organization private registry - description: Private registry configuration for an organization - type: object - properties: - name: - description: The name of the private registry configuration. - type: string - examples: - - MAVEN_REPOSITORY_SECRET - registry_type: - description: The registry type. - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - type: string - auth_type: - description: The authentication type for the private registry. - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - - oidc_cloudsmith - type: string - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with the - private registry. - type: string - examples: - - monalisa - replaces_base: - description: Whether this private registry replaces the base registry - (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, - Dependabot will only use this registry and will not fall back - to the public registry. When `false` (default), Dependabot will - use this registry for scoped packages but may fall back to the - public registry for other packages. - type: boolean - default: false - visibility: - description: Which type of organization repositories have access - to the private registry. `selected` means only the repositories - specified by `selected_repository_ids` can access the private - registry. - enum: - - all - - private - - selected - type: string - selected_repository_ids: - type: array - description: An array of repository IDs that can access the organization - private registry when `visibility` is set to `selected`. - items: - type: integer - tenant_id: - description: The tenant ID of the Azure AD application. - type: string - client_id: - description: The client ID of the Azure AD application. - type: string - aws_region: - description: The AWS region. - type: string - account_id: - description: The AWS account ID. - type: string - role_name: - description: The AWS IAM role name. - type: string - domain: - description: The CodeArtifact domain. - type: string - domain_owner: - description: The CodeArtifact domain owner. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. - type: string - audience: - description: The OIDC audience. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. - type: string - namespace: - description: The Cloudsmith organization namespace. - type: string - service_slug: - description: The Cloudsmith service account slug. - type: string - api_host: - description: The Cloudsmith API host. - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - name - - registry_type - - visibility - - created_at - - updated_at - examples: - org-private-registry-with-selected-visibility: &410 - value: - name: MAVEN_REPOSITORY_SECRET - registry_type: maven_repository - username: monalisa - visibility: private - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - org-private-registry-with-private-visibility: - value: - name: MAVEN_REPOSITORY_SECRET - registry_type: maven_repository - username: monalisa - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/public-key": - get: - summary: Get private registries public key for an organization - description: |2- - - Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization - parameters: - - *87 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - key_id - - key - properties: - key_id: - description: The identifier for the key. - type: string - examples: - - '012345678912345678' - key: - description: The Base64 encoded public key. - type: string - examples: - - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - examples: - default: - value: - key_id: '012345678912345678' - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - headers: - Link: *45 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/{secret_name}": - get: - summary: Get a private registry for an organization - description: |2- - - Get the configuration of a single private registry defined for an organization, omitting its encrypted value. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization - parameters: - - *87 - - *288 - responses: - '200': - description: The specified private registry configuration for the organization - content: - application/json: - schema: *409 - examples: - default: *410 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - patch: - summary: Update a private registry for an organization - description: |2- - - Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/update-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization - parameters: - - *87 - - *288 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - registry_type: - description: The registry type. - type: string - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with the private - registry. This field should be omitted if the private registry - does not require a username for authentication. - type: - - string - - 'null' - replaces_base: - description: Whether this private registry should replace the base - registry (e.g., npmjs.org for npm, rubygems.org for rubygems). - When set to `true`, Dependabot will only use this registry and - will not fall back to the public registry. When set to `false` - (default), Dependabot will use this registry for scoped packages - but may fall back to the public registry for other packages. - type: boolean - default: false - encrypted_value: - description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get private registries - public key for an organization](https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) - endpoint. + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + Required when `auth_type` is `oidc_gcp`. type: string - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - description: The ID of the key you used to encrypt the secret. - type: string - visibility: - description: Which type of organization repositories have access - to the private registry. `selected` means only the repositories - specified by `selected_repository_ids` can access the private - registry. - type: string - enum: - - all - - private - - selected - selected_repository_ids: - description: An array of repository IDs that can access the organization - private registry. You can only provide a list of repository IDs - when `visibility` is set to `selected`. This field should be omitted - if `visibility` is set to `all` or `private`. - type: array - items: - type: integer - auth_type: - description: The authentication type for the private registry. This - field cannot be changed after creation. If provided, it must match - the existing `auth_type` of the configuration. To change the authentication - type, delete and recreate the configuration. - type: string - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - - oidc_cloudsmith - tenant_id: - description: The tenant ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - client_id: - description: The client ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - aws_region: - description: The AWS region. Required when `auth_type` is `oidc_aws`. - type: string - account_id: - description: The AWS account ID. Required when `auth_type` is `oidc_aws`. - type: string - role_name: - description: The AWS IAM role name. Required when `auth_type` is - `oidc_aws`. - type: string - domain: - description: The CodeArtifact domain. Required when `auth_type` - is `oidc_aws`. - type: string - domain_owner: - description: The CodeArtifact domain owner (AWS account ID). Required - when `auth_type` is `oidc_aws`. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. Required when `auth_type` - is `oidc_jfrog`. - type: string - audience: - description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, - and required for `oidc_cloudsmith` auth types. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. Optional for `oidc_jfrog` - auth type. - type: string - namespace: - description: The Cloudsmith organization namespace. Required when - `auth_type` is `oidc_cloudsmith`. - type: string - service_slug: - description: The Cloudsmith service account slug. Required when - `auth_type` is `oidc_cloudsmith`. - type: string - api_host: - description: The Cloudsmith API host. Optional for `oidc_cloudsmith` - auth type. If omitted, `api.cloudsmith.io` is used by default. + service_account: + description: The GCP service account email to impersonate. Optional + for `oidc_gcp` auth type. If omitted, the federated token is used + directly (direct WIF). type: string examples: secret-based-update: @@ -57665,7 +60249,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &903 + - &904 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -57939,7 +60523,7 @@ paths: content: oneOf: - *219 - - &583 + - &584 title: Pull Request Simple description: Pull Request Simple type: object @@ -58178,7 +60762,7 @@ paths: - review_comment - self author_association: *216 - auto_merge: &698 + auto_merge: &699 title: Auto merge description: The status of auto merging a pull request. type: @@ -58563,7 +61147,7 @@ paths: - updated_at - project_url examples: - default: &836 + default: &837 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -58740,7 +61324,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &837 + items: &838 type: object properties: name: @@ -58777,7 +61361,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &838 + iteration_configuration: &839 type: object description: The configuration for iteration fields. properties: @@ -58827,7 +61411,7 @@ paths: value: name: Due date data_type: date - single_select_field: &839 + single_select_field: &840 summary: Create a single select field value: name: Priority @@ -58854,7 +61438,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &840 + iteration_field: &841 summary: Create an iteration field value: name: Sprint @@ -58880,7 +61464,7 @@ paths: application/json: schema: *416 examples: - text_field: &841 + text_field: &842 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -58889,7 +61473,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &842 + number_field: &843 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -58898,7 +61482,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &843 + date_field: &844 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -58907,7 +61491,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &844 + single_select_field: &845 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -58941,7 +61525,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &845 + iteration_field: &846 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -58987,7 +61571,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-organization parameters: - *413 - - &846 + - &847 name: field_id description: The unique identifier of the field. in: path @@ -59002,7 +61586,7 @@ paths: application/json: schema: *416 examples: - default: &847 + default: &848 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -60213,7 +62797,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &827 + schema: &828 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -60396,7 +62980,7 @@ paths: parameters: - *413 - *87 - - &848 + - &849 name: view_number description: The number that identifies the project view. in: path @@ -61166,7 +63750,7 @@ paths: description: Response content: application/json: - schema: &470 + schema: &471 title: Full Repository description: Full Repository type: object @@ -61644,7 +64228,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &588 + code_of_conduct: &589 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -61758,7 +64342,7 @@ paths: - network_count - subscribers_count examples: - default: &472 + default: &473 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -62311,7 +64895,7 @@ paths: - *87 - *17 - *19 - - &720 + - &721 name: targets description: | A comma-separated list of rule targets to filter by. @@ -62528,7 +65112,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *87 - - &722 + - &723 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -62540,14 +65124,14 @@ paths: x-multi-segment: true - *304 - *105 - - &723 + - &724 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &724 + - &725 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -62567,7 +65151,7 @@ paths: description: Response content: application/json: - schema: &725 + schema: &726 title: Rule Suites description: Response type: array @@ -62623,7 +65207,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &726 + default: &727 value: - id: 21 actor_id: 12 @@ -62667,7 +65251,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *87 - - &727 + - &728 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -62683,7 +65267,7 @@ paths: description: Response content: application/json: - schema: &728 + schema: &729 title: Rule Suite description: Response type: object @@ -62790,7 +65374,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &729 + default: &730 value: id: 21 actor_id: 12 @@ -63126,7 +65710,7 @@ paths: - *110 - *19 - *17 - - &731 + - &732 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -63136,7 +65720,7 @@ paths: required: false schema: type: string - - &732 + - &733 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -63150,6 +65734,7 @@ paths: - *442 - *443 - *444 + - *445 responses: '200': description: Response @@ -63157,9 +65742,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *446 + default: *447 headers: Link: *45 '404': *6 @@ -63194,9 +65779,9 @@ paths: description: Response content: application/json: - schema: *447 + schema: *448 examples: - default: *448 + default: *449 '403': *27 '404': *6 patch: @@ -63349,7 +65934,7 @@ paths: application/json: schema: type: array - items: &753 + items: &754 description: A repository security advisory. type: object properties: @@ -63593,7 +66178,7 @@ paths: login: type: string description: The username of the user credited. - type: *449 + type: *450 credits_detailed: type: - array @@ -63604,7 +66189,7 @@ paths: type: object properties: user: *4 - type: *449 + type: *450 state: type: string description: The state of the user's acceptance of the @@ -63668,7 +66253,7 @@ paths: - private_fork additionalProperties: false examples: - default: &754 + default: &755 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -64154,7 +66739,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *87 - - *450 + - *451 - *17 - *19 responses: @@ -64162,9 +66747,9 @@ paths: description: Success content: application/json: - schema: *451 + schema: *452 examples: - default: *452 + default: *453 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -64447,7 +67032,7 @@ paths: type: array items: *145 examples: - default: *453 + default: *454 headers: Link: *45 x-github: @@ -64676,15 +67261,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - *87 - - *454 + - *455 responses: '200': description: Response content: application/json: - schema: *455 + schema: *456 examples: - default: *456 + default: *457 headers: Link: *45 x-github: @@ -64722,7 +67307,7 @@ paths: description: Response content: application/json: - schema: &467 + schema: &468 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -64774,7 +67359,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &468 + default: &469 value: groups: - group_id: '123' @@ -64994,7 +67579,7 @@ paths: description: Response content: application/json: - schema: &457 + schema: &458 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -65393,7 +67978,7 @@ paths: - repos_count - organization examples: - default: &458 + default: &459 value: id: 1 node_id: MDQ6VGVhbTE= @@ -65470,9 +68055,9 @@ paths: description: Response content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 '404': *6 x-github: githubCloudOnly: false @@ -65557,16 +68142,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 '201': description: Response content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 '404': *6 '422': *15 '403': *27 @@ -65596,7 +68181,7 @@ paths: responses: '204': description: Response - '422': &461 + '422': &462 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -65625,10 +68210,10 @@ paths: description: Response content: application/json: - schema: *459 + schema: *460 examples: - default: *460 - '422': *461 + default: *461 + '422': *462 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -65672,10 +68257,10 @@ paths: description: Response content: application/json: - schema: *462 + schema: *463 examples: - default: *463 - '422': *461 + default: *464 + '422': *462 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -65699,7 +68284,7 @@ paths: responses: '204': description: Response - '422': *461 + '422': *462 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -65736,7 +68321,7 @@ paths: default: *375 headers: Link: *45 - '422': *461 + '422': *462 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65818,7 +68403,7 @@ paths: description: Response content: application/json: - schema: &464 + schema: &465 title: Team Membership description: Team Membership type: object @@ -65846,7 +68431,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &795 + response-if-user-is-a-team-maintainer: &796 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -65909,9 +68494,9 @@ paths: description: Response content: application/json: - schema: *464 + schema: *465 examples: - response-if-users-membership-with-team-is-now-pending: &796 + response-if-users-membership-with-team-is-now-pending: &797 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -66018,14 +68603,14 @@ paths: parameters: - *87 - *214 - - *465 - *466 + - *467 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &797 + schema: &798 title: Team Repository description: A team's access to a repository. type: object @@ -66668,8 +69253,8 @@ paths: parameters: - *87 - *214 - - *465 - *466 + - *467 requestBody: required: false content: @@ -66716,8 +69301,8 @@ paths: parameters: - *87 - *214 - - *465 - *466 + - *467 responses: '204': description: Response @@ -66750,10 +69335,10 @@ paths: description: Response content: application/json: - schema: *467 + schema: *468 examples: - default: *468 - '422': *461 + default: *469 + '422': *462 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -66819,7 +69404,7 @@ paths: description: Response content: application/json: - schema: *467 + schema: *468 examples: default: value: @@ -66831,7 +69416,7 @@ paths: group_name: Octocat docs members group_description: The people who make your octoworld come to life. - '422': *461 + '422': *462 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -66865,7 +69450,7 @@ paths: type: array items: *307 examples: - response-if-child-teams-exist: &798 + response-if-child-teams-exist: &799 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -67019,7 +69604,7 @@ paths: resources: type: object properties: - core: &469 + core: &470 title: Rate Limit type: object properties: @@ -67036,21 +69621,21 @@ paths: - remaining - reset - used - graphql: *469 - search: *469 - code_search: *469 - source_import: *469 - integration_manifest: *469 - code_scanning_upload: *469 - actions_runner_registration: *469 - scim: *469 - dependency_snapshots: *469 - dependency_sbom: *469 - code_scanning_autofix: *469 + graphql: *470 + search: *470 + code_search: *470 + source_import: *470 + integration_manifest: *470 + code_scanning_upload: *470 + actions_runner_registration: *470 + scim: *470 + dependency_snapshots: *470 + dependency_sbom: *470 + code_scanning_autofix: *470 required: - core - search - rate: *469 + rate: *470 required: - rate - resources @@ -67155,14 +69740,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *470 + schema: *471 examples: default-response: summary: Default response @@ -67671,7 +70256,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *471 + '301': *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67689,8 +70274,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#update-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: false content: @@ -67999,10 +70584,10 @@ paths: description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: *472 - '307': &473 + default: *473 + '307': &474 description: Temporary Redirect content: application/json: @@ -68031,8 +70616,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -68054,7 +70639,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository - '307': *473 + '307': *474 '404': *6 '409': *119 x-github: @@ -68078,11 +70663,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *465 - *466 + - *467 - *17 - *19 - - &490 + - &491 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -68105,7 +70690,7 @@ paths: type: integer artifacts: type: array - items: &474 + items: &475 title: Artifact description: An artifact type: object @@ -68200,7 +70785,7 @@ paths: - expires_at - updated_at examples: - default: &491 + default: &492 value: total_count: 2 artifacts: @@ -68261,9 +70846,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#get-an-artifact parameters: - - *465 - *466 - - &475 + - *467 + - &476 name: artifact_id description: The unique identifier of the artifact. in: path @@ -68275,7 +70860,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *475 examples: default: value: @@ -68313,9 +70898,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#delete-an-artifact parameters: - - *465 - *466 - - *475 + - *467 + - *476 responses: '204': description: Response @@ -68339,9 +70924,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#download-an-artifact parameters: - - *465 - *466 - - *475 + - *467 + - *476 - name: archive_format in: path required: true @@ -68351,11 +70936,11 @@ paths: '302': description: Response headers: - Location: &605 + Location: &606 example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &653 + '410': &654 description: Gone content: application/json: @@ -68380,14 +70965,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: &476 + schema: &477 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -68421,13 +71006,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: application/json: - schema: *476 + schema: *477 examples: selected_actions: *42 responses: @@ -68456,14 +71041,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: &477 + schema: &478 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -68497,13 +71082,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: application/json: - schema: *477 + schema: *478 examples: selected_actions: *44 responses: @@ -68534,14 +71119,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *478 + schema: *479 examples: default: value: @@ -68567,11 +71152,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *465 - *466 + - *467 - *17 - *19 - - &479 + - &480 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -68605,7 +71190,7 @@ paths: description: Response content: application/json: - schema: &480 + schema: &481 title: Repository actions caches description: Repository actions caches type: object @@ -68655,7 +71240,7 @@ paths: - total_count - actions_caches examples: - default: &481 + default: &482 value: total_count: 1 actions_caches: @@ -68687,23 +71272,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *465 - *466 + - *467 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *479 + - *480 responses: '200': description: Response content: application/json: - schema: *480 + schema: *481 examples: - default: *481 + default: *482 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68723,8 +71308,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *465 - *466 + - *467 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -68739,6 +71324,245 @@ paths: enabledForGitHubApps: true category: actions subcategory: cache + "/repos/{owner}/{repo}/actions/concurrency_groups": + get: + summary: List concurrency groups for a repository + description: |- + Lists the active concurrency groups for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-concurrency-groups-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository + parameters: + - *466 + - *467 + - *17 + - *109 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Concurrency Group List + description: A list of active concurrency groups for a repository. + type: object + required: + - total_count + - concurrency_groups + properties: + total_count: + type: integer + concurrency_groups: + type: array + items: + type: object + required: + - group_name + - group_url + - last_acquired_at + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: API URL for this concurrency group. + last_acquired_at: + type: + - string + - 'null' + format: date-time + examples: + default: + value: + total_count: 2 + concurrency_groups: + - group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + last_acquired_at: '2026-01-15T16:14:23Z' + - group_name: ci-build + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build + last_acquired_at: '2026-01-15T16:13:55Z' + headers: + Link: *45 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups + "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}": + get: + summary: Get a concurrency group for a repository + description: |- + Gets a specific concurrency group for a repository, including all instances in the group's queue. + Returns 404 if the group is inactive or does not exist. + + Optionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items + ahead of the specified workflow run or job in the queue, plus the specified item itself + (returned as the last element). This is useful for determining what is blocking a particular + run or job. Returns 422 if the specified run or job is not in this concurrency group. + + When using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow + leases held on behalf of that run. Job-level leases within the run are not considered to + block the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow + leases on the job's ancestor paths. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-concurrency-group-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository + parameters: + - *466 + - *467 + - name: concurrency_group_name + description: The name of the concurrency group. + in: path + required: true + schema: + type: string + - name: ahead_of_run + description: |- + Filter to items ahead of this workflow run ID in the queue, plus the run itself. + Matches workflow-level concurrency and reusable-workflow leases held on behalf of + the run. Mutually exclusive with `ahead_of_job`. + in: query + required: false + schema: + type: integer + minimum: 1 + - name: ahead_of_job + description: |- + Filter to items ahead of this job ID in the queue, plus the job itself. + Matches job-level concurrency and reusable-workflow leases on the job's + ancestor paths. Mutually exclusive with `ahead_of_run`. + in: query + required: false + schema: + type: integer + minimum: 1 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Concurrency Group + description: |- + A concurrency group with the workflow runs and jobs that are either currently holding + or waiting for the concurrency group lease. + type: object + required: + - group_name + - group_url + - total_count + - group_members + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: API URL for this concurrency group. + total_count: + type: integer + group_members: + type: array + items: + type: object + required: + - run_id + - run_name + - run_url + - run_html_url + - status + properties: + run_id: + type: integer + description: The ID of the workflow run. + run_name: + type: string + description: The name of the workflow run. + run_url: + type: + - string + - 'null' + format: uri + description: API URL for the workflow run. + run_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the workflow run. + job_id: + type: integer + description: The ID of the job, when the item represents + a job-level or reusable-workflow-level lease. + job_name: + type: string + description: The display name of the job, when the item + represents a job-level or reusable-workflow-level lease. + job_url: + type: + - string + - 'null' + format: uri + description: API URL for the job. + job_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the job. + status: + type: string + enum: + - in_progress + - pending + examples: + default: + value: + group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + total_count: 3 + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: in_progress + - run_id: 30433643 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433643 + status: pending + - run_id: 30433644 + run_name: Deploy hotfix + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433644 + job_id: 798245260 + job_name: deploy + job_url: https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260 + job_html_url: https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260 + status: pending + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups "/repos/{owner}/{repo}/actions/jobs/{job_id}": get: summary: Get a job for a workflow run @@ -68755,9 +71579,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *465 - *466 - - &482 + - *467 + - &483 name: job_id description: The unique identifier of the job. in: path @@ -68769,7 +71593,7 @@ paths: description: Response content: application/json: - schema: &494 + schema: &495 title: Job description: Information of a job execution in a workflow run type: object @@ -69116,9 +71940,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *465 - *466 - - *482 + - *467 + - *483 responses: '302': description: Response @@ -69146,9 +71970,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *465 - *466 - - *482 + - *467 + - *483 requestBody: required: false content: @@ -69194,8 +72018,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Status response @@ -69254,8 +72078,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -69323,8 +72147,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-organization-secrets parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -69342,7 +72166,7 @@ paths: type: integer secrets: type: array - items: &496 + items: &497 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -69363,7 +72187,7 @@ paths: - created_at - updated_at examples: - default: &497 + default: &498 value: total_count: 2 secrets: @@ -69396,9 +72220,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-organization-variables parameters: - - *465 - *466 - - *483 + - *467 + - *484 - *19 responses: '200': @@ -69415,7 +72239,7 @@ paths: type: integer variables: type: array - items: &500 + items: &501 title: Actions Variable type: object properties: @@ -69449,7 +72273,7 @@ paths: - created_at - updated_at examples: - default: &501 + default: &502 value: total_count: 2 variables: @@ -69482,8 +72306,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -69492,7 +72316,7 @@ paths: schema: type: object properties: - enabled: &484 + enabled: &485 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *60 @@ -69527,8 +72351,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -69539,7 +72363,7 @@ paths: schema: type: object properties: - enabled: *484 + enabled: *485 allowed_actions: *60 sha_pinning_required: *61 required: @@ -69572,14 +72396,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: &485 + schema: &486 type: object properties: access_level: @@ -69597,7 +72421,7 @@ paths: required: - access_level examples: - default: &486 + default: &487 value: access_level: organization x-github: @@ -69622,15 +72446,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: application/json: - schema: *485 + schema: *486 examples: - default: *486 + default: *487 responses: '204': description: Response @@ -69654,8 +72478,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -69685,8 +72509,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Empty response for successful settings update @@ -69720,8 +72544,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -69748,8 +72572,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -69783,8 +72607,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -69812,8 +72636,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -69844,8 +72668,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -69876,8 +72700,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -69909,8 +72733,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -69939,8 +72763,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Success response @@ -69980,8 +72804,8 @@ paths: in: query schema: type: string - - *465 - *466 + - *467 - *17 - *19 responses: @@ -70025,8 +72849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -70058,8 +72882,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -70133,8 +72957,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *465 - *466 + - *467 responses: '201': description: Response @@ -70170,8 +72994,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *465 - *466 + - *467 responses: '201': description: Response @@ -70201,8 +73025,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *465 - *466 + - *467 - *75 responses: '200': @@ -70232,8 +73056,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *465 - *466 + - *467 - *75 responses: '204': @@ -70260,8 +73084,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *465 - *466 + - *467 - *75 responses: '200': *81 @@ -70286,8 +73110,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *465 - *466 + - *467 - *75 requestBody: required: true @@ -70336,8 +73160,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *465 - *466 + - *467 - *75 requestBody: required: true @@ -70387,8 +73211,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *465 - *466 + - *467 - *75 responses: '200': *285 @@ -70418,8 +73242,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *465 - *466 + - *467 - *75 - *286 responses: @@ -70449,9 +73273,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *465 - *466 - - &504 + - *467 + - &505 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -70459,7 +73283,7 @@ paths: required: false schema: type: string - - &505 + - &506 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -70467,7 +73291,7 @@ paths: required: false schema: type: string - - &506 + - &507 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -70476,7 +73300,7 @@ paths: required: false schema: type: string - - &507 + - &508 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -70503,7 +73327,7 @@ paths: - pending - *17 - *19 - - &508 + - &509 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -70512,7 +73336,7 @@ paths: schema: type: string format: date-time - - &487 + - &488 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -70521,13 +73345,13 @@ paths: schema: type: boolean default: false - - &509 + - &510 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &510 + - &511 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -70550,7 +73374,7 @@ paths: type: integer workflow_runs: type: array - items: &488 + items: &489 title: Workflow Run description: An invocation of a workflow type: object @@ -70728,7 +73552,7 @@ paths: head_commit: anyOf: - type: 'null' - - &532 + - &533 title: Simple Commit description: A commit. type: object @@ -70843,7 +73667,7 @@ paths: - workflow_url - pull_requests examples: - default: &511 + default: &512 value: total_count: 1 workflow_runs: @@ -71079,24 +73903,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *465 - *466 - - &489 + - *467 + - &490 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *487 + - *488 responses: '200': description: Response content: application/json: - schema: *488 + schema: *489 examples: - default: &492 + default: &493 value: id: 30433642 name: Build @@ -71337,9 +74161,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '204': description: Response @@ -71362,9 +74186,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '200': description: Response @@ -71492,9 +74316,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '201': description: Response @@ -71527,12 +74351,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *465 - *466 - - *489 + - *467 + - *490 - *17 - *19 - - *490 + - *491 - *110 responses: '200': @@ -71549,9 +74373,9 @@ paths: type: integer artifacts: type: array - items: *474 + items: *475 examples: - default: *491 + default: *492 headers: Link: *45 x-github: @@ -71575,25 +74399,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *465 - *466 - - *489 - - &493 + - *467 + - *490 + - &494 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *487 + - *488 responses: '200': description: Response content: application/json: - schema: *488 + schema: *489 examples: - default: *492 + default: *493 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71616,10 +74440,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *465 - *466 - - *489 - - *493 + - *467 + - *490 + - *494 - *17 - *19 responses: @@ -71637,9 +74461,9 @@ paths: type: integer jobs: type: array - items: *494 + items: *495 examples: - default: &495 + default: &496 value: total_count: 1 jobs: @@ -71752,10 +74576,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *465 - *466 - - *489 - - *493 + - *467 + - *490 + - *494 responses: '302': description: Response @@ -71783,9 +74607,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '202': description: Response @@ -71801,6 +74625,198 @@ paths: enabledForGitHubApps: true category: actions subcategory: workflow-runs + "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups": + get: + summary: List concurrency groups for a workflow run + description: |- + Lists all concurrency groups associated with a workflow run or its jobs. + + The set of groups is derived from the run's configuration, so a group is + included even when the run no longer has any items currently holding or + waiting in it. In that case the `group_members` array will be empty. + `total_count` reflects the number of groups the run participates in by + configuration, not the number with active items. + + This differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`, + which returns 404 when a group has no active items. That endpoint reports + the live state of a group repo-wide, while this endpoint reports the + groups associated with a specific run by configuration. + + Results are sorted by group name and support cursor-based pagination via + `before` and `after`. The `after` cursor paginates forward only and does + not emit a `rel="prev"` Link; use `before` to page backward from a + forward page's `next` cursor. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-concurrency-groups-for-workflow-run + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run + parameters: + - *466 + - *467 + - *490 + - *17 + - *108 + - *109 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Concurrency Group Run List + description: A list of concurrency groups associated with a workflow + run. + type: object + required: + - total_count + - concurrency_groups + properties: + total_count: + type: integer + description: |- + The total number of concurrency groups this workflow run participates in, + derived from the run's configuration. This count is not filtered by + whether the run currently holds or is waiting in each group, so it can + include groups whose `group_members` array is empty (for example, when + the run has already released its lease in that group). + concurrency_groups: + type: array + items: + type: object + required: + - group_name + - group_url + - group_members + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: |- + API URL for this concurrency group. May return 404 if the group + has no active items at the time it is requested, since the + get-by-name endpoint reports the live repo-wide state of a group + while this endpoint lists groups associated with a run by + configuration. + group_members: + type: array + description: |- + Items belonging to this workflow run that are either currently holding or + waiting for the concurrency group lease. May be empty if the run no + longer has any active or queued items in this group. + items: + type: object + required: + - run_id + - run_name + - run_url + - run_html_url + - status + - position + - position_url + properties: + run_id: + type: integer + description: The ID of the workflow run. + run_name: + type: string + description: The name of the workflow run. + run_url: + type: + - string + - 'null' + format: uri + description: API URL for the workflow run. + run_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the workflow run. + position: + type: integer + description: Queue position. 0 means the item holds + the concurrency lease (in_progress), 1 or higher + means queued (pending). + position_url: + type: string + format: uri + description: API URL to get items ahead of this item + in the concurrency group. + job_id: + type: + - integer + - 'null' + description: The ID of the job, when the item represents + a job-level or reusable-workflow-level lease. + job_name: + type: + - string + - 'null' + description: The display name of the job, when the + item represents a job-level or reusable-workflow-level + lease. + job_url: + type: + - string + - 'null' + format: uri + description: API URL for the job. + job_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the job. + status: + type: string + enum: + - in_progress + - pending + examples: + default: + value: + total_count: 2 + concurrency_groups: + - group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: in_progress + position: 0 + position_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642 + - group_name: ci-build + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: pending + position: 2 + position_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260 + job_id: 798245260 + job_name: build + job_url: https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260 + job_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260 + headers: + Link: *45 + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": post: summary: Review custom deployment protection rules for a workflow run @@ -71818,9 +74834,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 requestBody: required: true content: @@ -71887,9 +74903,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '202': description: Response @@ -71922,9 +74938,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -71954,9 +74970,9 @@ paths: type: integer jobs: type: array - items: *494 + items: *495 examples: - default: *495 + default: *496 headers: Link: *45 x-github: @@ -71981,9 +74997,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '302': description: Response @@ -72010,9 +75026,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '204': description: Response @@ -72039,9 +75055,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '200': description: Response @@ -72110,7 +75126,7 @@ paths: items: type: object properties: - type: &620 + type: &621 type: string description: The type of reviewer. enum: @@ -72196,9 +75212,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 requestBody: required: true content: @@ -72248,7 +75264,7 @@ paths: application/json: schema: type: array - items: &607 + items: &608 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -72360,7 +75376,7 @@ paths: - created_at - updated_at examples: - default: &608 + default: &609 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -72416,9 +75432,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *465 - *466 - - *489 + - *467 + - *490 requestBody: required: false content: @@ -72463,9 +75479,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 requestBody: required: false content: @@ -72520,9 +75536,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '200': description: Response @@ -72659,8 +75675,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-secrets parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -72678,9 +75694,9 @@ paths: type: integer secrets: type: array - items: *496 + items: *497 examples: - default: *497 + default: *498 headers: Link: *45 x-github: @@ -72705,16 +75721,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-public-key parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *498 + schema: *499 examples: - default: *499 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72736,17 +75752,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 responses: '200': description: Response content: application/json: - schema: *496 + schema: *497 examples: - default: &633 + default: &634 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -72772,8 +75788,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 requestBody: required: true @@ -72831,8 +75847,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 responses: '204': @@ -72858,9 +75874,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-variables parameters: - - *465 - *466 - - *483 + - *467 + - *484 - *19 responses: '200': @@ -72877,9 +75893,9 @@ paths: type: integer variables: type: array - items: *500 + items: *501 examples: - default: *501 + default: *502 headers: Link: *45 x-github: @@ -72902,8 +75918,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-a-repository-variable parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -72955,17 +75971,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-a-repository-variable parameters: - - *465 - *466 + - *467 - *291 responses: '200': description: Response content: application/json: - schema: *500 + schema: *501 examples: - default: &634 + default: &635 value: name: USERNAME value: octocat @@ -72991,8 +76007,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-a-repository-variable parameters: - - *465 - *466 + - *467 - *291 requestBody: required: true @@ -73035,8 +76051,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-a-repository-variable parameters: - - *465 - *466 + - *467 - *291 responses: '204': @@ -73062,8 +76078,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#list-repository-workflows parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -73081,7 +76097,7 @@ paths: type: integer workflows: type: array - items: &502 + items: &503 title: Workflow description: A GitHub Actions workflow type: object @@ -73199,9 +76215,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-a-workflow parameters: - - *465 - *466 - - &503 + - *467 + - &504 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -73216,7 +76232,7 @@ paths: description: Response content: application/json: - schema: *502 + schema: *503 examples: default: value: @@ -73249,9 +76265,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#disable-a-workflow parameters: - - *465 - *466 - - *503 + - *467 + - *504 responses: '204': description: Response @@ -73276,9 +76292,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *465 - *466 - - *503 + - *467 + - *504 responses: '204': description: Empty response when `return_run_details` parameter is `false`. @@ -73365,9 +76381,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#enable-a-workflow parameters: - - *465 - *466 - - *503 + - *467 + - *504 responses: '204': description: Response @@ -73394,19 +76410,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *465 - *466 - - *503 + - *467 - *504 - *505 - *506 - *507 + - *508 - *17 - *19 - - *508 - - *487 - *509 + - *488 - *510 + - *511 responses: '200': description: Response @@ -73422,9 +76438,9 @@ paths: type: integer workflow_runs: type: array - items: *488 + items: *489 examples: - default: *511 + default: *512 headers: Link: *45 x-github: @@ -73457,9 +76473,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-workflow-usage parameters: - - *465 - *466 - - *503 + - *467 + - *504 responses: '200': description: Response @@ -73520,8 +76536,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-activities parameters: - - *465 - *466 + - *467 - *110 - *17 - *108 @@ -73689,8 +76705,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#list-assignees parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -73727,8 +76743,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *465 - *466 + - *467 - name: assignee in: path required: true @@ -73764,8 +76780,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#create-an-attestation parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -73875,8 +76891,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#list-attestations parameters: - - *465 - *466 + - *467 - *17 - *108 - *109 @@ -73933,7 +76949,7 @@ paths: initiator: type: string examples: - default: *512 + default: *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73953,8 +76969,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -73962,7 +76978,7 @@ paths: application/json: schema: type: array - items: &513 + items: &514 title: Autolink reference description: An autolink reference. type: object @@ -74021,8 +77037,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -74061,9 +77077,9 @@ paths: description: response content: application/json: - schema: *513 + schema: *514 examples: - default: &514 + default: &515 value: id: 1 key_prefix: TICKET- @@ -74094,9 +77110,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *465 - *466 - - &515 + - *467 + - &516 name: autolink_id description: The unique identifier of the autolink. in: path @@ -74108,9 +77124,9 @@ paths: description: Response content: application/json: - schema: *513 + schema: *514 examples: - default: *514 + default: *515 '404': *6 x-github: githubCloudOnly: false @@ -74130,9 +77146,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *465 - *466 - - *515 + - *467 + - *516 responses: '204': description: Response @@ -74156,8 +77172,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response if Dependabot is enabled @@ -74207,8 +77223,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-dependabot-security-updates parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -74229,8 +77245,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-dependabot-security-updates parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -74250,8 +77266,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#list-branches parameters: - - *465 - *466 + - *467 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -74289,7 +77305,7 @@ paths: - url protected: type: boolean - protection: &517 + protection: &518 title: Branch Protection description: Branch Protection type: object @@ -74332,7 +77348,7 @@ paths: required: - contexts - checks - enforce_admins: &520 + enforce_admins: &521 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -74349,7 +77365,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &522 + required_pull_request_reviews: &523 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -74433,7 +77449,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &519 + restrictions: &520 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -74726,9 +77742,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#get-a-branch parameters: - - *465 - *466 - - &518 + - *467 + - &519 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql). @@ -74742,14 +77758,14 @@ paths: description: Response content: application/json: - schema: &528 + schema: &529 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &579 + commit: &580 title: Commit description: Commit type: object @@ -74788,7 +77804,7 @@ paths: author: anyOf: - type: 'null' - - &516 + - &517 title: Git User description: Metaproperties for Git author/committer information. @@ -74810,7 +77826,7 @@ paths: committer: anyOf: - type: 'null' - - *516 + - *517 message: type: string examples: @@ -74834,7 +77850,7 @@ paths: required: - sha - url - verification: &640 + verification: &641 title: Verification type: object properties: @@ -74914,7 +77930,7 @@ paths: type: integer files: type: array - items: &590 + items: &591 title: Diff Entry description: Diff Entry type: object @@ -75010,7 +78026,7 @@ paths: - self protected: type: boolean - protection: *517 + protection: *518 protection_url: type: string format: uri @@ -75119,7 +78135,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *471 + '301': *472 '404': *6 x-github: githubCloudOnly: false @@ -75141,15 +78157,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-branch-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *517 + schema: *518 examples: default: value: @@ -75343,9 +78359,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-branch-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -75605,7 +78621,7 @@ paths: url: type: string format: uri - required_status_checks: &525 + required_status_checks: &526 title: Status Check Policy description: Status Check Policy type: object @@ -75764,7 +78780,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *519 + restrictions: *520 required_conversation_resolution: type: object properties: @@ -75876,9 +78892,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-branch-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '204': description: Response @@ -75903,17 +78919,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *520 + schema: *521 examples: - default: &521 + default: &522 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -75935,17 +78951,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *520 + schema: *521 examples: - default: *521 + default: *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75964,9 +78980,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '204': description: Response @@ -75991,17 +79007,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *522 + schema: *523 examples: - default: &523 + default: &524 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -76097,9 +79113,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: false content: @@ -76197,9 +79213,9 @@ paths: description: Response content: application/json: - schema: *522 + schema: *523 examples: - default: *523 + default: *524 '422': *15 x-github: githubCloudOnly: false @@ -76220,9 +79236,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '204': description: Response @@ -76249,17 +79265,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *520 + schema: *521 examples: - default: &524 + default: &525 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -76282,17 +79298,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *520 + schema: *521 examples: - default: *524 + default: *525 '404': *6 x-github: githubCloudOnly: false @@ -76312,9 +79328,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '204': description: Response @@ -76339,17 +79355,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-status-checks-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *525 + schema: *526 examples: - default: &526 + default: &527 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -76375,9 +79391,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-status-check-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: false content: @@ -76429,9 +79445,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *526 examples: - default: *526 + default: *527 '404': *6 '422': *15 x-github: @@ -76453,9 +79469,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '204': description: Response @@ -76479,9 +79495,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response @@ -76515,9 +79531,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-status-check-contexts parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: false content: @@ -76584,9 +79600,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-status-check-contexts parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: false content: @@ -76650,9 +79666,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: content: application/json: @@ -76718,15 +79734,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *519 + schema: *520 examples: default: value: @@ -76817,9 +79833,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '204': description: Response @@ -76842,9 +79858,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response @@ -76854,7 +79870,7 @@ paths: type: array items: *5 examples: - default: &527 + default: &528 value: - id: 1 slug: octoapp @@ -76911,9 +79927,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -76947,7 +79963,7 @@ paths: type: array items: *5 examples: - default: *527 + default: *528 '422': *15 x-github: githubCloudOnly: false @@ -76968,9 +79984,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -77004,7 +80020,7 @@ paths: type: array items: *5 examples: - default: *527 + default: *528 '422': *15 x-github: githubCloudOnly: false @@ -77025,9 +80041,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -77061,7 +80077,7 @@ paths: type: array items: *5 examples: - default: *527 + default: *528 '422': *15 x-github: githubCloudOnly: false @@ -77083,9 +80099,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response @@ -77115,9 +80131,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: false content: @@ -77176,9 +80192,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: false content: @@ -77237,9 +80253,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: content: application/json: @@ -77298,9 +80314,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response @@ -77334,9 +80350,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -77394,9 +80410,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -77454,9 +80470,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -77516,9 +80532,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#rename-a-branch parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -77540,7 +80556,7 @@ paths: description: Response content: application/json: - schema: *528 + schema: *529 examples: default: value: @@ -77654,8 +80670,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *465 - *466 + - *467 - *103 - *104 - *105 @@ -77691,8 +80707,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *465 - *466 + - *467 - name: bypass_request_number in: path required: true @@ -77765,8 +80781,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *465 - *466 + - *467 - *103 - *104 - *105 @@ -77806,8 +80822,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *465 - *466 + - *467 - name: bypass_request_number in: path required: true @@ -77877,8 +80893,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *465 - *466 + - *467 - name: bypass_request_number in: path required: true @@ -77949,8 +80965,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *465 - *466 + - *467 - name: bypass_response_id in: path required: true @@ -77983,8 +80999,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#create-a-check-run parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -78263,7 +81279,7 @@ paths: description: Response content: application/json: - schema: &529 + schema: &530 title: CheckRun description: A check performed on the code of a given code change type: object @@ -78399,7 +81415,7 @@ paths: check. type: array items: *222 - deployment: &859 + deployment: &860 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -78686,9 +81702,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#get-a-check-run parameters: - - *465 - *466 - - &530 + - *467 + - &531 name: check_run_id description: The unique identifier of the check run. in: path @@ -78700,9 +81716,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *530 examples: - default: &531 + default: &532 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -78802,9 +81818,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run parameters: - - *465 - *466 - - *530 + - *467 + - *531 requestBody: required: true content: @@ -79044,9 +82060,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *530 examples: - default: *531 + default: *532 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79066,9 +82082,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-run-annotations parameters: - - *465 - *466 - - *530 + - *467 + - *531 - *17 - *19 responses: @@ -79178,9 +82194,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#rerequest-a-check-run parameters: - - *465 - *466 - - *530 + - *467 + - *531 responses: '201': description: Response @@ -79224,8 +82240,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -79247,7 +82263,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &533 + schema: &534 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -79345,7 +82361,7 @@ paths: - string - 'null' format: date-time - head_commit: *532 + head_commit: *533 latest_check_runs_count: type: integer check_runs_url: @@ -79373,7 +82389,7 @@ paths: - check_runs_url - pull_requests examples: - default: &534 + default: &535 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -79664,9 +82680,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *533 + schema: *534 examples: - default: *534 + default: *535 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79685,8 +82701,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -79995,9 +83011,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite parameters: - - *465 - *466 - - &535 + - *467 + - &536 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -80009,9 +83025,9 @@ paths: description: Response content: application/json: - schema: *533 + schema: *534 examples: - default: *534 + default: *535 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80034,17 +83050,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *465 - *466 - - *535 - - &585 + - *467 + - *536 + - &586 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &586 + - &587 name: status description: Returns check runs with the specified `status`. in: query @@ -80083,9 +83099,9 @@ paths: type: integer check_runs: type: array - items: *529 + items: *530 examples: - default: &587 + default: &588 value: total_count: 1 check_runs: @@ -80187,9 +83203,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#rerequest-a-check-suite parameters: - - *465 - *466 - - *535 + - *467 + - *536 responses: '201': description: Response @@ -80222,21 +83238,21 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *465 - *466 + - *467 - *311 - *312 - *19 - *17 - - &551 + - &552 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *536 - - &552 + schema: *537 + - &553 name: pr description: The number of the pull request for the results you want to list. in: query @@ -80267,7 +83283,7 @@ paths: be returned. in: query required: false - schema: *537 + schema: *538 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -80291,7 +83307,7 @@ paths: updated_at: *135 url: *132 html_url: *133 - instances_url: *538 + instances_url: *539 state: *113 fixed_at: *137 dismissed_by: @@ -80299,11 +83315,11 @@ paths: - type: 'null' - *4 dismissed_at: *136 - dismissed_reason: *539 - dismissed_comment: *540 - rule: *541 - tool: *542 - most_recent_instance: *543 + dismissed_reason: *540 + dismissed_comment: *541 + rule: *542 + tool: *543 + most_recent_instance: *544 dismissal_approved_by: anyOf: - type: 'null' @@ -80426,7 +83442,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &544 + '403': &545 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -80453,9 +83469,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *465 - *466 - - &545 + - *467 + - &546 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -80469,7 +83485,7 @@ paths: description: Response content: application/json: - schema: &546 + schema: &547 type: object properties: number: *127 @@ -80477,7 +83493,7 @@ paths: updated_at: *135 url: *132 html_url: *133 - instances_url: *538 + instances_url: *539 state: *113 fixed_at: *137 dismissed_by: @@ -80485,8 +83501,8 @@ paths: - type: 'null' - *4 dismissed_at: *136 - dismissed_reason: *539 - dismissed_comment: *540 + dismissed_reason: *540 + dismissed_comment: *541 rule: type: object properties: @@ -80548,8 +83564,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *542 - most_recent_instance: *543 + tool: *543 + most_recent_instance: *544 dismissal_approved_by: anyOf: - type: 'null' @@ -80645,7 +83661,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -80665,9 +83681,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 requestBody: required: true content: @@ -80682,8 +83698,8 @@ paths: enum: - open - dismissed - dismissed_reason: *539 - dismissed_comment: *540 + dismissed_reason: *540 + dismissed_comment: *541 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -80711,7 +83727,7 @@ paths: description: Response content: application/json: - schema: *546 + schema: *547 examples: default: value: @@ -80787,7 +83803,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &550 + '403': &551 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -80814,15 +83830,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 responses: '200': description: Response content: application/json: - schema: &547 + schema: &548 type: object properties: status: @@ -80849,13 +83865,13 @@ paths: - description - started_at examples: - default: &548 + default: &549 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &549 + '400': &550 description: Bad Request content: application/json: @@ -80866,7 +83882,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -80891,29 +83907,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 responses: '200': description: OK content: application/json: - schema: *547 + schema: *548 examples: - default: *548 + default: *549 '202': description: Accepted content: application/json: - schema: *547 + schema: *548 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *549 + '400': *550 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -80945,9 +83961,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 requestBody: required: false content: @@ -80993,8 +84009,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *549 - '403': *550 + '400': *550 + '403': *551 '404': *6 '422': description: Unprocessable Entity @@ -81018,13 +84034,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 - *19 - *17 - - *551 - *552 + - *553 responses: '200': description: Response @@ -81035,10 +84051,10 @@ paths: items: type: object properties: - ref: *536 - analysis_key: *553 - environment: *554 - category: *555 + ref: *537 + analysis_key: *554 + environment: *555 + category: *556 state: type: - string @@ -81055,7 +84071,7 @@ paths: properties: text: type: string - location: *556 + location: *557 html_url: type: string classifications: @@ -81063,7 +84079,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: *557 + items: *558 examples: default: value: @@ -81100,7 +84116,7 @@ paths: end_column: 50 classifications: - source - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -81134,25 +84150,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *465 - *466 + - *467 - *311 - *312 - *19 - *17 - - *552 + - *553 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *536 + schema: *537 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &558 + schema: &559 type: string description: An identifier for the upload. examples: @@ -81174,23 +84190,23 @@ paths: application/json: schema: type: array - items: &559 + items: &560 type: object properties: - ref: *536 - commit_sha: &567 + ref: *537 + commit_sha: &568 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *553 + analysis_key: *554 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *555 + category: *556 error: type: string examples: @@ -81215,8 +84231,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *558 - tool: *542 + sarif_id: *559 + tool: *543 deletable: type: boolean warning: @@ -81278,7 +84294,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -81314,8 +84330,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *465 - *466 + - *467 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -81328,7 +84344,7 @@ paths: description: Response content: application/json: - schema: *559 + schema: *560 examples: response: summary: application/json response @@ -81382,7 +84398,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *544 + '403': *545 '404': *6 '422': description: Response if analysis could not be processed @@ -81469,8 +84485,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *465 - *466 + - *467 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -81526,7 +84542,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *550 + '403': *551 '404': *6 '503': *192 x-github: @@ -81548,8 +84564,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -81557,7 +84573,7 @@ paths: application/json: schema: type: array - items: &560 + items: &561 title: CodeQL Database description: A CodeQL database. type: object @@ -81669,7 +84685,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -81698,8 +84714,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *465 - *466 + - *467 - name: language in: path description: The language of the CodeQL database. @@ -81711,7 +84727,7 @@ paths: description: Response content: application/json: - schema: *560 + schema: *561 examples: default: value: @@ -81743,9 +84759,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &594 + '302': &595 description: Found - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -81767,8 +84783,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *465 - *466 + - *467 - name: language in: path description: The language of the CodeQL database. @@ -81778,7 +84794,7 @@ paths: responses: '204': description: Response - '403': *550 + '403': *551 '404': *6 '503': *192 x-github: @@ -81806,8 +84822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -81816,7 +84832,7 @@ paths: type: object additionalProperties: false properties: - language: &561 + language: &562 type: string description: The language targeted by the CodeQL query enum: @@ -81896,7 +84912,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &565 + schema: &566 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -81906,7 +84922,7 @@ paths: description: The ID of the variant analysis. controller_repo: *120 actor: *4 - query_language: *561 + query_language: *562 query_pack_url: type: string description: The download url for the query pack. @@ -81954,7 +84970,7 @@ paths: items: type: object properties: - repository: &562 + repository: &563 title: Repository Identifier description: Repository Identifier type: object @@ -81996,7 +85012,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &566 + analysis_status: &567 type: string description: The new status of the CodeQL variant analysis repository task. @@ -82028,7 +85044,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &563 + access_mismatch_repos: &564 type: object properties: repository_count: @@ -82043,7 +85059,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *562 + items: *563 required: - repository_count - repositories @@ -82066,8 +85082,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *563 - over_limit_repos: *563 + no_codeql_db_repos: *564 + over_limit_repos: *564 required: - access_mismatch_repos - not_found_repos @@ -82083,7 +85099,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &564 + value: &565 summary: Default response value: id: 1 @@ -82229,10 +85245,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *564 + value: *565 repository_lists: summary: Response for a successful variant analysis submission - value: *564 + value: *565 '404': *6 '422': description: Unable to process variant analysis submission @@ -82260,8 +85276,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *465 - *466 + - *467 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -82273,9 +85289,9 @@ paths: description: Response content: application/json: - schema: *565 + schema: *566 examples: - default: *564 + default: *565 '404': *6 '503': *192 x-github: @@ -82298,7 +85314,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *465 + - *466 - name: repo in: path description: The name of the controller repository. @@ -82333,7 +85349,7 @@ paths: type: object properties: repository: *120 - analysis_status: *566 + analysis_status: *567 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -82458,8 +85474,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -82552,7 +85568,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -82573,8 +85589,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -82668,7 +85684,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *550 + '403': *551 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -82739,8 +85755,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -82748,7 +85764,7 @@ paths: schema: type: object properties: - commit_sha: *567 + commit_sha: *568 ref: type: string description: |- @@ -82808,7 +85824,7 @@ paths: schema: type: object properties: - id: *558 + id: *559 url: type: string description: The REST API URL for checking the status of the upload. @@ -82822,7 +85838,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *550 + '403': *551 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -82845,8 +85861,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *465 - *466 + - *467 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -82894,7 +85910,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *544 + '403': *545 '404': description: Not Found if the sarif id does not match any upload '503': *192 @@ -82919,8 +85935,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -83001,8 +86017,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-codeowners-errors parameters: - - *465 - *466 + - *467 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -83130,8 +86146,8 @@ paths: parameters: - *17 - *19 - - *465 - *466 + - *467 responses: '200': description: Response @@ -83445,8 +86461,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -83512,7 +86528,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -83520,7 +86536,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '400': *14 '401': *23 '403': *27 @@ -83549,8 +86565,8 @@ paths: parameters: - *17 - *19 - - *465 - *466 + - *467 responses: '200': description: Response @@ -83614,8 +86630,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *465 - *466 + - *467 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -83652,9 +86668,9 @@ paths: type: integer machines: type: array - items: *569 + items: *570 examples: - default: &804 + default: &805 value: total_count: 2 machines: @@ -83694,8 +86710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *465 - *466 + - *467 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -83782,8 +86798,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *465 - *466 + - *467 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -83852,8 +86868,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -83871,7 +86887,7 @@ paths: type: integer secrets: type: array - items: &573 + items: &574 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -83892,7 +86908,7 @@ paths: - created_at - updated_at examples: - default: *570 + default: *571 headers: Link: *45 x-github: @@ -83915,16 +86931,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *571 + schema: *572 examples: - default: *572 + default: *573 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -83944,17 +86960,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 responses: '200': description: Response content: application/json: - schema: *573 + schema: *574 examples: - default: *574 + default: *575 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83974,8 +86990,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 requestBody: required: true @@ -84028,8 +87044,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 responses: '204': @@ -84058,8 +87074,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *465 - *466 + - *467 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -84097,7 +87113,7 @@ paths: application/json: schema: type: array - items: &575 + items: &576 title: Collaborator description: Collaborator type: object @@ -84290,8 +87306,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *465 - *466 + - *467 - *140 responses: '204': @@ -84338,8 +87354,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *465 - *466 + - *467 - *140 requestBody: required: false @@ -84366,7 +87382,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &652 + schema: &653 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -84594,8 +87610,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *465 - *466 + - *467 - *140 responses: '204': @@ -84627,8 +87643,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *465 - *466 + - *467 - *140 responses: '200': @@ -84649,7 +87665,7 @@ paths: user: anyOf: - type: 'null' - - *575 + - *576 required: - permission - role_name @@ -84703,8 +87719,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -84714,7 +87730,7 @@ paths: application/json: schema: type: array - items: &576 + items: &577 title: Commit Comment description: Commit Comment type: object @@ -84772,7 +87788,7 @@ paths: - created_at - updated_at examples: - default: &581 + default: &582 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -84831,17 +87847,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment parameters: - - *465 - *466 + - *467 - *233 responses: '200': description: Response content: application/json: - schema: *576 + schema: *577 examples: - default: &582 + default: &583 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -84898,8 +87914,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#update-a-commit-comment parameters: - - *465 - *466 + - *467 - *233 requestBody: required: true @@ -84922,7 +87938,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *577 examples: default: value: @@ -84973,8 +87989,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#delete-a-commit-comment parameters: - - *465 - *466 + - *467 - *233 responses: '204': @@ -84996,8 +88012,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *465 - *466 + - *467 - *233 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). @@ -85024,7 +88040,7 @@ paths: application/json: schema: type: array - items: &577 + items: &578 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -85068,7 +88084,7 @@ paths: - content - created_at examples: - default: &655 + default: &656 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -85113,8 +88129,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *465 - *466 + - *467 - *233 requestBody: required: true @@ -85147,9 +88163,9 @@ paths: description: Reaction exists content: application/json: - schema: *577 + schema: *578 examples: - default: &578 + default: &579 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -85178,9 +88194,9 @@ paths: description: Reaction created content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '422': *15 x-github: githubCloudOnly: false @@ -85202,10 +88218,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *465 - *466 + - *467 - *233 - - &656 + - &657 name: reaction_id description: The unique identifier of the reaction. in: path @@ -85260,8 +88276,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-commits parameters: - - *465 - *466 + - *467 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -85317,9 +88333,9 @@ paths: application/json: schema: type: array - items: *579 + items: *580 examples: - default: &705 + default: &706 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -85413,9 +88429,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-branches-for-head-commit parameters: - - *465 - *466 - - &580 + - *467 + - &581 name: commit_sha description: The SHA of the commit. in: path @@ -85487,9 +88503,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments parameters: - - *465 - *466 - - *580 + - *467 + - *581 - *17 - *19 responses: @@ -85499,9 +88515,9 @@ paths: application/json: schema: type: array - items: *576 + items: *577 examples: - default: *581 + default: *582 headers: Link: *45 x-github: @@ -85529,9 +88545,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#create-a-commit-comment parameters: - - *465 - *466 - - *580 + - *467 + - *581 requestBody: required: true content: @@ -85566,9 +88582,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *577 examples: - default: *582 + default: *583 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -85596,9 +88612,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *465 - *466 - - *580 + - *467 + - *581 - *17 - *19 responses: @@ -85608,9 +88624,9 @@ paths: application/json: schema: type: array - items: *583 + items: *584 examples: - default: &697 + default: &698 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -86147,11 +89163,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#get-a-commit parameters: - - *465 - *466 + - *467 - *19 - *17 - - &584 + - &585 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -86166,9 +89182,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: &683 + default: &684 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -86256,7 +89272,7 @@ paths: schema: type: string examples: - default: &591 + default: &592 value: | diff --git a/testfile b/testfile index 9bdeaeb..912c7ef 100644 @@ -86269,7 +89285,7 @@ paths: schema: type: string examples: - default: &592 + default: &593 value: | From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 From: Mona Lisa <87831417+monalisa@users.noreply.github.com> @@ -86322,11 +89338,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *465 - *466 - - *584 + - *467 - *585 - *586 + - *587 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -86360,9 +89376,9 @@ paths: type: integer check_runs: type: array - items: *529 + items: *530 examples: - default: *587 + default: *588 headers: Link: *45 x-github: @@ -86387,9 +89403,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *465 - *466 - - *584 + - *467 + - *585 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -86397,7 +89413,7 @@ paths: schema: type: integer example: 1 - - *585 + - *586 - *17 - *19 responses: @@ -86415,7 +89431,7 @@ paths: type: integer check_suites: type: array - items: *533 + items: *534 examples: default: value: @@ -86615,9 +89631,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *465 - *466 - - *584 + - *467 + - *585 - *17 - *19 responses: @@ -86819,9 +89835,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *465 - *466 - - *584 + - *467 + - *585 - *17 - *19 responses: @@ -86831,7 +89847,7 @@ paths: application/json: schema: type: array - items: &758 + items: &759 title: Status description: The status of a commit. type: object @@ -86912,7 +89928,7 @@ paths: site_admin: false headers: Link: *45 - '301': *471 + '301': *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86940,8 +89956,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/community#get-community-profile-metrics parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -86974,11 +89990,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *588 + - *589 code_of_conduct_file: anyOf: - type: 'null' - - &589 + - &590 title: Community Health File type: object properties: @@ -86998,19 +90014,19 @@ paths: contributing: anyOf: - type: 'null' - - *589 + - *590 readme: anyOf: - type: 'null' - - *589 + - *590 issue_template: anyOf: - type: 'null' - - *589 + - *590 pull_request_template: anyOf: - type: 'null' - - *589 + - *590 required: - code_of_conduct - code_of_conduct_file @@ -87139,8 +90155,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#compare-two-commits parameters: - - *465 - *466 + - *467 - *19 - *17 - name: basehead @@ -87188,8 +90204,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *579 - merge_base_commit: *579 + base_commit: *580 + merge_base_commit: *580 status: type: string enum: @@ -87213,10 +90229,10 @@ paths: - 6 commits: type: array - items: *579 + items: *580 files: type: array - items: *590 + items: *591 required: - url - html_url @@ -87462,12 +90478,12 @@ paths: schema: type: string examples: - default: *591 + default: *592 application/vnd.github.patch: schema: type: string examples: - default: *592 + default: *593 '404': *6 '500': *38 '503': *192 @@ -87512,8 +90528,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-repository-content parameters: - - *465 - *466 + - *467 - name: path description: path parameter in: path @@ -87683,7 +90699,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &593 + response-if-content-is-a-file-github-object: &594 summary: Response if content is a file value: type: file @@ -87820,7 +90836,7 @@ paths: - size - type - url - - &710 + - &711 title: Content File description: Content File type: object @@ -88038,7 +91054,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *593 + response-if-content-is-a-file: *594 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -88107,7 +91123,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *594 + '302': *595 '304': *35 x-github: githubCloudOnly: false @@ -88130,8 +91146,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#create-or-update-file-contents parameters: - - *465 - *466 + - *467 - name: path description: path parameter in: path @@ -88226,7 +91242,7 @@ paths: description: Response content: application/json: - schema: &595 + schema: &596 title: File Commit description: File Commit type: object @@ -88382,7 +91398,7 @@ paths: description: Response content: application/json: - schema: *595 + schema: *596 examples: example-for-creating-a-file: value: @@ -88436,7 +91452,7 @@ paths: schema: oneOf: - *3 - - &635 + - &636 description: Repository rule violation was detected type: object properties: @@ -88457,7 +91473,7 @@ paths: items: type: object properties: - placeholder_id: &750 + placeholder_id: &751 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -88489,8 +91505,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#delete-a-file parameters: - - *465 - *466 + - *467 - name: path description: path parameter in: path @@ -88551,7 +91567,7 @@ paths: description: Response content: application/json: - schema: *595 + schema: *596 examples: default: value: @@ -88606,8 +91622,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-contributors parameters: - - *465 - *466 + - *467 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -88731,8 +91747,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *465 - *466 + - *467 - *332 - *333 - *334 @@ -88745,7 +91761,7 @@ paths: schema: type: string - *337 - - *596 + - *597 - *338 - *339 - *340 @@ -88760,7 +91776,7 @@ paths: application/json: schema: type: array - items: &600 + items: &601 type: object description: A Dependabot alert. properties: @@ -88811,7 +91827,7 @@ paths: - transitive - inconclusive - - security_advisory: *597 + security_advisory: *598 security_vulnerability: *131 url: *132 html_url: *133 @@ -88842,8 +91858,8 @@ paths: dismissal. maxLength: 280 fixed_at: *137 - auto_dismissed_at: *598 - dismissal_request: *599 + auto_dismissed_at: *599 + dismissal_request: *600 assignees: type: array description: The users assigned to this alert. @@ -89098,9 +92114,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *465 - *466 - - &601 + - *467 + - &602 name: alert_number in: path description: |- @@ -89115,7 +92131,7 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: default: value: @@ -89247,9 +92263,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *465 - *466 - - *601 + - *467 + - *602 requestBody: required: true content: @@ -89305,7 +92321,7 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: default: value: @@ -89435,8 +92451,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-repository-secrets parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -89454,7 +92470,7 @@ paths: type: integer secrets: type: array - items: &604 + items: &605 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -89508,16 +92524,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *602 + schema: *603 examples: - default: *603 + default: *604 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89537,15 +92553,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 responses: '200': description: Response content: application/json: - schema: *604 + schema: *605 examples: default: value: @@ -89571,8 +92587,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 requestBody: required: true @@ -89625,8 +92641,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 responses: '204': @@ -89649,8 +92665,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *465 - *466 + - *467 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -89824,8 +92840,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -90084,8 +93100,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *465 - *466 + - *467 - name: sbom_uuid in: path required: true @@ -90096,7 +93112,7 @@ paths: '302': description: Redirects to a temporary download URL for the completed SBOM. headers: - Location: *605 + Location: *606 '202': description: SBOM is still being processed, no content is returned. '404': *6 @@ -90117,8 +93133,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *465 - *466 + - *467 responses: '201': description: Response @@ -90156,8 +93172,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -90240,7 +93256,7 @@ paths: - version - url additionalProperties: false - metadata: &606 + metadata: &607 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -90279,7 +93295,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *606 + metadata: *607 resolved: type: object description: A collection of resolved package dependencies. @@ -90293,7 +93309,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *606 + metadata: *607 relationship: type: string description: A notation of whether a dependency is requested @@ -90426,8 +93442,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments parameters: - - *465 - *466 + - *467 - name: sha description: The SHA recorded at creation time. in: query @@ -90468,9 +93484,9 @@ paths: application/json: schema: type: array - items: *607 + items: *608 examples: - default: *608 + default: *609 headers: Link: *45 x-github: @@ -90536,8 +93552,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#create-a-deployment parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -90619,7 +93635,7 @@ paths: description: Response content: application/json: - schema: *607 + schema: *608 examples: simple-example: summary: Simple example @@ -90692,9 +93708,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#get-a-deployment parameters: - - *465 - *466 - - &609 + - *467 + - &610 name: deployment_id description: deployment_id parameter in: path @@ -90706,7 +93722,7 @@ paths: description: Response content: application/json: - schema: *607 + schema: *608 examples: default: value: @@ -90771,9 +93787,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#delete-a-deployment parameters: - - *465 - *466 - - *609 + - *467 + - *610 responses: '204': description: Response @@ -90795,9 +93811,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#list-deployment-statuses parameters: - - *465 - *466 - - *609 + - *467 + - *610 - *17 - *19 responses: @@ -90807,7 +93823,7 @@ paths: application/json: schema: type: array - items: &610 + items: &611 title: Deployment Status description: The status of a deployment. type: object @@ -90971,9 +93987,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#create-a-deployment-status parameters: - - *465 - *466 - - *609 + - *467 + - *610 requestBody: required: true content: @@ -91048,9 +94064,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *611 examples: - default: &611 + default: &612 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -91106,9 +94122,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#get-a-deployment-status parameters: - - *465 - *466 - - *609 + - *467 + - *610 - name: status_id in: path required: true @@ -91119,9 +94135,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *611 examples: - default: *611 + default: *612 '404': *6 x-github: githubCloudOnly: false @@ -91148,12 +94164,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *465 - *466 - - *612 + - *467 - *613 - *614 - *615 + - *616 - *17 - *19 responses: @@ -91163,9 +94179,9 @@ paths: application/json: schema: type: array - items: *616 + items: *617 examples: - default: *617 + default: *618 '404': *6 '403': *27 '500': *38 @@ -91189,8 +94205,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -91202,7 +94218,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *616 + schema: *617 examples: default: value: @@ -91258,8 +94274,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -91318,12 +94334,12 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *465 - *466 - - *612 + - *467 - *613 - *614 - *615 + - *616 - *17 - *19 responses: @@ -91333,9 +94349,9 @@ paths: application/json: schema: type: array - items: *618 + items: *619 examples: - default: *619 + default: *620 '404': *6 '403': *27 '500': *38 @@ -91359,8 +94375,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -91372,7 +94388,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -91423,8 +94439,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -91462,7 +94478,7 @@ paths: description: The created dismissal request. content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -91513,8 +94529,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -91585,8 +94601,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -91619,8 +94635,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - *103 - *104 - *105 @@ -91661,8 +94677,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -91732,8 +94748,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -91802,8 +94818,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -91860,8 +94876,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#list-environments parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -91879,7 +94895,7 @@ paths: - 5 environments: type: array - items: &621 + items: &622 title: Environment description: Details of a deployment environment type: object @@ -91941,7 +94957,7 @@ paths: type: string examples: - wait_timer - wait_timer: &623 + wait_timer: &624 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -91983,7 +94999,7 @@ paths: items: type: object properties: - type: *620 + type: *621 reviewer: anyOf: - *4 @@ -92010,7 +95026,7 @@ paths: - id - node_id - type - deployment_branch_policy: &624 + deployment_branch_policy: &625 type: - object - 'null' @@ -92127,9 +95143,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#get-an-environment parameters: - - *465 - *466 - - &622 + - *467 + - &623 name: environment_name in: path required: true @@ -92142,9 +95158,9 @@ paths: description: Response content: application/json: - schema: *621 + schema: *622 examples: - default: &625 + default: &626 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -92228,9 +95244,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#create-or-update-an-environment parameters: - - *465 - *466 - - *622 + - *467 + - *623 requestBody: required: false content: @@ -92240,7 +95256,7 @@ paths: - object - 'null' properties: - wait_timer: *623 + wait_timer: *624 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -92259,14 +95275,14 @@ paths: items: type: object properties: - type: *620 + type: *621 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *624 + deployment_branch_policy: *625 additionalProperties: false examples: default: @@ -92286,9 +95302,9 @@ paths: description: Response content: application/json: - schema: *621 + schema: *622 examples: - default: *625 + default: *626 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -92312,9 +95328,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#delete-an-environment parameters: - - *465 - *466 - - *622 + - *467 + - *623 responses: '204': description: Default response @@ -92339,9 +95355,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *465 - *466 - - *622 + - *467 + - *623 - *17 - *19 responses: @@ -92360,7 +95376,7 @@ paths: - 2 branch_policies: type: array - items: &626 + items: &627 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -92421,9 +95437,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *465 - *466 - - *622 + - *467 + - *623 requestBody: required: true content: @@ -92471,9 +95487,9 @@ paths: description: Response content: application/json: - schema: *626 + schema: *627 examples: - example-wildcard: &627 + example-wildcard: &628 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -92515,10 +95531,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *465 - *466 - - *622 - - &628 + - *467 + - *623 + - &629 name: branch_policy_id in: path required: true @@ -92530,9 +95546,9 @@ paths: description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: *627 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92551,10 +95567,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *465 - *466 - - *622 - - *628 + - *467 + - *623 + - *629 requestBody: required: true content: @@ -92583,9 +95599,9 @@ paths: description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: *627 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92604,10 +95620,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *465 - *466 - - *622 - - *628 + - *467 + - *623 + - *629 responses: '204': description: Response @@ -92632,9 +95648,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *622 + - *623 + - *467 - *466 - - *465 responses: '200': description: List of deployment protection rules @@ -92651,7 +95667,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &629 + items: &630 title: Deployment protection rule description: Deployment protection rule type: object @@ -92673,7 +95689,7 @@ paths: for the environment. examples: - true - app: &630 + app: &631 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -92776,9 +95792,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *622 + - *623 + - *467 - *466 - - *465 requestBody: content: application/json: @@ -92799,9 +95815,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *629 + schema: *630 examples: - default: &631 + default: &632 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -92836,9 +95852,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *622 + - *623 + - *467 - *466 - - *465 - *19 - *17 responses: @@ -92858,7 +95874,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *630 + items: *631 examples: default: value: @@ -92893,10 +95909,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *465 - *466 - - *622 - - &632 + - *467 + - *623 + - &633 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -92908,9 +95924,9 @@ paths: description: Response content: application/json: - schema: *629 + schema: *630 examples: - default: *631 + default: *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92931,10 +95947,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *622 + - *623 + - *467 - *466 - - *465 - - *632 + - *633 responses: '204': description: Response @@ -92960,9 +95976,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-environment-secrets parameters: - - *465 - *466 - - *622 + - *467 + - *623 - *17 - *19 responses: @@ -92980,9 +95996,9 @@ paths: type: integer secrets: type: array - items: *496 + items: *497 examples: - default: *497 + default: *498 headers: Link: *45 x-github: @@ -93007,17 +96023,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-public-key parameters: - - *465 - *466 - - *622 + - *467 + - *623 responses: '200': description: Response content: application/json: - schema: *498 + schema: *499 examples: - default: *499 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93039,18 +96055,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-secret parameters: - - *465 - *466 - - *622 + - *467 + - *623 - *288 responses: '200': description: Response content: application/json: - schema: *496 + schema: *497 examples: - default: *633 + default: *634 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93072,9 +96088,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *465 - *466 - - *622 + - *467 + - *623 - *288 requestBody: required: true @@ -93132,9 +96148,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-an-environment-secret parameters: - - *465 - *466 - - *622 + - *467 + - *623 - *288 responses: '204': @@ -93160,10 +96176,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-environment-variables parameters: - - *465 - *466 - - *622 - - *483 + - *467 + - *623 + - *484 - *19 responses: '200': @@ -93180,9 +96196,9 @@ paths: type: integer variables: type: array - items: *500 + items: *501 examples: - default: *501 + default: *502 headers: Link: *45 x-github: @@ -93205,9 +96221,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-an-environment-variable parameters: - - *465 - *466 - - *622 + - *467 + - *623 requestBody: required: true content: @@ -93259,18 +96275,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-an-environment-variable parameters: - - *465 - *466 - - *622 + - *467 + - *623 - *291 responses: '200': description: Response content: application/json: - schema: *500 + schema: *501 examples: - default: *634 + default: *635 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93291,10 +96307,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-an-environment-variable parameters: - - *465 - *466 + - *467 - *291 - - *622 + - *623 requestBody: required: true content: @@ -93336,10 +96352,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-an-environment-variable parameters: - - *465 - *466 + - *467 - *291 - - *622 + - *623 responses: '204': description: Response @@ -93361,8 +96377,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-repository-events parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -93430,8 +96446,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#list-forks parameters: - - *465 - *466 + - *467 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -93590,8 +96606,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#create-a-fork parameters: - - *465 - *466 + - *467 requestBody: required: false content: @@ -93624,9 +96640,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: *472 + default: *473 '400': *14 '422': *15 '403': *27 @@ -93647,8 +96663,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#create-a-blob parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -93708,7 +96724,7 @@ paths: schema: oneOf: - *253 - - *635 + - *636 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93733,8 +96749,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#get-a-blob parameters: - - *465 - *466 + - *467 - name: file_sha in: path required: true @@ -93834,8 +96850,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/commits#create-a-commit parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -93944,7 +96960,7 @@ paths: description: Response content: application/json: - schema: &636 + schema: &637 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -94171,15 +97187,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/commits#get-a-commit-object parameters: - - *465 - *466 - - *580 + - *467 + - *581 responses: '200': description: Response content: application/json: - schema: *636 + schema: *637 examples: default: value: @@ -94235,9 +97251,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#list-matching-references parameters: - - *465 - *466 - - &637 + - *467 + - &638 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -94254,7 +97270,7 @@ paths: application/json: schema: type: array - items: &638 + items: &639 title: Git Reference description: Git references within a repository type: object @@ -94330,17 +97346,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference parameters: - - *465 - *466 - - *637 + - *467 + - *638 responses: '200': description: Response content: application/json: - schema: *638 + schema: *639 examples: - default: &639 + default: &640 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -94369,8 +97385,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#create-a-reference parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -94399,9 +97415,9 @@ paths: description: Response content: application/json: - schema: *638 + schema: *639 examples: - default: *639 + default: *640 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -94427,9 +97443,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#update-a-reference parameters: - - *465 - *466 - - *637 + - *467 + - *638 requestBody: required: true content: @@ -94458,9 +97474,9 @@ paths: description: Response content: application/json: - schema: *638 + schema: *639 examples: - default: *639 + default: *640 '422': *15 '409': *119 x-github: @@ -94478,9 +97494,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#delete-a-reference parameters: - - *465 - *466 - - *637 + - *467 + - *638 responses: '204': description: Response @@ -94535,8 +97551,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/tags#create-a-tag-object parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -94603,7 +97619,7 @@ paths: description: Response content: application/json: - schema: &641 + schema: &642 title: Git Tag description: Metadata for a Git tag type: object @@ -94659,7 +97675,7 @@ paths: - sha - type - url - verification: *640 + verification: *641 required: - sha - url @@ -94669,7 +97685,7 @@ paths: - tag - message examples: - default: &642 + default: &643 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -94742,8 +97758,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/tags#get-a-tag parameters: - - *465 - *466 + - *467 - name: tag_sha in: path required: true @@ -94754,9 +97770,9 @@ paths: description: Response content: application/json: - schema: *641 + schema: *642 examples: - default: *642 + default: *643 '404': *6 '409': *119 x-github: @@ -94780,8 +97796,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/trees#create-a-tree parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -94855,7 +97871,7 @@ paths: description: Response content: application/json: - schema: &643 + schema: &644 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -94957,8 +97973,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/trees#get-a-tree parameters: - - *465 - *466 + - *467 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -94981,7 +97997,7 @@ paths: description: Response content: application/json: - schema: *643 + schema: *644 examples: default-response: summary: Default response @@ -95040,8 +98056,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-repository-webhooks parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -95051,7 +98067,7 @@ paths: application/json: schema: type: array - items: &644 + items: &645 title: Webhook description: Webhooks for repositories. type: object @@ -95114,7 +98130,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &895 + last_response: &896 title: Hook Response type: object properties: @@ -95191,8 +98207,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#create-a-repository-webhook parameters: - - *465 - *466 + - *467 requestBody: required: false content: @@ -95245,9 +98261,9 @@ paths: description: Response content: application/json: - schema: *644 + schema: *645 examples: - default: &645 + default: &646 value: type: Repository id: 12345678 @@ -95295,17 +98311,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 responses: '200': description: Response content: application/json: - schema: *644 + schema: *645 examples: - default: *645 + default: *646 '404': *6 x-github: githubCloudOnly: false @@ -95325,8 +98341,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#update-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 requestBody: required: true @@ -95372,9 +98388,9 @@ paths: description: Response content: application/json: - schema: *644 + schema: *645 examples: - default: *645 + default: *646 '422': *15 '404': *6 x-github: @@ -95395,8 +98411,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 responses: '204': @@ -95421,8 +98437,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *465 - *466 + - *467 - *352 responses: '200': @@ -95450,8 +98466,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *465 - *466 + - *467 - *352 requestBody: required: false @@ -95496,8 +98512,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 - *17 - *353 @@ -95530,8 +98546,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 - *16 responses: @@ -95560,8 +98576,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 - *16 responses: @@ -95585,8 +98601,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 responses: '204': @@ -95612,8 +98628,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *465 - *466 + - *467 - *352 responses: '204': @@ -95637,8 +98653,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response if immutable releases are enabled @@ -95686,8 +98702,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-immutable-releases parameters: - - *465 - *466 + - *467 responses: '204': *126 '409': *119 @@ -95707,8 +98723,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-immutable-releases parameters: - - *465 - *466 + - *467 responses: '204': *126 '409': *119 @@ -95765,14 +98781,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-an-import-status parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: &646 + schema: &647 title: Import description: A repository import from an external source. type: object @@ -95879,7 +98895,7 @@ paths: - html_url - authors_url examples: - default: &649 + default: &650 value: vcs: subversion use_lfs: true @@ -95895,7 +98911,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &647 + '503': &648 description: Unavailable due to service under maintenance. content: application/json: @@ -95924,8 +98940,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#start-an-import parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -95973,7 +98989,7 @@ paths: description: Response content: application/json: - schema: *646 + schema: *647 examples: default: value: @@ -95998,7 +99014,7 @@ paths: type: string '422': *15 '404': *6 - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96026,8 +99042,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import parameters: - - *465 - *466 + - *467 requestBody: required: false content: @@ -96079,7 +99095,7 @@ paths: description: Response content: application/json: - schema: *646 + schema: *647 examples: example-1: summary: Example 1 @@ -96127,7 +99143,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96150,12 +99166,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#cancel-an-import parameters: - - *465 - *466 + - *467 responses: '204': description: Response - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96181,9 +99197,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-commit-authors parameters: - - *465 - *466 - - &825 + - *467 + - &826 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -96197,7 +99213,7 @@ paths: application/json: schema: type: array - items: &648 + items: &649 title: Porter Author description: Porter Author type: object @@ -96251,7 +99267,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96276,8 +99292,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#map-a-commit-author parameters: - - *465 - *466 + - *467 - name: author_id in: path required: true @@ -96307,7 +99323,7 @@ paths: description: Response content: application/json: - schema: *648 + schema: *649 examples: default: value: @@ -96320,7 +99336,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96344,8 +99360,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-large-files parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -96386,7 +99402,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96414,8 +99430,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -96442,11 +99458,11 @@ paths: description: Response content: application/json: - schema: *646 + schema: *647 examples: - default: *649 + default: *650 '422': *15 - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96469,8 +99485,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -96479,7 +99495,7 @@ paths: schema: *20 examples: default: *370 - '301': *471 + '301': *472 '404': *6 x-github: githubCloudOnly: false @@ -96499,8 +99515,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -96513,7 +99529,7 @@ paths: properties: {} additionalProperties: false examples: - default: &651 + default: &652 value: limit: collaborators_only origin: repository @@ -96538,13 +99554,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: application/json: - schema: *650 + schema: *651 examples: default: summary: Example request body @@ -96558,7 +99574,7 @@ paths: application/json: schema: *372 examples: - default: *651 + default: *652 '409': description: Response x-github: @@ -96580,8 +99596,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -96604,8 +99620,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#list-repository-invitations parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -96615,9 +99631,9 @@ paths: application/json: schema: type: array - items: *652 + items: *653 examples: - default: &818 + default: &819 value: - id: 1 repository: @@ -96748,8 +99764,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *465 - *466 + - *467 - *376 requestBody: required: false @@ -96779,7 +99795,7 @@ paths: description: Response content: application/json: - schema: *652 + schema: *653 examples: default: value: @@ -96910,8 +99926,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *465 - *466 + - *467 - *376 responses: '204': @@ -96943,8 +99959,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-repository-issues parameters: - - *465 - *466 + - *467 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -97017,7 +100033,7 @@ paths: type: array items: *219 examples: - default: &661 + default: &662 value: - id: 1 node_id: MDU6SXNzdWUx @@ -97166,7 +100182,7 @@ paths: state_reason: completed headers: Link: *45 - '301': *471 + '301': *472 '422': *15 '404': *6 x-github: @@ -97195,8 +100211,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#create-an-issue parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -97288,7 +100304,7 @@ paths: application/json: schema: *219 examples: - default: &658 + default: &659 value: id: 1 node_id: MDU6SXNzdWUx @@ -97445,7 +100461,7 @@ paths: '422': *15 '503': *192 '404': *6 - '410': *653 + '410': *654 x-github: triggersNotification: true githubCloudOnly: false @@ -97473,8 +100489,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *465 - *466 + - *467 - *241 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -97497,7 +100513,7 @@ paths: type: array items: *220 examples: - default: &660 + default: &661 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -97555,8 +100571,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 responses: '200': @@ -97565,7 +100581,7 @@ paths: application/json: schema: *220 examples: - default: &654 + default: &655 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -97620,8 +100636,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#update-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 requestBody: required: true @@ -97646,7 +100662,7 @@ paths: application/json: schema: *220 examples: - default: *654 + default: *655 '422': *15 x-github: githubCloudOnly: false @@ -97664,8 +100680,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#delete-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 responses: '204': @@ -97694,8 +100710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#pin-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 responses: '200': @@ -97758,7 +100774,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *653 + '410': *654 '422': *15 x-github: githubCloudOnly: false @@ -97775,8 +100791,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#unpin-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 responses: '204': @@ -97784,7 +100800,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *653 + '410': *654 '503': *192 x-github: githubCloudOnly: false @@ -97802,8 +100818,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). @@ -97830,9 +100846,9 @@ paths: application/json: schema: type: array - items: *577 + items: *578 examples: - default: *655 + default: *656 headers: Link: *45 '404': *6 @@ -97853,8 +100869,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 requestBody: required: true @@ -97887,16 +100903,16 @@ paths: description: Reaction exists content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '201': description: Reaction created content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '422': *15 x-github: githubCloudOnly: false @@ -97918,10 +100934,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *465 - *466 + - *467 - *233 - - *656 + - *657 responses: '204': description: Response @@ -97941,8 +100957,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events-for-a-repository parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -97952,7 +100968,7 @@ paths: application/json: schema: type: array - items: &657 + items: &658 title: Issue Event description: Issue Event type: object @@ -98292,8 +101308,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#get-an-issue-event parameters: - - *465 - *466 + - *467 - name: event_id in: path required: true @@ -98304,7 +101320,7 @@ paths: description: Response content: application/json: - schema: *657 + schema: *658 examples: default: value: @@ -98497,7 +101513,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *653 + '410': *654 '403': *27 x-github: githubCloudOnly: false @@ -98531,9 +101547,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue parameters: - - *465 - *466 - - &659 + - *467 + - &660 name: issue_number description: The number that identifies the issue. in: path @@ -98549,7 +101565,7 @@ paths: examples: default: summary: Issue - value: *658 + value: *659 pinned_comment: summary: Issue with pinned comment value: @@ -98748,9 +101764,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 '304': *35 x-github: githubCloudOnly: false @@ -98775,9 +101791,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#update-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: false content: @@ -98918,13 +101934,13 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 '422': *15 '503': *192 '403': *27 - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98942,9 +101958,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: false content: @@ -98972,7 +101988,7 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98988,9 +102004,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: content: application/json: @@ -99017,7 +102033,7 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99039,9 +102055,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - name: assignee in: path required: true @@ -99081,9 +102097,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *224 - *17 - *19 @@ -99096,11 +102112,11 @@ paths: type: array items: *220 examples: - default: *660 + default: *661 headers: Link: *45 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99129,9 +102145,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#create-an-issue-comment parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -99155,14 +102171,14 @@ paths: application/json: schema: *220 examples: - default: *654 + default: *655 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *653 + '410': *654 '422': *15 '404': *6 x-github: @@ -99190,9 +102206,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -99204,12 +102220,12 @@ paths: type: array items: *219 examples: - default: *661 + default: *662 headers: Link: *45 - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99237,9 +102253,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -99263,15 +102279,15 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *471 + '301': *472 '403': *27 - '410': *653 + '410': *654 '422': *15 '404': *6 x-github: @@ -99302,9 +102318,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *465 - *466 - - *659 + - *467 + - *660 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -99318,13 +102334,13 @@ paths: application/json: schema: *219 examples: - default: *658 - '301': *471 + default: *659 + '301': *472 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *653 + '410': *654 x-github: triggersNotification: true githubCloudOnly: false @@ -99350,9 +102366,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -99364,12 +102380,12 @@ paths: type: array items: *219 examples: - default: *661 + default: *662 headers: Link: *45 - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99386,9 +102402,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -99402,7 +102418,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &665 + - &666 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -99451,7 +102467,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &666 + - &667 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -99579,7 +102595,7 @@ paths: - performed_via_github_app - assignee - assigner - - &667 + - &668 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -99625,7 +102641,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &668 + - &669 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -99671,7 +102687,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &669 + - &670 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -99720,7 +102736,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &670 + - &671 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -99762,7 +102778,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &671 + - &672 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -99804,7 +102820,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &672 + - &673 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -99860,7 +102876,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &673 + - &674 title: Locked Issue Event description: Locked Issue Event type: object @@ -99905,7 +102921,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &674 + - &675 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -99966,7 +102982,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &675 + - &676 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -100027,7 +103043,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &676 + - &677 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -100088,7 +103104,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &677 + - &678 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -100181,7 +103197,7 @@ paths: color: red headers: Link: *45 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100198,9 +103214,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -100210,9 +103226,9 @@ paths: application/json: schema: type: array - items: *662 + items: *663 examples: - default: &663 + default: &664 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -100236,9 +103252,9 @@ paths: value: '2025-12-25' headers: Link: *45 - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100267,9 +103283,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -100335,9 +103351,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *662 + items: *663 examples: - default: *663 + default: *664 '400': *14 '403': *27 '404': *6 @@ -100373,9 +103389,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -100442,9 +103458,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *662 + items: *663 examples: - default: *663 + default: *664 '400': *14 '403': *27 '404': *6 @@ -100475,9 +103491,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *379 responses: '204': @@ -100503,9 +103519,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -100517,7 +103533,7 @@ paths: type: array items: *218 examples: - default: &664 + default: &665 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -100535,9 +103551,9 @@ paths: default: false headers: Link: *45 - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100553,9 +103569,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#add-labels-to-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: false content: @@ -100600,10 +103616,10 @@ paths: type: array items: *218 examples: - default: *664 - '301': *471 + default: *665 + '301': *472 '404': *6 - '410': *653 + '410': *654 '422': *15 x-github: githubCloudOnly: false @@ -100620,9 +103636,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#set-labels-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: false content: @@ -100684,10 +103700,10 @@ paths: type: array items: *218 examples: - default: *664 - '301': *471 + default: *665 + '301': *472 '404': *6 - '410': *653 + '410': *654 '422': *15 x-github: githubCloudOnly: false @@ -100704,15 +103720,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 responses: '204': description: Response - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100731,9 +103747,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - name: name in: path required: true @@ -100757,9 +103773,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100779,9 +103795,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#lock-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: false content: @@ -100810,7 +103826,7 @@ paths: '204': description: Response '403': *27 - '410': *653 + '410': *654 '404': *6 '422': *15 x-github: @@ -100828,9 +103844,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#unlock-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 responses: '204': description: Response @@ -100860,9 +103876,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#get-parent-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 responses: '200': description: Response @@ -100870,10 +103886,10 @@ paths: application/json: schema: *219 examples: - default: *658 - '301': *471 + default: *659 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100890,9 +103906,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -100918,13 +103934,13 @@ paths: application/json: schema: type: array - items: *577 + items: *578 examples: - default: *655 + default: *656 headers: Link: *45 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100942,9 +103958,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -100976,16 +103992,16 @@ paths: description: Response content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '201': description: Response content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '422': *15 x-github: githubCloudOnly: false @@ -101007,10 +104023,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *465 - *466 - - *659 - - *656 + - *467 + - *660 + - *657 responses: '204': description: Response @@ -101039,9 +104055,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#remove-sub-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -101065,7 +104081,7 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -101098,9 +104114,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#list-sub-issues parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -101112,11 +104128,11 @@ paths: type: array items: *219 examples: - default: *661 + default: *662 headers: Link: *45 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101144,9 +104160,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#add-sub-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -101175,14 +104191,14 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *653 + '410': *654 '422': *15 '404': *6 x-github: @@ -101202,9 +104218,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -101237,7 +104253,7 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 '403': *27 '404': *6 '422': *7 @@ -101259,9 +104275,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -101276,7 +104292,6 @@ paths: description: Timeline Event type: object anyOf: - - *665 - *666 - *667 - *668 @@ -101289,6 +104304,7 @@ paths: - *675 - *676 - *677 + - *678 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -101345,7 +104361,7 @@ paths: pin: anyOf: - type: 'null' - - *678 + - *679 required: - event - actor @@ -101621,7 +104637,7 @@ paths: type: string comments: type: array - items: &699 + items: &700 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -101862,7 +104878,7 @@ paths: type: string comments: type: array - items: *576 + items: *577 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -102137,7 +105153,7 @@ paths: headers: Link: *45 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102154,8 +105170,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -102165,7 +105181,7 @@ paths: application/json: schema: type: array - items: &679 + items: &680 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -102233,8 +105249,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -102270,9 +105286,9 @@ paths: description: Response content: application/json: - schema: *679 + schema: *680 examples: - default: &680 + default: &681 value: id: 1 key: ssh-rsa AAA... @@ -102306,9 +105322,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *465 - *466 - - &681 + - *467 + - &682 name: key_id description: The unique identifier of the key. in: path @@ -102320,9 +105336,9 @@ paths: description: Response content: application/json: - schema: *679 + schema: *680 examples: - default: *680 + default: *681 '404': *6 x-github: githubCloudOnly: false @@ -102340,9 +105356,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *465 - *466 - - *681 + - *467 + - *682 responses: '204': description: Response @@ -102362,8 +105378,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-a-repository parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -102375,7 +105391,7 @@ paths: type: array items: *218 examples: - default: *664 + default: *665 headers: Link: *45 '404': *6 @@ -102396,8 +105412,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#create-a-label parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -102435,7 +105451,7 @@ paths: application/json: schema: *218 examples: - default: &682 + default: &683 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -102467,8 +105483,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#get-a-label parameters: - - *465 - *466 + - *467 - name: name in: path required: true @@ -102481,7 +105497,7 @@ paths: application/json: schema: *218 examples: - default: *682 + default: *683 '404': *6 x-github: githubCloudOnly: false @@ -102498,8 +105514,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#update-a-label parameters: - - *465 - *466 + - *467 - name: name in: path required: true @@ -102564,8 +105580,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#delete-a-label parameters: - - *465 - *466 + - *467 - name: name in: path required: true @@ -102591,8 +105607,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-languages parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -102628,8 +105644,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *465 - *466 + - *467 responses: '202': *37 '403': @@ -102657,8 +105673,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -102684,9 +105700,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *465 - *466 - - *551 + - *467 + - *552 responses: '200': description: Response @@ -102833,8 +105849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -102899,8 +105915,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#merge-a-branch parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -102934,9 +105950,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *579 + schema: *580 examples: - default: *683 + default: *684 '204': description: Response when already merged '404': @@ -102961,8 +105977,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#list-milestones parameters: - - *465 - *466 + - *467 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -103059,8 +106075,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#create-a-milestone parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -103102,7 +106118,7 @@ paths: application/json: schema: *414 examples: - default: &684 + default: &685 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -103161,9 +106177,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#get-a-milestone parameters: - - *465 - *466 - - &685 + - *467 + - &686 name: milestone_number description: The number that identifies the milestone. in: path @@ -103177,7 +106193,7 @@ paths: application/json: schema: *414 examples: - default: *684 + default: *685 '404': *6 x-github: githubCloudOnly: false @@ -103194,9 +106210,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#update-a-milestone parameters: - - *465 - *466 - - *685 + - *467 + - *686 requestBody: required: false content: @@ -103236,7 +106252,7 @@ paths: application/json: schema: *414 examples: - default: *684 + default: *685 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103252,9 +106268,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#delete-a-milestone parameters: - - *465 - *466 - - *685 + - *467 + - *686 responses: '204': description: Response @@ -103275,9 +106291,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *465 - *466 - - *685 + - *467 + - *686 - *17 - *19 responses: @@ -103289,7 +106305,7 @@ paths: type: array items: *218 examples: - default: *664 + default: *665 headers: Link: *45 x-github: @@ -103308,12 +106324,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *465 - *466 - - *686 + - *467 - *687 - - *224 - *688 + - *224 + - *689 - *17 - *19 responses: @@ -103325,7 +106341,7 @@ paths: type: array items: *244 examples: - default: *689 + default: *690 headers: Link: *45 x-github: @@ -103349,8 +106365,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *465 - *466 + - *467 requestBody: required: false content: @@ -103408,14 +106424,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-a-apiname-pages-site parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: &690 + schema: &691 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -103559,7 +106575,7 @@ paths: - custom_404 - public examples: - default: &691 + default: &692 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -103600,8 +106616,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-apiname-pages-site parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -103656,9 +106672,9 @@ paths: description: Response content: application/json: - schema: *690 + schema: *691 examples: - default: *691 + default: *692 '422': *15 '409': *119 x-github: @@ -103681,8 +106697,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -103790,8 +106806,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -103817,8 +106833,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#list-apiname-pages-builds parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -103828,7 +106844,7 @@ paths: application/json: schema: type: array - items: &692 + items: &693 title: Page Build description: Page Build type: object @@ -103920,8 +106936,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#request-a-apiname-pages-build parameters: - - *465 - *466 + - *467 responses: '201': description: Response @@ -103968,16 +106984,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-latest-pages-build parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *692 + schema: *693 examples: - default: &693 + default: &694 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -104025,8 +107041,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-apiname-pages-build parameters: - - *465 - *466 + - *467 - name: build_id in: path required: true @@ -104037,9 +107053,9 @@ paths: description: Response content: application/json: - schema: *692 + schema: *693 examples: - default: *693 + default: *694 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104059,8 +107075,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-github-pages-deployment parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -104168,9 +107184,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *465 - *466 - - &694 + - *467 + - &695 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -104228,9 +107244,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *465 - *466 - - *694 + - *467 + - *695 responses: '204': *126 '404': *6 @@ -104257,8 +107273,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -104553,8 +107569,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Private vulnerability reporting status @@ -104591,8 +107607,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': *126 '422': *14 @@ -104613,8 +107629,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': *126 '422': *14 @@ -104636,8 +107652,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -104647,7 +107663,7 @@ paths: type: array items: *152 examples: - default: *695 + default: *696 '403': *27 '404': *6 x-github: @@ -104669,8 +107685,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -104686,7 +107702,7 @@ paths: required: - properties examples: - default: *696 + default: *697 responses: '204': description: No Content when custom property values are successfully created @@ -104724,8 +107740,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests parameters: - - *465 - *466 + - *467 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -104785,9 +107801,9 @@ paths: application/json: schema: type: array - items: *583 + items: *584 examples: - default: *697 + default: *698 headers: Link: *45 '304': *35 @@ -104819,8 +107835,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#create-a-pull-request parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -104887,7 +107903,7 @@ paths: description: Response content: application/json: - schema: &701 + schema: &702 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -105121,7 +108137,7 @@ paths: - review_comment - self author_association: *216 - auto_merge: *698 + auto_merge: *699 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -105223,7 +108239,7 @@ paths: - merged_by - review_comments examples: - default: &702 + default: &703 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -105750,8 +108766,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *465 - *466 + - *467 - name: sort in: query required: false @@ -105780,9 +108796,9 @@ paths: application/json: schema: type: array - items: *699 + items: *700 examples: - default: &704 + default: &705 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -105859,17 +108875,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *465 - *466 + - *467 - *233 responses: '200': description: Response content: application/json: - schema: *699 + schema: *700 examples: - default: &700 + default: &701 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -105944,8 +108960,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *465 - *466 + - *467 - *233 requestBody: required: true @@ -105968,9 +108984,9 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: - default: *700 + default: *701 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105986,8 +109002,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *465 - *466 + - *467 - *233 responses: '204': @@ -106009,8 +109025,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *465 - *466 + - *467 - *233 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). @@ -106037,9 +109053,9 @@ paths: application/json: schema: type: array - items: *577 + items: *578 examples: - default: *655 + default: *656 headers: Link: *45 '404': *6 @@ -106060,8 +109076,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *465 - *466 + - *467 - *233 requestBody: required: true @@ -106094,16 +109110,16 @@ paths: description: Reaction exists content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '201': description: Reaction created content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '422': *15 x-github: githubCloudOnly: false @@ -106125,10 +109141,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *465 - *466 + - *467 - *233 - - *656 + - *657 responses: '204': description: Response @@ -106171,9 +109187,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request parameters: - - *465 - *466 - - &703 + - *467 + - &704 name: pull_number description: The number that identifies the pull request. in: path @@ -106186,9 +109202,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *701 + schema: *702 examples: - default: *702 + default: *703 '304': *35 '404': *6 '406': @@ -106223,9 +109239,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: false content: @@ -106267,9 +109283,9 @@ paths: description: Response content: application/json: - schema: *701 + schema: *702 examples: - default: *702 + default: *703 '422': *15 '403': *27 x-github: @@ -106291,9 +109307,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#archive-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 responses: '204': description: Response @@ -106318,9 +109334,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#unarchive-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 responses: '204': description: Response @@ -106346,9 +109362,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: true content: @@ -106411,7 +109427,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -106419,7 +109435,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '401': *23 '403': *27 '404': *6 @@ -106449,9 +109465,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 - *241 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -106472,9 +109488,9 @@ paths: application/json: schema: type: array - items: *699 + items: *700 examples: - default: *704 + default: *705 headers: Link: *45 x-github: @@ -106507,9 +109523,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: true content: @@ -106615,7 +109631,7 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: example-for-a-multi-line-comment: value: @@ -106703,9 +109719,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *465 - *466 - - *703 + - *467 + - *704 - *233 requestBody: required: true @@ -106728,7 +109744,7 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: default: value: @@ -106814,9 +109830,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 - *17 - *19 responses: @@ -106826,9 +109842,9 @@ paths: application/json: schema: type: array - items: *579 + items: *580 examples: - default: *705 + default: *706 headers: Link: *45 x-github: @@ -106858,9 +109874,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests-files parameters: - - *465 - *466 - - *703 + - *467 + - *704 - *17 - *19 responses: @@ -106870,7 +109886,7 @@ paths: application/json: schema: type: array - items: *590 + items: *591 examples: default: value: @@ -106908,9 +109924,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *465 - *466 - - *703 + - *467 + - *704 responses: '204': description: Response if pull request has been merged @@ -106933,9 +109949,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#merge-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: false content: @@ -107047,9 +110063,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 responses: '200': description: Response @@ -107124,9 +110140,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: false content: @@ -107163,7 +110179,7 @@ paths: description: Response content: application/json: - schema: *583 + schema: *584 examples: default: value: @@ -107699,9 +110715,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: true content: @@ -107735,7 +110751,7 @@ paths: description: Response content: application/json: - schema: *583 + schema: *584 examples: default: value: @@ -108240,9 +111256,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 - *17 - *19 responses: @@ -108252,7 +111268,7 @@ paths: application/json: schema: type: array - items: &706 + items: &707 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -108408,9 +111424,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: false content: @@ -108500,9 +111516,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: &708 + default: &709 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -108565,10 +111581,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *465 - *466 - - *703 - - &707 + - *467 + - *704 + - &708 name: review_id description: The unique identifier of the review. in: path @@ -108580,9 +111596,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: &709 + default: &710 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -108641,10 +111657,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *465 - *466 - - *703 - - *707 + - *467 + - *704 + - *708 requestBody: required: true content: @@ -108667,7 +111683,7 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: default: value: @@ -108729,18 +111745,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *465 - *466 - - *703 - - *707 + - *467 + - *704 + - *708 responses: '200': description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: *708 + default: *709 '422': *7 '404': *6 x-github: @@ -108767,10 +111783,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *465 - *466 - - *703 - - *707 + - *467 + - *704 + - *708 - *17 - *19 responses: @@ -109028,10 +112044,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *465 - *466 - - *703 - - *707 + - *467 + - *704 + - *708 requestBody: required: true content: @@ -109060,7 +112076,7 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: default: value: @@ -109123,10 +112139,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *465 - *466 - - *703 - - *707 + - *467 + - *704 + - *708 requestBody: required: true content: @@ -109161,9 +112177,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: *709 + default: *710 '404': *6 '422': *7 '403': *27 @@ -109185,9 +112201,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: false content: @@ -109251,8 +112267,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-a-repository-readme parameters: - - *465 - *466 + - *467 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -109265,9 +112281,9 @@ paths: description: Response content: application/json: - schema: *710 + schema: *711 examples: - default: &711 + default: &712 value: type: file encoding: base64 @@ -109309,8 +112325,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *465 - *466 + - *467 - name: dir description: The alternate path to look for a README file in: path @@ -109330,9 +112346,9 @@ paths: description: Response content: application/json: - schema: *710 + schema: *711 examples: - default: *711 + default: *712 '404': *6 '422': *15 x-github: @@ -109354,8 +112370,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#list-releases parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -109365,7 +112381,7 @@ paths: application/json: schema: type: array - items: *712 + items: *713 examples: default: value: @@ -109459,8 +112475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#create-a-release parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -109536,9 +112552,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: &716 + default: &717 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -109643,9 +112659,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#get-a-release-asset parameters: - - *465 - *466 - - &714 + - *467 + - &715 name: asset_id description: The unique identifier of the asset. in: path @@ -109657,9 +112673,9 @@ paths: description: Response content: application/json: - schema: *713 + schema: *714 examples: - default: &715 + default: &716 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -109694,7 +112710,7 @@ paths: type: User site_admin: false '404': *6 - '302': *594 + '302': *595 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109710,9 +112726,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#update-a-release-asset parameters: - - *465 - *466 - - *714 + - *467 + - *715 requestBody: required: false content: @@ -109741,9 +112757,9 @@ paths: description: Response content: application/json: - schema: *713 + schema: *714 examples: - default: *715 + default: *716 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109759,9 +112775,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#delete-a-release-asset parameters: - - *465 - *466 - - *714 + - *467 + - *715 responses: '204': description: Response @@ -109786,8 +112802,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -109873,16 +112889,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-the-latest-release parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: *716 + default: *717 '404': *6 x-github: githubCloudOnly: false @@ -109900,8 +112916,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release-by-tag-name parameters: - - *465 - *466 + - *467 - name: tag description: tag parameter in: path @@ -109914,9 +112930,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: *716 + default: *717 '404': *6 x-github: githubCloudOnly: false @@ -109938,9 +112954,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release parameters: - - *465 - *466 - - &717 + - *467 + - &718 name: release_id description: The unique identifier of the release. in: path @@ -109954,9 +112970,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *712 + schema: *713 examples: - default: *716 + default: *717 '401': description: Unauthorized x-github: @@ -109974,9 +112990,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#update-a-release parameters: - - *465 - *466 - - *717 + - *467 + - *718 requestBody: required: false content: @@ -110040,9 +113056,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: *716 + default: *717 '404': description: Not Found if the discussion category name is invalid content: @@ -110063,9 +113079,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#delete-a-release parameters: - - *465 - *466 - - *717 + - *467 + - *718 responses: '204': description: Response @@ -110086,9 +113102,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#list-release-assets parameters: - - *465 - *466 - - *717 + - *467 + - *718 - *17 - *19 responses: @@ -110098,7 +113114,7 @@ paths: application/json: schema: type: array - items: *713 + items: *714 examples: default: value: @@ -110180,9 +113196,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *465 - *466 - - *717 + - *467 + - *718 - name: name in: query required: true @@ -110208,7 +113224,7 @@ paths: description: Response for successful upload content: application/json: - schema: *713 + schema: *714 examples: response-for-successful-upload: value: @@ -110263,9 +113279,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *465 - *466 - - *717 + - *467 + - *718 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -110289,9 +113305,9 @@ paths: application/json: schema: type: array - items: *577 + items: *578 examples: - default: *655 + default: *656 headers: Link: *45 '404': *6 @@ -110312,9 +113328,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *465 - *466 - - *717 + - *467 + - *718 requestBody: required: true content: @@ -110344,16 +113360,16 @@ paths: description: Reaction exists content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '201': description: Reaction created content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '422': *15 x-github: githubCloudOnly: false @@ -110375,10 +113391,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-release-reaction parameters: - - *465 - *466 - - *717 - - *656 + - *467 + - *718 + - *657 responses: '204': description: Response @@ -110402,9 +113418,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-rules-for-a-branch parameters: - - *465 - *466 - - *518 + - *467 + - *519 - *17 - *19 responses: @@ -110421,7 +113437,7 @@ paths: oneOf: - allOf: - *166 - - &718 + - &719 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -110442,67 +113458,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *167 - - *718 + - *719 - allOf: - *168 - - *718 + - *719 - allOf: - *169 - - *718 + - *719 - allOf: + - *720 - *719 - - *718 - allOf: - *170 - - *718 + - *719 - allOf: - *171 - - *718 + - *719 - allOf: - *172 - - *718 + - *719 - allOf: - *173 - - *718 + - *719 - allOf: - *174 - - *718 + - *719 - allOf: - *175 - - *718 + - *719 - allOf: - *176 - - *718 + - *719 - allOf: - *177 - - *718 + - *719 - allOf: - *178 - - *718 + - *719 - allOf: - *179 - - *718 + - *719 - allOf: - *180 - - *718 + - *719 - allOf: - *181 - - *718 + - *719 - allOf: - *182 - - *718 + - *719 - allOf: - *183 - - *718 + - *719 - allOf: - *184 - - *718 + - *719 - allOf: - *185 - - *718 + - *719 - allOf: - *186 - - *718 + - *719 examples: default: value: @@ -110541,8 +113557,8 @@ paths: category: repos subcategory: rules parameters: - - *465 - *466 + - *467 - *17 - *19 - name: includes_parents @@ -110553,7 +113569,7 @@ paths: schema: type: boolean default: true - - *720 + - *721 responses: '200': description: Response @@ -110608,8 +113624,8 @@ paths: category: repos subcategory: rules parameters: - - *465 - *466 + - *467 requestBody: description: Request body required: true @@ -110638,7 +113654,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *721 + items: *722 required: - name - enforcement @@ -110671,7 +113687,7 @@ paths: application/json: schema: *187 examples: - default: &730 + default: &731 value: id: 42 name: super cool ruleset @@ -110719,12 +113735,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *465 - *466 - - *722 - - *105 + - *467 - *723 + - *105 - *724 + - *725 - *17 - *19 responses: @@ -110732,9 +113748,9 @@ paths: description: Response content: application/json: - schema: *725 + schema: *726 examples: - default: *726 + default: *727 '404': *6 '500': *38 x-github: @@ -110755,17 +113771,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *465 - *466 - - *727 + - *467 + - *728 responses: '200': description: Response content: application/json: - schema: *728 + schema: *729 examples: - default: *729 + default: *730 '404': *6 '500': *38 x-github: @@ -110793,8 +113809,8 @@ paths: category: repos subcategory: rules parameters: - - *465 - *466 + - *467 - name: ruleset_id description: The ID of the ruleset. in: path @@ -110816,7 +113832,7 @@ paths: application/json: schema: *187 examples: - default: *730 + default: *731 '404': *6 '500': *38 put: @@ -110834,8 +113850,8 @@ paths: category: repos subcategory: rules parameters: - - *465 - *466 + - *467 - name: ruleset_id description: The ID of the ruleset. in: path @@ -110869,7 +113885,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *721 + items: *722 examples: default: value: @@ -110899,7 +113915,7 @@ paths: application/json: schema: *187 examples: - default: *730 + default: *731 '404': *6 '422': *15 '500': *38 @@ -110918,8 +113934,8 @@ paths: category: repos subcategory: rules parameters: - - *465 - *466 + - *467 - name: ruleset_id description: The ID of the ruleset. in: path @@ -110942,8 +113958,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-history parameters: - - *465 - *466 + - *467 - *17 - *19 - name: ruleset_id @@ -110980,8 +113996,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-version parameters: - - *465 - *466 + - *467 - name: ruleset_id description: The ID of the ruleset. in: path @@ -111054,8 +114070,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *465 - *466 + - *467 - *433 - *434 - *435 @@ -111067,12 +114083,13 @@ paths: - *110 - *19 - *17 - - *731 - *732 + - *733 - *441 - *442 - *443 - *444 + - *445 responses: '200': description: Response @@ -111080,7 +114097,7 @@ paths: application/json: schema: type: array - items: &736 + items: &737 type: object properties: number: *127 @@ -111096,8 +114113,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *733 - resolution: *734 + state: *734 + resolution: *735 resolved_at: type: - string @@ -111203,7 +114220,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *735 + - *736 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -111362,16 +114379,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 - *444 responses: '200': description: Response content: application/json: - schema: *736 + schema: *737 examples: default: value: @@ -111425,9 +114442,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 requestBody: required: true content: @@ -111435,8 +114452,8 @@ paths: schema: type: object properties: - state: *733 - resolution: *734 + state: *734 + resolution: *735 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -111484,7 +114501,7 @@ paths: description: Response content: application/json: - schema: *736 + schema: *737 examples: default: value: @@ -111580,9 +114597,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 - *19 - *17 responses: @@ -111593,7 +114610,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &915 + items: &916 type: object properties: type: @@ -111620,7 +114637,6 @@ paths: - commit details: oneOf: - - *737 - *738 - *739 - *740 @@ -111633,6 +114649,7 @@ paths: - *747 - *748 - *749 + - *750 examples: default: value: @@ -111718,8 +114735,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -111727,14 +114744,14 @@ paths: schema: type: object properties: - reason: &751 + reason: &752 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *750 + placeholder_id: *751 required: - reason - placeholder_id @@ -111751,7 +114768,7 @@ paths: schema: type: object properties: - reason: *751 + reason: *752 expire_at: type: - string @@ -111798,8 +114815,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *465 - *466 + - *467 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -111814,7 +114831,7 @@ paths: properties: incremental_scans: type: array - items: &752 + items: &753 description: Information on a single scan performed by secret scanning on the repository type: object @@ -111842,15 +114859,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *752 + items: *753 backfill_scans: type: array - items: *752 + items: *753 custom_pattern_backfill_scans: type: array items: allOf: - - *752 + - *753 - type: object properties: pattern_name: @@ -111863,7 +114880,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *752 + items: *753 examples: default: value: @@ -111928,8 +114945,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *465 - *466 + - *467 - *110 - name: sort description: The property to sort the results by. @@ -111973,9 +114990,9 @@ paths: application/json: schema: type: array - items: *753 + items: *754 examples: - default: *754 + default: *755 '400': *14 '404': *6 x-github: @@ -111998,8 +115015,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -112079,7 +115096,7 @@ paths: login: type: string description: The username of the user credited. - type: *449 + type: *450 required: - login - type @@ -112169,9 +115186,9 @@ paths: description: Response content: application/json: - schema: *753 + schema: *754 examples: - default: &756 + default: &757 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -112404,8 +115421,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -112518,7 +115535,7 @@ paths: description: Response content: application/json: - schema: *753 + schema: *754 examples: default: value: @@ -112665,17 +115682,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *465 - *466 - - *755 + - *467 + - *756 responses: '200': description: Response content: application/json: - schema: *753 + schema: *754 examples: - default: *756 + default: *757 '403': *27 '404': *6 x-github: @@ -112699,9 +115716,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *465 - *466 - - *755 + - *467 + - *756 requestBody: required: true content: @@ -112781,7 +115798,7 @@ paths: login: type: string description: The username of the user credited. - type: *449 + type: *450 required: - login - type @@ -112872,10 +115889,10 @@ paths: description: Response content: application/json: - schema: *753 + schema: *754 examples: - default: *756 - add_credit: *756 + default: *757 + add_credit: *757 '403': *27 '404': *6 '422': @@ -112913,9 +115930,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *465 - *466 - - *755 + - *467 + - *756 responses: '202': *37 '400': *14 @@ -112942,17 +115959,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *465 - *466 - - *755 + - *467 + - *756 responses: '202': description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: *472 + default: *473 '400': *14 '422': *15 '403': *27 @@ -112978,8 +115995,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-stargazers parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -113075,8 +116092,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *465 - *466 + - *467 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -113085,7 +116102,7 @@ paths: application/json: schema: type: array - items: &757 + items: &758 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -113118,8 +116135,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -113197,8 +116214,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -113292,8 +116309,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *465 - *466 + - *467 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -113447,8 +116464,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *465 - *466 + - *467 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -113458,7 +116475,7 @@ paths: application/json: schema: type: array - items: *757 + items: *758 examples: default: value: @@ -113491,8 +116508,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#create-a-commit-status parameters: - - *465 - *466 + - *467 - name: sha in: path required: true @@ -113548,7 +116565,7 @@ paths: description: Response content: application/json: - schema: *758 + schema: *759 examples: default: value: @@ -113602,8 +116619,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#list-watchers parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -113635,14 +116652,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#get-a-repository-subscription parameters: - - *465 - *466 + - *467 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &759 + schema: &760 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -113715,8 +116732,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#set-a-repository-subscription parameters: - - *465 - *466 + - *467 requestBody: required: false content: @@ -113742,7 +116759,7 @@ paths: description: Response content: application/json: - schema: *759 + schema: *760 examples: default: value: @@ -113769,8 +116786,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#delete-a-repository-subscription parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -113790,8 +116807,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-tags parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -113873,8 +116890,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *465 - *466 + - *467 - name: ref in: path required: true @@ -113910,8 +116927,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-teams parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -113943,8 +116960,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-all-repository-topics parameters: - - *465 - *466 + - *467 - *19 - *17 responses: @@ -113952,7 +116969,7 @@ paths: description: Response content: application/json: - schema: &760 + schema: &761 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -113964,7 +116981,7 @@ paths: required: - names examples: - default: &761 + default: &762 value: names: - octocat @@ -113987,8 +117004,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#replace-all-repository-topics parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -114019,9 +117036,9 @@ paths: description: Response content: application/json: - schema: *760 + schema: *761 examples: - default: *761 + default: *762 '404': *6 '422': *7 x-github: @@ -114042,9 +117059,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-repository-clones parameters: - - *465 - *466 - - &762 + - *467 + - &763 name: per description: The time frame to display results for. in: query @@ -114075,7 +117092,7 @@ paths: - 128 clones: type: array - items: &763 + items: &764 title: Traffic type: object properties: @@ -114162,8 +117179,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-paths parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -114257,8 +117274,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-sources parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -114321,9 +117338,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-page-views parameters: - - *465 - *466 - - *762 + - *467 + - *763 responses: '200': description: Response @@ -114344,7 +117361,7 @@ paths: - 3782 views: type: array - items: *763 + items: *764 required: - uniques - count @@ -114421,8 +117438,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#transfer-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -114696,8 +117713,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -114720,8 +117737,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-vulnerability-alerts parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -114743,8 +117760,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-vulnerability-alerts parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -114770,8 +117787,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *465 - *466 + - *467 - name: ref in: path required: true @@ -114863,9 +117880,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: *472 + default: *473 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -115016,7 +118033,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &771 + - &772 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -115026,7 +118043,7 @@ paths: type: string examples: - members - - &776 + - &777 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -115038,7 +118055,7 @@ paths: format: int32 examples: - 1 - - &777 + - &778 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -115082,7 +118099,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &766 + items: &767 allOf: - type: object required: @@ -115164,7 +118181,7 @@ paths: - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 - meta: &778 + meta: &779 type: object description: The metadata associated with the creation/updates to the user. @@ -115229,30 +118246,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &767 + '400': &768 description: Bad request content: application/json: - schema: *764 + schema: *765 application/scim+json: - schema: *764 - '401': *765 - '403': &768 + schema: *765 + '401': *766 + '403': &769 description: Permission denied - '429': &769 + '429': &770 description: Too many requests content: application/json: - schema: *764 + schema: *765 application/scim+json: - schema: *764 - '500': &770 + schema: *765 + '500': &771 description: Internal server error content: application/json: - schema: *764 + schema: *765 application/scim+json: - schema: *764 + schema: *765 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -115276,7 +118293,7 @@ paths: required: true content: application/json: - schema: &774 + schema: &775 type: object required: - schemas @@ -115340,9 +118357,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *766 + schema: *767 examples: - group: &772 + group: &773 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -115361,13 +118378,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *767 - '401': *765 - '403': *768 - '409': &775 + '400': *768 + '401': *766 + '403': *769 + '409': &776 description: Duplicate record detected - '429': *769 - '500': *770 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -115384,7 +118401,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - - &773 + - &774 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -115393,22 +118410,22 @@ paths: type: string examples: - 7fce0092-d52e-4f76-b727-3955bd72c939 - - *771 + - *772 - *39 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *766 + schema: *767 examples: - default: *772 - '400': *767 - '401': *765 - '403': *768 + default: *773 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '429': *769 - '500': *770 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -115427,13 +118444,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - - *773 + - *774 - *39 requestBody: required: true content: application/json: - schema: *774 + schema: *775 examples: group: summary: Group @@ -115459,17 +118476,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *766 + schema: *767 examples: - group: *772 - groupWithMembers: *772 - '400': *767 - '401': *765 - '403': *768 + group: *773 + groupWithMembers: *773 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '409': *775 - '429': *769 - '500': *770 + '409': *776 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -115493,13 +118510,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - - *773 + - *774 - *39 requestBody: required: true content: application/json: - schema: &785 + schema: &786 type: object required: - Operations @@ -115559,17 +118576,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *766 + schema: *767 examples: - updateGroup: *772 - addMembers: *772 - '400': *767 - '401': *765 - '403': *768 + updateGroup: *773 + addMembers: *773 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '409': *775 - '429': *769 - '500': *770 + '409': *776 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -115585,17 +118602,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - - *773 + - *774 - *39 responses: '204': description: Group was deleted, no content - '400': *767 - '401': *765 - '403': *768 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '429': *769 - '500': *770 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -115629,8 +118646,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *776 - *777 + - *778 - *39 responses: '200': @@ -115664,7 +118681,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &780 + items: &781 allOf: - type: object required: @@ -115756,7 +118773,7 @@ paths: address. examples: - true - roles: &779 + roles: &780 type: array description: The roles assigned to the user. items: @@ -115815,7 +118832,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *778 + meta: *779 startIndex: type: integer description: A starting index for the returned page @@ -115854,11 +118871,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *767 - '401': *765 - '403': *768 - '429': *769 - '500': *770 + '400': *768 + '401': *766 + '403': *769 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -115882,7 +118899,7 @@ paths: required: true content: application/json: - schema: &783 + schema: &784 type: object required: - schemas @@ -115975,9 +118992,9 @@ paths: description: Whether this email address is the primary address. examples: - true - roles: *779 + roles: *780 examples: - user: &784 + user: &785 summary: User value: schemas: @@ -116024,9 +119041,9 @@ paths: description: User has been created content: application/scim+json: - schema: *780 + schema: *781 examples: - user: &781 + user: &782 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -116052,13 +119069,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 - enterpriseOwner: *781 - '400': *767 - '401': *765 - '403': *768 - '409': *775 - '429': *769 - '500': *770 + enterpriseOwner: *782 + '400': *768 + '401': *766 + '403': *769 + '409': *776 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -116075,7 +119092,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - - &782 + - &783 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -116088,15 +119105,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *780 + schema: *781 examples: - default: *781 - '400': *767 - '401': *765 - '403': *768 + default: *782 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '429': *769 - '500': *770 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -116147,30 +119164,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - - *782 + - *783 - *39 requestBody: required: true content: application/json: - schema: *783 + schema: *784 examples: - user: *784 + user: *785 responses: '200': description: User was updated content: application/scim+json: - schema: *780 + schema: *781 examples: - user: *781 - '400': *767 - '401': *765 - '403': *768 + user: *782 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '409': *775 - '429': *769 - '500': *770 + '409': *776 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -116211,13 +119228,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - - *782 + - *783 - *39 requestBody: required: true content: application/json: - schema: *785 + schema: *786 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -116257,18 +119274,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *780 - examples: - userMultiValuedProperties: *781 - userSingleValuedProperties: *781 - disableUser: *781 - '400': *767 - '401': *765 - '403': *768 + schema: *781 + examples: + userMultiValuedProperties: *782 + userSingleValuedProperties: *782 + disableUser: *782 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '409': *775 - '429': *769 - '500': *770 + '409': *776 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -116288,17 +119305,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - - *782 + - *783 - *39 responses: '204': description: User was deleted, no content - '400': *767 - '401': *765 - '403': *768 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '429': *769 - '500': *770 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -116389,7 +119406,7 @@ paths: - 1 Resources: type: array - items: &786 + items: &787 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -116636,22 +119653,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *35 - '404': &787 + '404': &788 description: Resource not found content: application/json: - schema: *764 + schema: *765 application/scim+json: - schema: *764 - '403': &788 + schema: *765 + '403': &789 description: Forbidden content: application/json: - schema: *764 + schema: *765 application/scim+json: - schema: *764 - '400': *767 - '429': *769 + schema: *765 + '400': *768 + '429': *770 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -116677,9 +119694,9 @@ paths: description: Response content: application/scim+json: - schema: *786 + schema: *787 examples: - default: &789 + default: &790 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -116702,17 +119719,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *35 - '404': *787 - '403': *788 - '500': *770 + '404': *788 + '403': *789 + '500': *771 '409': description: Conflict content: application/json: - schema: *764 + schema: *765 application/scim+json: - schema: *764 - '400': *767 + schema: *765 + '400': *768 requestBody: required: true content: @@ -116812,17 +119829,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *87 - - *782 + - *783 responses: '200': description: Response content: application/scim+json: - schema: *786 + schema: *787 examples: - default: *789 - '404': *787 - '403': *788 + default: *790 + '404': *788 + '403': *789 '304': *35 x-github: githubCloudOnly: true @@ -116846,18 +119863,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-a-provisioned-organization-membership parameters: - *87 - - *782 + - *783 responses: '200': description: Response content: application/scim+json: - schema: *786 + schema: *787 examples: - default: *789 + default: *790 '304': *35 - '404': *787 - '403': *788 + '404': *788 + '403': *789 requestBody: required: true content: @@ -116972,19 +119989,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *87 - - *782 + - *783 responses: '200': description: Response content: application/scim+json: - schema: *786 + schema: *787 examples: - default: *789 + default: *790 '304': *35 - '404': *787 - '403': *788 - '400': *767 + '404': *788 + '403': *789 + '400': *768 '429': description: Response content: @@ -117080,12 +120097,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *87 - - *782 + - *783 responses: '204': description: Response - '404': *787 - '403': *788 + '404': *788 + '403': *789 '304': *35 x-github: githubCloudOnly: true @@ -117222,7 +120239,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &790 + text_matches: &791 title: Search Result Text Matches type: array items: @@ -117386,7 +120403,7 @@ paths: enum: - author-date - committer-date - - &791 + - &792 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -117455,7 +120472,7 @@ paths: committer: anyOf: - type: 'null' - - *516 + - *517 comment_count: type: integer message: @@ -117474,7 +120491,7 @@ paths: url: type: string format: uri - verification: *640 + verification: *641 required: - author - committer @@ -117489,7 +120506,7 @@ paths: committer: anyOf: - type: 'null' - - *516 + - *517 parents: type: array items: @@ -117506,7 +120523,7 @@ paths: type: number node_id: type: string - text_matches: *790 + text_matches: *791 required: - sha - node_id @@ -117699,7 +120716,7 @@ paths: - interactions - created - updated - - *791 + - *792 - *17 - *19 - name: advanced_search @@ -117813,11 +120830,11 @@ paths: type: - string - 'null' - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: type: string state_reason: @@ -117845,7 +120862,7 @@ paths: - string - 'null' format: date-time - text_matches: *790 + text_matches: *791 pull_request: type: object properties: @@ -118111,7 +121128,7 @@ paths: enum: - created - updated - - *791 + - *792 - *17 - *19 responses: @@ -118156,7 +121173,7 @@ paths: - 'null' score: type: number - text_matches: *790 + text_matches: *791 required: - id - node_id @@ -118242,7 +121259,7 @@ paths: - forks - help-wanted-issues - updated - - *791 + - *792 - *17 - *19 responses: @@ -118488,7 +121505,7 @@ paths: - admin - pull - push - text_matches: *790 + text_matches: *791 temp_clone_token: type: string allow_merge_commit: @@ -118797,7 +121814,7 @@ paths: - string - 'null' format: uri - text_matches: *790 + text_matches: *791 related: type: - array @@ -118992,7 +122009,7 @@ paths: - followers - repositories - joined - - *791 + - *792 - *17 - *19 responses: @@ -119102,7 +122119,7 @@ paths: type: - boolean - 'null' - text_matches: *790 + text_matches: *791 blog: type: - string @@ -119184,7 +122201,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#get-a-team-legacy parameters: - - &794 + - &795 name: team_id description: The unique identifier of the team. in: path @@ -119196,9 +122213,9 @@ paths: description: Response content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 '404': *6 x-github: githubCloudOnly: false @@ -119225,7 +122242,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#update-a-team-legacy parameters: - - *794 + - *795 requestBody: required: true content: @@ -119289,16 +122306,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 '201': description: Response content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 '404': *6 '422': *15 '403': *27 @@ -119326,7 +122343,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#delete-a-team-legacy parameters: - - *794 + - *795 responses: '204': description: Response @@ -119355,7 +122372,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *794 + - *795 - *17 - *19 responses: @@ -119393,7 +122410,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-team-members-legacy parameters: - - *794 + - *795 - name: role description: Filters members returned by their role in the team. in: query @@ -119444,7 +122461,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-member-legacy parameters: - - *794 + - *795 - *140 responses: '204': @@ -119481,7 +122498,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-team-member-legacy parameters: - - *794 + - *795 - *140 responses: '204': @@ -119521,7 +122538,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-member-legacy parameters: - - *794 + - *795 - *140 responses: '204': @@ -119558,16 +122575,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *794 + - *795 - *140 responses: '200': description: Response content: application/json: - schema: *464 + schema: *465 examples: - response-if-user-is-a-team-maintainer: *795 + response-if-user-is-a-team-maintainer: *796 '404': *6 x-github: githubCloudOnly: false @@ -119600,7 +122617,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *794 + - *795 - *140 requestBody: required: false @@ -119626,9 +122643,9 @@ paths: description: Response content: application/json: - schema: *464 + schema: *465 examples: - response-if-users-membership-with-team-is-now-pending: *796 + response-if-users-membership-with-team-is-now-pending: *797 '403': description: Forbidden if team synchronization is set up '422': @@ -119662,7 +122679,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *794 + - *795 - *140 responses: '204': @@ -119690,7 +122707,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-team-repositories-legacy parameters: - - *794 + - *795 - *17 - *19 responses: @@ -119732,15 +122749,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *794 - - *465 + - *795 - *466 + - *467 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *797 + schema: *798 examples: alternative-response-with-extra-repository-information: value: @@ -119891,9 +122908,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *794 - - *465 + - *795 - *466 + - *467 requestBody: required: false content: @@ -119943,9 +122960,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *794 - - *465 + - *795 - *466 + - *467 responses: '204': description: Response @@ -119974,15 +122991,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - - *794 + - *795 responses: '200': description: Response content: application/json: - schema: *467 + schema: *468 examples: - default: *468 + default: *469 '403': *27 '404': *6 x-github: @@ -120009,7 +123026,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - - *794 + - *795 requestBody: required: true content: @@ -120070,7 +123087,7 @@ paths: description: Response content: application/json: - schema: *467 + schema: *468 examples: default: value: @@ -120101,7 +123118,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-child-teams-legacy parameters: - - *794 + - *795 - *17 - *19 responses: @@ -120113,7 +123130,7 @@ paths: type: array items: *307 examples: - response-if-child-teams-exist: *798 + response-if-child-teams-exist: *799 headers: Link: *45 '404': *6 @@ -120146,7 +123163,7 @@ paths: application/json: schema: oneOf: - - &800 + - &801 title: Private User description: Private User type: object @@ -120396,7 +123413,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *799 + - *800 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -120556,7 +123573,7 @@ paths: description: Response content: application/json: - schema: *800 + schema: *801 examples: default: value: @@ -120902,7 +123919,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -120910,7 +123927,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '401': *23 '403': *27 '404': *6 @@ -120954,7 +123971,7 @@ paths: type: integer secrets: type: array - items: &801 + items: &802 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -120996,7 +124013,7 @@ paths: - visibility - selected_repositories_url examples: - default: *570 + default: *571 headers: Link: *45 x-github: @@ -121074,7 +124091,7 @@ paths: description: Response content: application/json: - schema: *801 + schema: *802 examples: default: value: @@ -121372,7 +124389,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '304': *35 '500': *38 '401': *23 @@ -121430,7 +124447,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '401': *23 '403': *27 '404': *6 @@ -121487,7 +124504,7 @@ paths: description: Response content: application/json: - schema: &802 + schema: &803 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -121540,7 +124557,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &803 + default: &804 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -121585,9 +124602,9 @@ paths: description: Response content: application/json: - schema: *802 + schema: *803 examples: - default: *803 + default: *804 '404': *6 x-github: githubCloudOnly: false @@ -121624,9 +124641,9 @@ paths: type: integer machines: type: array - items: *569 + items: *570 examples: - default: *804 + default: *805 '304': *35 '500': *38 '401': *23 @@ -121711,11 +124728,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *470 + repository: *471 machine: anyOf: - type: 'null' - - *569 + - *570 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -122520,7 +125537,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '304': *35 '500': *38 '400': *14 @@ -122560,7 +125577,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '500': *38 '401': *23 '403': *27 @@ -122592,7 +125609,7 @@ paths: type: array items: *395 examples: - default: &815 + default: &816 value: - id: 197 name: hello_docker @@ -122693,7 +125710,7 @@ paths: application/json: schema: type: array - items: &805 + items: &806 title: Email description: Email type: object @@ -122763,9 +125780,9 @@ paths: application/json: schema: type: array - items: *805 + items: *806 examples: - default: &817 + default: &818 value: - email: octocat@github.com verified: true @@ -122842,7 +125859,7 @@ paths: application/json: schema: type: array - items: *805 + items: *806 examples: default: value: @@ -123100,7 +126117,7 @@ paths: application/json: schema: type: array - items: &806 + items: &807 title: GPG Key description: A unique encryption key type: object @@ -123245,7 +126262,7 @@ paths: - subkeys - revoked examples: - default: &834 + default: &835 value: - id: 3 name: Octocat's GPG Key @@ -123330,9 +126347,9 @@ paths: description: Response content: application/json: - schema: *806 + schema: *807 examples: - default: &807 + default: &808 value: id: 3 name: Octocat's GPG Key @@ -123389,7 +126406,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &808 + - &809 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -123401,9 +126418,9 @@ paths: description: Response content: application/json: - schema: *806 + schema: *807 examples: - default: *807 + default: *808 '404': *6 '304': *35 '403': *27 @@ -123426,7 +126443,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *808 + - *809 responses: '204': description: Response @@ -123734,7 +126751,7 @@ paths: required: true content: application/json: - schema: *650 + schema: *651 examples: default: value: @@ -123884,7 +126901,7 @@ paths: application/json: schema: type: array - items: &809 + items: &810 title: Key description: Key type: object @@ -123987,9 +127004,9 @@ paths: description: Response content: application/json: - schema: *809 + schema: *810 examples: - default: &810 + default: &811 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -124022,15 +127039,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *681 + - *682 responses: '200': description: Response content: application/json: - schema: *809 + schema: *810 examples: - default: *810 + default: *811 '404': *6 '304': *35 '403': *27 @@ -124053,7 +127070,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *681 + - *682 responses: '204': description: Response @@ -124086,7 +127103,7 @@ paths: application/json: schema: type: array - items: &811 + items: &812 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -124165,7 +127182,7 @@ paths: - account - plan examples: - default: &812 + default: &813 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -124227,9 +127244,9 @@ paths: application/json: schema: type: array - items: *811 + items: *812 examples: - default: *812 + default: *813 headers: Link: *45 '304': *35 @@ -125247,7 +128264,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#unlock-a-user-repository parameters: - *391 - - *813 + - *814 responses: '204': description: Response @@ -125362,7 +128379,7 @@ paths: - docker - nuget - container - - *814 + - *815 - *19 - *17 responses: @@ -125374,8 +128391,8 @@ paths: type: array items: *395 examples: - default: *815 - '400': *816 + default: *816 + '400': *817 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -125404,7 +128421,7 @@ paths: application/json: schema: *395 examples: - default: &835 + default: &836 value: id: 40201 name: octo-name @@ -125766,9 +128783,9 @@ paths: application/json: schema: type: array - items: *805 + items: *806 examples: - default: *817 + default: *818 headers: Link: *45 '304': *35 @@ -125881,7 +128898,7 @@ paths: type: array items: *78 examples: - default: &824 + default: &825 summary: Default response value: - id: 1296269 @@ -126199,9 +129216,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: *472 + default: *473 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -126239,9 +129256,9 @@ paths: application/json: schema: type: array - items: *652 + items: *653 examples: - default: *818 + default: *819 headers: Link: *45 '304': *35 @@ -126320,7 +129337,7 @@ paths: application/json: schema: type: array - items: &819 + items: &820 title: Social account description: Social media account type: object @@ -126337,7 +129354,7 @@ paths: - provider - url examples: - default: &820 + default: &821 value: - provider: twitter url: https://twitter.com/github @@ -126400,9 +129417,9 @@ paths: application/json: schema: type: array - items: *819 + items: *820 examples: - default: *820 + default: *821 '422': *15 '304': *35 '404': *6 @@ -126490,7 +129507,7 @@ paths: application/json: schema: type: array - items: &821 + items: &822 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -126510,7 +129527,7 @@ paths: - title - created_at examples: - default: &849 + default: &850 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -126575,9 +129592,9 @@ paths: description: Response content: application/json: - schema: *821 + schema: *822 examples: - default: &822 + default: &823 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -126607,7 +129624,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &823 + - &824 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -126619,9 +129636,9 @@ paths: description: Response content: application/json: - schema: *821 + schema: *822 examples: - default: *822 + default: *823 '404': *6 '304': *35 '403': *27 @@ -126644,7 +129661,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *823 + - *824 responses: '204': description: Response @@ -126673,7 +129690,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &850 + - &851 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -126698,11 +129715,11 @@ paths: type: array items: *78 examples: - default-response: *824 + default-response: *825 application/vnd.github.v3.star+json: schema: type: array - items: &851 + items: &852 title: Starred Repository description: Starred Repository type: object @@ -126858,8 +129875,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *465 - *466 + - *467 responses: '204': description: Response if this repository is starred by you @@ -126887,8 +129904,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -126912,8 +129929,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -126985,7 +130002,7 @@ paths: application/json: schema: type: array - items: *457 + items: *458 examples: default: value: @@ -127071,10 +130088,10 @@ paths: application/json: schema: oneOf: + - *801 - *800 - - *799 examples: - default-response: &828 + default-response: &829 summary: Default response value: login: octocat @@ -127109,7 +130126,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &829 + response-with-git-hub-plan-information: &830 summary: Response with GitHub plan information value: login: octocat @@ -127166,7 +130183,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &826 + - &827 name: user_id description: The unique identifier of the user. in: path @@ -127232,7 +130249,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/users#list-users parameters: - - *825 + - *826 - *17 responses: '200': @@ -127267,7 +130284,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *826 + - *827 - *413 requestBody: required: true @@ -127342,7 +130359,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *827 + schema: *828 examples: table_view: summary: Response for creating a table view @@ -127394,11 +130411,11 @@ paths: application/json: schema: oneOf: + - *801 - *800 - - *799 examples: - default-response: *828 - response-with-git-hub-plan-information: *829 + default-response: *829 + response-with-git-hub-plan-information: *830 '404': *6 x-github: githubCloudOnly: false @@ -127448,8 +130465,8 @@ paths: required: - subject_digests examples: - default: *830 - withPredicateType: *831 + default: *831 + withPredicateType: *832 responses: '200': description: Response @@ -127503,7 +130520,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *832 + default: *833 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -127708,7 +130725,7 @@ paths: initiator: type: string examples: - default: *512 + default: *513 '201': description: Response content: @@ -127992,7 +131009,7 @@ paths: application/json: schema: *322 examples: - default: &833 + default: &834 summary: Example response for a user copilot space value: id: 42 @@ -128093,7 +131110,7 @@ paths: application/json: schema: *322 examples: - default: *833 + default: *834 '403': *27 '404': *6 x-github: @@ -128219,7 +131236,7 @@ paths: application/json: schema: *322 examples: - default: *833 + default: *834 '403': *27 '404': *6 '422': *15 @@ -128987,7 +132004,7 @@ paths: type: array items: *395 examples: - default: *815 + default: *816 '403': *27 '401': *23 x-github: @@ -129371,9 +132388,9 @@ paths: application/json: schema: type: array - items: *806 + items: *807 examples: - default: *834 + default: *835 headers: Link: *45 x-github: @@ -129602,7 +132619,7 @@ paths: - docker - nuget - container - - *814 + - *815 - *140 - *19 - *17 @@ -129615,10 +132632,10 @@ paths: type: array items: *395 examples: - default: *815 + default: *816 '403': *27 '401': *23 - '400': *816 + '400': *817 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -129648,7 +132665,7 @@ paths: application/json: schema: *395 examples: - default: *835 + default: *836 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -129997,7 +133014,7 @@ paths: type: array items: *416 examples: - default: *836 + default: *837 headers: Link: *45 '304': *35 @@ -130057,7 +133074,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *837 + items: *838 required: - name - data_type @@ -130073,7 +133090,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *838 + iteration_configuration: *839 required: - name - data_type @@ -130095,8 +133112,8 @@ paths: value: name: Due date data_type: date - single_select_field: *839 - iteration_field: *840 + single_select_field: *840 + iteration_field: *841 responses: '201': description: Response @@ -130104,11 +133121,11 @@ paths: application/json: schema: *416 examples: - text_field: *841 - number_field: *842 - date_field: *843 - single_select_field: *844 - iteration_field: *845 + text_field: *842 + number_field: *843 + date_field: *844 + single_select_field: *845 + iteration_field: *846 '304': *35 '403': *27 '401': *23 @@ -130130,7 +133147,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-user parameters: - *413 - - *846 + - *847 - *140 responses: '200': @@ -130139,7 +133156,7 @@ paths: application/json: schema: *416 examples: - default: *847 + default: *848 headers: Link: *45 '304': *35 @@ -130496,7 +133513,7 @@ paths: parameters: - *413 - *140 - - *848 + - *849 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -130775,9 +133792,9 @@ paths: application/json: schema: type: array - items: *819 + items: *820 examples: - default: *820 + default: *821 headers: Link: *45 x-github: @@ -130807,9 +133824,9 @@ paths: application/json: schema: type: array - items: *821 + items: *822 examples: - default: *849 + default: *850 headers: Link: *45 x-github: @@ -130834,7 +133851,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *140 - - *850 + - *851 - *110 - *17 - *19 @@ -130846,11 +133863,11 @@ paths: schema: anyOf: - type: array - items: *851 + items: *852 - type: array items: *78 examples: - default-response: *824 + default-response: *825 headers: Link: *45 x-github: @@ -131010,7 +134027,7 @@ webhooks: type: string enum: - disabled - enterprise: &852 + enterprise: &853 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -131079,7 +134096,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &853 + installation: &854 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -131100,7 +134117,7 @@ webhooks: required: - id - node_id - organization: &854 + organization: &855 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -131173,7 +134190,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &855 + repository: &856 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -132099,10 +135116,10 @@ webhooks: type: string enum: - enabled - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -132178,11 +135195,11 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - rule: &856 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + rule: &857 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -132405,11 +135422,11 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - rule: *856 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + rule: *857 sender: *4 required: - action @@ -132597,11 +135614,11 @@ webhooks: - everyone required: - from - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - rule: *856 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + rule: *857 sender: *4 required: - action @@ -132674,7 +135691,7 @@ webhooks: required: true content: application/json: - schema: &876 + schema: &877 title: Exemption request cancellation event type: object properties: @@ -132682,11 +135699,11 @@ webhooks: type: string enum: - cancelled - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - exemption_request: &857 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + exemption_request: &858 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -132995,7 +136012,7 @@ webhooks: - array - 'null' description: The responses to the exemption request. - items: &858 + items: &859 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -133107,7 +136124,7 @@ webhooks: required: true content: application/json: - schema: &877 + schema: &878 title: Exemption request completed event type: object properties: @@ -133115,11 +136132,11 @@ webhooks: type: string enum: - completed - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - exemption_request: *857 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + exemption_request: *858 sender: *4 required: - action @@ -133191,7 +136208,7 @@ webhooks: required: true content: application/json: - schema: &874 + schema: &875 title: Exemption request created event type: object properties: @@ -133199,11 +136216,11 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - exemption_request: *857 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + exemption_request: *858 sender: *4 required: - action @@ -133275,7 +136292,7 @@ webhooks: required: true content: application/json: - schema: &878 + schema: &879 title: Exemption response dismissed event type: object properties: @@ -133283,12 +136300,12 @@ webhooks: type: string enum: - response_dismissed - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - exemption_request: *857 - exemption_response: *858 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + exemption_request: *858 + exemption_response: *859 sender: *4 required: - action @@ -133362,7 +136379,7 @@ webhooks: required: true content: application/json: - schema: &875 + schema: &876 title: Exemption response submitted event type: object properties: @@ -133370,12 +136387,12 @@ webhooks: type: string enum: - response_submitted - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - exemption_request: *857 - exemption_response: *858 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + exemption_request: *858 + exemption_response: *859 sender: *4 required: - action @@ -133459,7 +136476,7 @@ webhooks: type: string enum: - completed - check_run: &860 + check_run: &861 title: CheckRun description: A check performed on the code of a given code change type: object @@ -133569,7 +136586,7 @@ webhooks: - examples: - neutral - deployment: *859 + deployment: *860 details_url: type: string examples: @@ -133667,10 +136684,10 @@ webhooks: - output - app - pull_requests - installation: *853 - enterprise: *852 - organization: *854 - repository: *855 + installation: *854 + enterprise: *853 + organization: *855 + repository: *856 sender: *4 required: - check_run @@ -134061,11 +137078,11 @@ webhooks: type: string enum: - created - check_run: *860 - installation: *853 - enterprise: *852 - organization: *854 - repository: *855 + check_run: *861 + installation: *854 + enterprise: *853 + organization: *855 + repository: *856 sender: *4 required: - check_run @@ -134459,11 +137476,11 @@ webhooks: type: string enum: - requested_action - check_run: *860 - installation: *853 - enterprise: *852 - organization: *854 - repository: *855 + check_run: *861 + installation: *854 + enterprise: *853 + organization: *855 + repository: *856 requested_action: description: The action requested by the user. type: object @@ -134866,11 +137883,11 @@ webhooks: type: string enum: - rerequested - check_run: *860 - installation: *853 - enterprise: *852 - organization: *854 - repository: *855 + check_run: *861 + installation: *854 + enterprise: *853 + organization: *855 + repository: *856 sender: *4 required: - check_run @@ -135855,10 +138872,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -136562,10 +139579,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -137263,10 +140280,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -137435,7 +140452,7 @@ webhooks: required: - login - id - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -137587,20 +140604,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &861 + commit_oid: &862 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *852 - installation: *853 - organization: *854 - ref: &862 + enterprise: *853 + installation: *854 + organization: *855 + ref: &863 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *855 + repository: *856 sender: *4 required: - action @@ -137767,7 +140784,7 @@ webhooks: required: - login - id - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -138008,12 +141025,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *861 - enterprise: *852 - installation: *853 - organization: *854 - ref: *862 - repository: *855 + commit_oid: *862 + enterprise: *853 + installation: *854 + organization: *855 + ref: *863 + repository: *856 sender: *4 required: - action @@ -138111,7 +141128,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -138296,12 +141313,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *861 - enterprise: *852 - installation: *853 - organization: *854 - ref: *862 - repository: *855 + commit_oid: *862 + enterprise: *853 + installation: *854 + organization: *855 + ref: *863 + repository: *856 sender: *4 required: - action @@ -138470,7 +141487,7 @@ webhooks: required: - login - id - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -138647,12 +141664,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *861 - enterprise: *852 - installation: *853 - organization: *854 - ref: *862 - repository: *855 + commit_oid: *862 + enterprise: *853 + installation: *854 + organization: *855 + ref: *863 + repository: *856 sender: *4 required: - action @@ -138753,7 +141770,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -138942,9 +141959,9 @@ webhooks: type: - string - 'null' - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -138952,7 +141969,7 @@ webhooks: type: - string - 'null' - repository: *855 + repository: *856 sender: *4 required: - action @@ -139051,7 +142068,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -139198,12 +142215,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *861 - enterprise: *852 - installation: *853 - organization: *854 - ref: *862 - repository: *855 + commit_oid: *862 + enterprise: *853 + installation: *854 + organization: *855 + ref: *863 + repository: *856 sender: *4 required: - action @@ -139372,7 +142389,7 @@ webhooks: required: - login - id - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -139524,10 +142541,10 @@ webhooks: - dismissed_reason - rule - tool - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -139787,10 +142804,10 @@ webhooks: - updated_at - author_association - body - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -139871,18 +142888,18 @@ webhooks: type: - string - 'null' - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *854 - pusher_type: &863 + organization: *855 + pusher_type: &864 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &864 + ref: &865 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference) resource. type: string @@ -139892,7 +142909,7 @@ webhooks: enum: - tag - branch - repository: *855 + repository: *856 sender: *4 required: - ref @@ -139975,9 +142992,9 @@ webhooks: enum: - created definition: *153 - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 sender: *4 required: - action @@ -140062,9 +143079,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 sender: *4 required: - action @@ -140142,9 +143159,9 @@ webhooks: enum: - promote_to_enterprise definition: *153 - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 sender: *4 required: - action @@ -140222,9 +143239,9 @@ webhooks: enum: - updated definition: *153 - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 sender: *4 required: - action @@ -140301,10 +143318,10 @@ webhooks: type: string enum: - updated - enterprise: *852 - installation: *853 - repository: *855 - organization: *854 + enterprise: *853 + installation: *854 + repository: *856 + organization: *855 sender: *4 new_property_values: type: array @@ -140389,18 +143406,18 @@ webhooks: title: delete event type: object properties: - enterprise: *852 - installation: *853 - organization: *854 - pusher_type: *863 - ref: *864 + enterprise: *853 + installation: *854 + organization: *855 + pusher_type: *864 + ref: *865 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *855 + repository: *856 sender: *4 required: - ref @@ -140480,11 +143497,11 @@ webhooks: type: string enum: - assignees_changed - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -140564,11 +143581,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -140649,11 +143666,11 @@ webhooks: type: string enum: - auto_reopened - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -140734,11 +143751,11 @@ webhooks: type: string enum: - created - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -140817,11 +143834,11 @@ webhooks: type: string enum: - dismissed - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -140900,11 +143917,11 @@ webhooks: type: string enum: - fixed - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -140984,11 +144001,11 @@ webhooks: type: string enum: - reintroduced - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -141067,11 +144084,11 @@ webhooks: type: string enum: - reopened - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -141148,9 +144165,9 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - key: &865 + enterprise: *853 + installation: *854 + key: &866 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -141188,8 +144205,8 @@ webhooks: - verified - created_at - read_only - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -141266,11 +144283,11 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - key: *865 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + key: *866 + organization: *855 + repository: *856 sender: *4 required: - action @@ -141837,12 +144854,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - workflow: &869 + workflow: &870 title: Workflow type: - object @@ -142593,13 +145610,13 @@ webhooks: deployment: anyOf: - type: 'null' - - *607 + - *608 pull_requests: type: array - items: *701 - repository: *855 - organization: *854 - installation: *853 + items: *702 + repository: *856 + organization: *855 + installation: *854 sender: *4 responses: '200': @@ -142670,7 +145687,7 @@ webhooks: type: string enum: - approved - approver: &866 + approver: &867 type: object properties: avatar_url: @@ -142713,11 +145730,11 @@ webhooks: type: string comment: type: string - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - reviewers: &867 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + reviewers: &868 type: array items: type: object @@ -142798,7 +145815,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &868 + workflow_job_run: &869 type: object properties: conclusion: @@ -143544,18 +146561,18 @@ webhooks: type: string enum: - rejected - approver: *866 + approver: *867 comment: type: string - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - reviewers: *867 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + reviewers: *868 sender: *4 since: type: string - workflow_job_run: *868 + workflow_job_run: *869 workflow_job_runs: type: array items: @@ -144272,13 +147289,13 @@ webhooks: type: string enum: - requested - enterprise: *852 + enterprise: *853 environment: type: string - installation: *853 - organization: *854 - repository: *855 - requestor: &879 + installation: *854 + organization: *855 + repository: *856 + requestor: &880 title: User type: - object @@ -146211,12 +149228,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - workflow: *869 + workflow: *870 workflow_run: title: Deployment Workflow Run type: @@ -146907,7 +149924,7 @@ webhooks: type: string enum: - answered - answer: &872 + answer: &873 type: object properties: author_association: @@ -147067,11 +150084,11 @@ webhooks: - created_at - updated_at - body - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -147198,11 +150215,11 @@ webhooks: - from required: - category - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -147285,11 +150302,11 @@ webhooks: type: string enum: - closed - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -147371,7 +150388,7 @@ webhooks: type: string enum: - created - comment: &871 + comment: &872 type: object properties: author_association: @@ -147531,11 +150548,11 @@ webhooks: - updated_at - body - reactions - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -147618,12 +150635,12 @@ webhooks: type: string enum: - deleted - comment: *871 - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + comment: *872 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -147718,12 +150735,12 @@ webhooks: - from required: - body - comment: *871 - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + comment: *872 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -147807,11 +150824,11 @@ webhooks: type: string enum: - created - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -147893,11 +150910,11 @@ webhooks: type: string enum: - deleted - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -147997,11 +151014,11 @@ webhooks: type: string required: - from - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148083,10 +151100,10 @@ webhooks: type: string enum: - labeled - discussion: *870 - enterprise: *852 - installation: *853 - label: &873 + discussion: *871 + enterprise: *853 + installation: *854 + label: &874 title: Label type: object properties: @@ -148119,8 +151136,8 @@ webhooks: - color - default - description - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148203,11 +151220,11 @@ webhooks: type: string enum: - locked - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148289,11 +151306,11 @@ webhooks: type: string enum: - pinned - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148375,11 +151392,11 @@ webhooks: type: string enum: - reopened - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148464,16 +151481,16 @@ webhooks: changes: type: object properties: - new_discussion: *870 - new_repository: *855 + new_discussion: *871 + new_repository: *856 required: - new_discussion - new_repository - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148556,10 +151573,10 @@ webhooks: type: string enum: - unanswered - discussion: *870 - old_answer: *872 - organization: *854 - repository: *855 + discussion: *871 + old_answer: *873 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148641,12 +151658,12 @@ webhooks: type: string enum: - unlabeled - discussion: *870 - enterprise: *852 - installation: *853 - label: *873 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148729,11 +151746,11 @@ webhooks: type: string enum: - unlocked - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148815,11 +151832,11 @@ webhooks: type: string enum: - unpinned - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148888,7 +151905,7 @@ webhooks: required: true content: application/json: - schema: *874 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -148951,7 +151968,7 @@ webhooks: required: true content: application/json: - schema: *875 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149014,7 +152031,7 @@ webhooks: required: true content: application/json: - schema: *876 + schema: *877 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149077,7 +152094,7 @@ webhooks: required: true content: application/json: - schema: *874 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149140,7 +152157,7 @@ webhooks: required: true content: application/json: - schema: *875 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149206,7 +152223,7 @@ webhooks: required: true content: application/json: - schema: *876 + schema: *877 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149272,7 +152289,7 @@ webhooks: required: true content: application/json: - schema: *877 + schema: *878 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149338,7 +152355,7 @@ webhooks: required: true content: application/json: - schema: *874 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149404,7 +152421,7 @@ webhooks: required: true content: application/json: - schema: *878 + schema: *879 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149470,7 +152487,7 @@ webhooks: required: true content: application/json: - schema: *875 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149535,7 +152552,7 @@ webhooks: required: true content: application/json: - schema: *876 + schema: *877 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149600,7 +152617,7 @@ webhooks: required: true content: application/json: - schema: *877 + schema: *878 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149665,7 +152682,7 @@ webhooks: required: true content: application/json: - schema: *874 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149730,7 +152747,7 @@ webhooks: required: true content: application/json: - schema: *878 + schema: *879 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149796,7 +152813,7 @@ webhooks: required: true content: application/json: - schema: *875 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149863,7 +152880,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *852 + enterprise: *853 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) resource. @@ -150541,9 +153558,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - forkee @@ -150689,9 +153706,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pages: description: The pages that were updated. type: array @@ -150729,7 +153746,7 @@ webhooks: - action - sha - html_url - repository: *855 + repository: *856 sender: *4 required: - pages @@ -150805,10 +153822,10 @@ webhooks: type: string enum: - created - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories: &880 + organization: *855 + repositories: &881 description: An array of repository objects that the installation can access. type: array @@ -150834,8 +153851,8 @@ webhooks: - name - full_name - private - repository: *855 - requester: *879 + repository: *856 + requester: *880 sender: *4 required: - action @@ -150910,11 +153927,11 @@ webhooks: type: string enum: - deleted - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories: *880 - repository: *855 + organization: *855 + repositories: *881 + repository: *856 requester: type: - 'null' @@ -150991,11 +154008,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories: *880 - repository: *855 + organization: *855 + repositories: *881 + repository: *856 requester: type: - 'null' @@ -151072,10 +154089,10 @@ webhooks: type: string enum: - added - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories_added: &881 + organization: *855 + repositories_added: &882 description: An array of repository objects, which were added to the installation. type: array @@ -151121,15 +154138,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *855 - repository_selection: &882 + repository: *856 + repository_selection: &883 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *879 + requester: *880 sender: *4 required: - action @@ -151208,10 +154225,10 @@ webhooks: type: string enum: - removed - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories_added: *881 + organization: *855 + repositories_added: *882 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -151238,9 +154255,9 @@ webhooks: - name - full_name - private - repository: *855 - repository_selection: *882 - requester: *879 + repository: *856 + repository_selection: *883 + requester: *880 sender: *4 required: - action @@ -151319,11 +154336,11 @@ webhooks: type: string enum: - suspend - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories: *880 - repository: *855 + organization: *855 + repositories: *881 + repository: *856 requester: type: - 'null' @@ -151506,10 +154523,10 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 target_type: type: string @@ -151588,11 +154605,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories: *880 - repository: *855 + organization: *855 + repositories: *881 + repository: *856 requester: type: - 'null' @@ -151758,7 +154775,7 @@ webhooks: pin: anyOf: - type: 'null' - - *678 + - *679 user: title: User type: @@ -151844,8 +154861,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -152657,8 +155674,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153019,8 +156036,8 @@ webhooks: - state - locked - assignee - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -153100,7 +156117,7 @@ webhooks: type: string enum: - deleted - comment: &883 + comment: &884 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself. @@ -153257,7 +156274,7 @@ webhooks: pin: anyOf: - type: 'null' - - *678 + - *679 required: - url - html_url @@ -153271,8 +156288,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -154080,8 +157097,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154444,8 +157461,8 @@ webhooks: - state - locked - assignee - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -154525,7 +157542,7 @@ webhooks: type: string enum: - edited - changes: &907 + changes: &908 description: The changes to the comment. type: object properties: @@ -154537,9 +157554,9 @@ webhooks: type: string required: - from - comment: *883 - enterprise: *852 - installation: *853 + comment: *884 + enterprise: *853 + installation: *854 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -155350,8 +158367,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155712,8 +158729,8 @@ webhooks: - state - locked - assignee - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -155794,9 +158811,9 @@ webhooks: type: string enum: - pinned - comment: *883 - enterprise: *852 - installation: *853 + comment: *884 + enterprise: *853 + installation: *854 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -156609,8 +159626,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156973,8 +159990,8 @@ webhooks: - state - locked - assignee - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -157054,9 +160071,9 @@ webhooks: type: string enum: - unpinned - comment: *883 - enterprise: *852 - installation: *853 + comment: *884 + enterprise: *853 + installation: *854 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -157869,8 +160886,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 state: description: State of the issue; either 'open' or 'closed' type: string @@ -158233,8 +161250,8 @@ webhooks: - state - locked - assignee - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -158323,9 +161340,9 @@ webhooks: type: number blocking_issue: *219 blocking_issue_repo: *78 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -158414,9 +161431,9 @@ webhooks: type: number blocking_issue: *219 blocking_issue_repo: *78 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -158504,9 +161521,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *219 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -158595,9 +161612,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *219 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -158677,10 +161694,10 @@ webhooks: type: string enum: - assigned - assignee: *879 - enterprise: *852 - installation: *853 - issue: &884 + assignee: *880 + enterprise: *853 + installation: *854 + issue: &885 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. @@ -159491,11 +162508,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159615,8 +162632,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -159696,8 +162713,8 @@ webhooks: type: string enum: - closed - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. @@ -160513,11 +163530,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160780,8 +163797,8 @@ webhooks: required: - state - closed_at - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -160860,8 +163877,8 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -161668,11 +164685,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -161791,8 +164808,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -161871,8 +164888,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -162702,11 +165719,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -162804,7 +165821,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &885 + milestone: &886 title: Milestone description: A collection of related issues and pull requests. type: object @@ -162947,8 +165964,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -163047,8 +166064,8 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -163859,11 +166876,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -163983,9 +167000,9 @@ webhooks: - active_lock_reason - body - reactions - label: *873 - organization: *854 - repository: *855 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -164065,9 +167082,9 @@ webhooks: type: string enum: - field_added - enterprise: *852 - installation: *853 - issue: *884 + enterprise: *853 + installation: *854 + issue: *885 issue_field: type: object description: The issue field whose value was set or updated on the @@ -164186,8 +167203,8 @@ webhooks: - id required: - from - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -164267,9 +167284,9 @@ webhooks: type: string enum: - field_removed - enterprise: *852 - installation: *853 - issue: *884 + enterprise: *853 + installation: *854 + issue: *885 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -164332,8 +167349,8 @@ webhooks: - 'null' required: - id - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -164413,8 +167430,8 @@ webhooks: type: string enum: - labeled - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -165224,11 +168241,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -165348,9 +168365,9 @@ webhooks: - active_lock_reason - body - reactions - label: *873 - organization: *854 - repository: *855 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -165430,8 +168447,8 @@ webhooks: type: string enum: - locked - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -166266,11 +169283,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -166367,8 +169384,8 @@ webhooks: format: uri user_view_type: type: string - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -166447,8 +169464,8 @@ webhooks: type: string enum: - milestoned - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -167277,11 +170294,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -167378,9 +170395,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *885 - organization: *854 - repository: *855 + milestone: *886 + organization: *855 + repository: *856 sender: *4 required: - action @@ -168267,11 +171284,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -168863,8 +171880,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -169671,11 +172688,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -169798,8 +172815,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -169879,9 +172896,9 @@ webhooks: type: string enum: - pinned - enterprise: *852 - installation: *853 - issue: &886 + enterprise: *853 + installation: *854 + issue: &887 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. @@ -170686,11 +173703,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -170809,8 +173826,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -170889,8 +173906,8 @@ webhooks: type: string enum: - reopened - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -171723,11 +174740,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -171825,8 +174842,8 @@ webhooks: user_view_type: type: string type: *380 - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -172714,11 +175731,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -173328,11 +176345,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *852 - installation: *853 - issue: *886 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + issue: *887 + organization: *855 + repository: *856 sender: *4 required: - action @@ -173412,12 +176429,12 @@ webhooks: type: string enum: - typed - enterprise: *852 - installation: *853 - issue: *884 + enterprise: *853 + installation: *854 + issue: *885 type: *380 - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -173498,7 +176515,7 @@ webhooks: type: string enum: - unassigned - assignee: &910 + assignee: &911 title: User type: - object @@ -173570,11 +176587,11 @@ webhooks: required: - login - id - enterprise: *852 - installation: *853 - issue: *884 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + issue: *885 + organization: *855 + repository: *856 sender: *4 required: - action @@ -173653,12 +176670,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *852 - installation: *853 - issue: *884 - label: *873 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + issue: *885 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -173738,8 +176755,8 @@ webhooks: type: string enum: - unlocked - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -174572,11 +177589,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -174673,8 +177690,8 @@ webhooks: format: uri user_view_type: type: string - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -174754,11 +177771,11 @@ webhooks: type: string enum: - unpinned - enterprise: *852 - installation: *853 - issue: *886 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + issue: *887 + organization: *855 + repository: *856 sender: *4 required: - action @@ -174837,12 +177854,12 @@ webhooks: type: string enum: - untyped - enterprise: *852 - installation: *853 - issue: *884 + enterprise: *853 + installation: *854 + issue: *885 type: *380 - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -174922,11 +177939,11 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - label: *873 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -175004,11 +178021,11 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - label: *873 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -175118,11 +178135,11 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - label: *873 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -175204,9 +178221,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *852 - installation: *853 - marketplace_purchase: &887 + enterprise: *853 + installation: *854 + marketplace_purchase: &888 title: Marketplace Purchase type: object required: @@ -175294,8 +178311,8 @@ webhooks: type: integer unit_count: type: integer - organization: *854 - previous_marketplace_purchase: &888 + organization: *855 + previous_marketplace_purchase: &889 title: Marketplace Purchase type: object properties: @@ -175379,7 +178396,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *855 + repository: *856 sender: *4 required: - action @@ -175459,10 +178476,10 @@ webhooks: - changed effective_date: type: string - enterprise: *852 - installation: *853 - marketplace_purchase: *887 - organization: *854 + enterprise: *853 + installation: *854 + marketplace_purchase: *888 + organization: *855 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -175550,7 +178567,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *855 + repository: *856 sender: *4 required: - action @@ -175632,10 +178649,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *852 - installation: *853 - marketplace_purchase: *887 - organization: *854 + enterprise: *853 + installation: *854 + marketplace_purchase: *888 + organization: *855 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -175721,7 +178738,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *855 + repository: *856 sender: *4 required: - action @@ -175802,8 +178819,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 marketplace_purchase: title: Marketplace Purchase type: object @@ -175889,9 +178906,9 @@ webhooks: type: integer unit_count: type: integer - organization: *854 - previous_marketplace_purchase: *888 - repository: *855 + organization: *855 + previous_marketplace_purchase: *889 + repository: *856 sender: *4 required: - action @@ -175971,12 +178988,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *852 - installation: *853 - marketplace_purchase: *887 - organization: *854 - previous_marketplace_purchase: *888 - repository: *855 + enterprise: *853 + installation: *854 + marketplace_purchase: *888 + organization: *855 + previous_marketplace_purchase: *889 + repository: *856 sender: *4 required: - action @@ -176078,11 +179095,11 @@ webhooks: type: string required: - to - enterprise: *852 - installation: *853 - member: *879 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + member: *880 + organization: *855 + repository: *856 sender: *4 required: - action @@ -176184,11 +179201,11 @@ webhooks: type: - string - 'null' - enterprise: *852 - installation: *853 - member: *879 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + member: *880 + organization: *855 + repository: *856 sender: *4 required: - action @@ -176267,11 +179284,11 @@ webhooks: type: string enum: - removed - enterprise: *852 - installation: *853 - member: *879 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + member: *880 + organization: *855 + repository: *856 sender: *4 required: - action @@ -176349,11 +179366,11 @@ webhooks: type: string enum: - added - enterprise: *852 - installation: *853 - member: *879 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + member: *880 + organization: *855 + repository: *856 scope: description: The scope of the membership. Currently, can only be `team`. @@ -176431,7 +179448,7 @@ webhooks: required: - login - id - team: &889 + team: &890 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -176661,11 +179678,11 @@ webhooks: type: string enum: - removed - enterprise: *852 - installation: *853 - member: *879 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + member: *880 + organization: *855 + repository: *856 scope: description: The scope of the membership. Currently, can only be `team`. @@ -176744,7 +179761,7 @@ webhooks: required: - login - id - team: *889 + team: *890 required: - action - scope @@ -176826,8 +179843,8 @@ webhooks: type: string enum: - checks_requested - installation: *853 - merge_group: &890 + installation: *854 + merge_group: &891 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -176846,15 +179863,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *532 + head_commit: *533 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -176940,10 +179957,10 @@ webhooks: - merged - invalidated - dequeued - installation: *853 - merge_group: *890 - organization: *854 - repository: *855 + installation: *854 + merge_group: *891 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177016,7 +180033,7 @@ webhooks: type: string enum: - deleted - enterprise: *852 + enterprise: *853 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -177125,12 +180142,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *853 - organization: *854 + installation: *854 + organization: *855 repository: anyOf: - type: 'null' - - *855 + - *856 sender: *4 required: - action @@ -177210,11 +180227,11 @@ webhooks: type: string enum: - closed - enterprise: *852 - installation: *853 - milestone: *885 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + milestone: *886 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177293,9 +180310,9 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - milestone: &891 + enterprise: *853 + installation: *854 + milestone: &892 title: Milestone description: A collection of related issues and pull requests. type: object @@ -177437,8 +180454,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177517,11 +180534,11 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - milestone: *885 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + milestone: *886 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177631,11 +180648,11 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - milestone: *885 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + milestone: *886 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177715,11 +180732,11 @@ webhooks: type: string enum: - opened - enterprise: *852 - installation: *853 - milestone: *891 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + milestone: *892 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177798,11 +180815,11 @@ webhooks: type: string enum: - blocked - blocked_user: *879 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + blocked_user: *880 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177881,11 +180898,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *879 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + blocked_user: *880 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177961,7 +180978,7 @@ webhooks: enum: - created definition: *148 - enterprise: *852 + enterprise: *853 sender: *4 required: - action @@ -178041,8 +181058,8 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 sender: *4 required: - action @@ -178115,8 +181132,8 @@ webhooks: enum: - updated definition: *148 - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 sender: *4 required: - action @@ -178188,9 +181205,9 @@ webhooks: type: string enum: - updated - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 sender: *4 new_property_values: type: array @@ -178278,9 +181295,9 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - membership: &892 + enterprise: *853 + installation: *854 + membership: &893 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -178390,8 +181407,8 @@ webhooks: - role - organization_url - user - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -178469,11 +181486,11 @@ webhooks: type: string enum: - member_added - enterprise: *852 - installation: *853 - membership: *892 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + membership: *893 + organization: *855 + repository: *856 sender: *4 required: - action @@ -178552,8 +181569,8 @@ webhooks: type: string enum: - member_invited - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -178675,10 +181692,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 - user: *879 + user: *880 required: - action - invitation @@ -178756,11 +181773,11 @@ webhooks: type: string enum: - member_removed - enterprise: *852 - installation: *853 - membership: *892 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + membership: *893 + organization: *855 + repository: *856 sender: *4 required: - action @@ -178847,11 +181864,11 @@ webhooks: properties: from: type: string - enterprise: *852 - installation: *853 - membership: *892 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + membership: *893 + organization: *855 + repository: *856 sender: *4 required: - action @@ -178929,9 +181946,9 @@ webhooks: type: string enum: - published - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 package: description: Information about the package. type: object @@ -179454,7 +182471,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &893 + items: &894 title: Ruby Gems metadata type: object properties: @@ -179551,7 +182568,7 @@ webhooks: - owner - package_version - registry - repository: *855 + repository: *856 sender: *4 required: - action @@ -179628,9 +182645,9 @@ webhooks: type: string enum: - updated - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 package: description: Information about the package. type: object @@ -179992,7 +183009,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *893 + items: *894 source_url: type: string format: uri @@ -180063,7 +183080,7 @@ webhooks: - owner - package_version - registry - repository: *855 + repository: *856 sender: *4 required: - action @@ -180243,12 +183260,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *852 + enterprise: *853 id: type: integer - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - id @@ -180325,7 +183342,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &894 + personal_access_token_request: &895 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -180475,10 +183492,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *852 - organization: *854 + enterprise: *853 + organization: *855 sender: *4 - installation: *853 + installation: *854 required: - action - personal_access_token_request @@ -180555,11 +183572,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *894 - enterprise: *852 - organization: *854 + personal_access_token_request: *895 + enterprise: *853 + organization: *855 sender: *4 - installation: *853 + installation: *854 required: - action - personal_access_token_request @@ -180635,11 +183652,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *894 - enterprise: *852 - organization: *854 + personal_access_token_request: *895 + enterprise: *853 + organization: *855 sender: *4 - installation: *853 + installation: *854 required: - action - personal_access_token_request @@ -180714,11 +183731,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *894 - organization: *854 - enterprise: *852 + personal_access_token_request: *895 + organization: *855 + enterprise: *853 sender: *4 - installation: *853 + installation: *854 required: - action - personal_access_token_request @@ -180823,7 +183840,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *895 + last_response: *896 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -180855,8 +183872,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 zen: description: Random string of GitHub zen. @@ -181101,10 +184118,10 @@ webhooks: - from required: - note - enterprise: *852 - installation: *853 - organization: *854 - project_card: &896 + enterprise: *853 + installation: *854 + organization: *855 + project_card: &897 title: Project Card type: object properties: @@ -181227,7 +184244,7 @@ webhooks: - creator - created_at - updated_at - repository: *855 + repository: *856 sender: *4 required: - action @@ -181308,11 +184325,11 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - project_card: *896 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project_card: *897 + repository: *856 sender: *4 required: - action @@ -181392,9 +184409,9 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 project_card: title: Project Card type: object @@ -181524,7 +184541,7 @@ webhooks: repository: anyOf: - type: 'null' - - *855 + - *856 sender: *4 required: - action @@ -181618,11 +184635,11 @@ webhooks: - from required: - note - enterprise: *852 - installation: *853 - organization: *854 - project_card: *896 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project_card: *897 + repository: *856 sender: *4 required: - action @@ -181716,9 +184733,9 @@ webhooks: - from required: - column_id - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 project_card: allOf: - title: Project Card @@ -181915,7 +184932,7 @@ webhooks: type: string required: - after_id - repository: *855 + repository: *856 sender: *4 required: - action @@ -181995,10 +185012,10 @@ webhooks: type: string enum: - closed - enterprise: *852 - installation: *853 - organization: *854 - project: &898 + enterprise: *853 + installation: *854 + organization: *855 + project: &899 title: Project type: object properties: @@ -182125,7 +185142,7 @@ webhooks: - creator - created_at - updated_at - repository: *855 + repository: *856 sender: *4 required: - action @@ -182205,10 +185222,10 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - project_column: &897 + enterprise: *853 + installation: *854 + organization: *855 + project_column: &898 title: Project Column type: object properties: @@ -182248,7 +185265,7 @@ webhooks: - name - created_at - updated_at - repository: *855 + repository: *856 sender: *4 required: - action @@ -182327,14 +185344,14 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - project_column: *897 + enterprise: *853 + installation: *854 + organization: *855 + project_column: *898 repository: anyOf: - type: 'null' - - *855 + - *856 sender: *4 required: - action @@ -182423,11 +185440,11 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - organization: *854 - project_column: *897 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project_column: *898 + repository: *856 sender: *4 required: - action @@ -182507,11 +185524,11 @@ webhooks: type: string enum: - moved - enterprise: *852 - installation: *853 - organization: *854 - project_column: *897 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project_column: *898 + repository: *856 sender: *4 required: - action @@ -182591,11 +185608,11 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - project: *898 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project: *899 + repository: *856 sender: *4 required: - action @@ -182675,14 +185692,14 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - project: *898 + enterprise: *853 + installation: *854 + organization: *855 + project: *899 repository: anyOf: - type: 'null' - - *855 + - *856 sender: *4 required: - action @@ -182783,11 +185800,11 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - organization: *854 - project: *898 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project: *899 + repository: *856 sender: *4 required: - action @@ -182866,11 +185883,11 @@ webhooks: type: string enum: - reopened - enterprise: *852 - installation: *853 - organization: *854 - project: *898 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project: *899 + repository: *856 sender: *4 required: - action @@ -182951,8 +185968,8 @@ webhooks: type: string enum: - closed - installation: *853 - organization: *854 + installation: *854 + organization: *855 projects_v2: *411 sender: *4 required: @@ -183034,8 +186051,8 @@ webhooks: type: string enum: - created - installation: *853 - organization: *854 + installation: *854 + organization: *855 projects_v2: *411 sender: *4 required: @@ -183117,8 +186134,8 @@ webhooks: type: string enum: - deleted - installation: *853 - organization: *854 + installation: *854 + organization: *855 projects_v2: *411 sender: *4 required: @@ -183240,8 +186257,8 @@ webhooks: type: string to: type: string - installation: *853 - organization: *854 + installation: *854 + organization: *855 projects_v2: *411 sender: *4 required: @@ -183325,7 +186342,7 @@ webhooks: type: string enum: - archived - changes: &902 + changes: &903 type: object properties: archived_at: @@ -183341,9 +186358,9 @@ webhooks: - string - 'null' format: date-time - installation: *853 - organization: *854 - projects_v2_item: &899 + installation: *854 + organization: *855 + projects_v2_item: &900 title: Projects v2 Item description: An item belonging to a project type: object @@ -183483,9 +186500,9 @@ webhooks: - 'null' to: type: string - installation: *853 - organization: *854 - projects_v2_item: *899 + installation: *854 + organization: *855 + projects_v2_item: *900 sender: *4 required: - action @@ -183567,9 +186584,9 @@ webhooks: type: string enum: - created - installation: *853 - organization: *854 - projects_v2_item: *899 + installation: *854 + organization: *855 + projects_v2_item: *900 sender: *4 required: - action @@ -183650,9 +186667,9 @@ webhooks: type: string enum: - deleted - installation: *853 - organization: *854 - projects_v2_item: *899 + installation: *854 + organization: *855 + projects_v2_item: *900 sender: *4 required: - action @@ -183757,7 +186774,7 @@ webhooks: oneOf: - type: string - type: integer - - &900 + - &901 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -183781,7 +186798,7 @@ webhooks: required: - id - name - - &901 + - &902 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -183821,8 +186838,8 @@ webhooks: oneOf: - type: string - type: integer - - *900 - *901 + - *902 type: - 'null' - string @@ -183845,9 +186862,9 @@ webhooks: - 'null' required: - body - installation: *853 - organization: *854 - projects_v2_item: *899 + installation: *854 + organization: *855 + projects_v2_item: *900 sender: *4 required: - action @@ -183944,9 +186961,9 @@ webhooks: type: - string - 'null' - installation: *853 - organization: *854 - projects_v2_item: *899 + installation: *854 + organization: *855 + projects_v2_item: *900 sender: *4 required: - action @@ -184029,10 +187046,10 @@ webhooks: type: string enum: - restored - changes: *902 - installation: *853 - organization: *854 - projects_v2_item: *899 + changes: *903 + installation: *854 + organization: *855 + projects_v2_item: *900 sender: *4 required: - action @@ -184114,8 +187131,8 @@ webhooks: type: string enum: - reopened - installation: *853 - organization: *854 + installation: *854 + organization: *855 projects_v2: *411 sender: *4 required: @@ -184197,9 +187214,9 @@ webhooks: type: string enum: - created - installation: *853 - organization: *854 - projects_v2_status_update: *903 + installation: *854 + organization: *855 + projects_v2_status_update: *904 sender: *4 required: - action @@ -184280,9 +187297,9 @@ webhooks: type: string enum: - deleted - installation: *853 - organization: *854 - projects_v2_status_update: *903 + installation: *854 + organization: *855 + projects_v2_status_update: *904 sender: *4 required: - action @@ -184428,9 +187445,9 @@ webhooks: - string - 'null' format: date - installation: *853 - organization: *854 - projects_v2_status_update: *903 + installation: *854 + organization: *855 + projects_v2_status_update: *904 sender: *4 required: - action @@ -184501,10 +187518,10 @@ webhooks: title: public event type: object properties: - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - repository @@ -184581,13 +187598,13 @@ webhooks: type: string enum: - assigned - assignee: *879 - enterprise: *852 - installation: *853 - number: &904 + assignee: *880 + enterprise: *853 + installation: *854 + number: &905 description: The pull request number. type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -186958,7 +189975,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -187040,11 +190057,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -189408,7 +192425,7 @@ webhooks: - draft reason: type: string - repository: *855 + repository: *856 sender: *4 required: - action @@ -189490,11 +192507,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -191858,7 +194875,7 @@ webhooks: - draft reason: type: string - repository: *855 + repository: *856 sender: *4 required: - action @@ -191940,13 +194957,13 @@ webhooks: type: string enum: - closed - enterprise: *852 - installation: *853 - number: *904 - organization: *854 - pull_request: &905 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 + pull_request: &906 allOf: - - *701 + - *702 - type: object properties: allow_auto_merge: @@ -192008,7 +195025,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *855 + repository: *856 sender: *4 required: - action @@ -192089,12 +195106,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *852 - installation: *853 - number: *904 - organization: *854 - pull_request: *905 - repository: *855 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 + pull_request: *906 + repository: *856 sender: *4 required: - action @@ -192174,11 +195191,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *852 + enterprise: *853 milestone: *414 - number: *904 - organization: *854 - pull_request: &906 + number: *905 + organization: *855 + pull_request: &907 title: Pull Request type: object properties: @@ -194527,7 +197544,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -194606,11 +197623,11 @@ webhooks: type: string enum: - dequeued - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -196978,7 +199995,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *855 + repository: *856 sender: *4 required: - action @@ -197102,12 +200119,12 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - number: *904 - organization: *854 - pull_request: *905 - repository: *855 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 + pull_request: *906 + repository: *856 sender: *4 required: - action @@ -197187,11 +200204,11 @@ webhooks: type: string enum: - enqueued - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -199544,7 +202561,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -199624,11 +202641,11 @@ webhooks: type: string enum: - labeled - enterprise: *852 - installation: *853 - label: *873 - number: *904 - organization: *854 + enterprise: *853 + installation: *854 + label: *874 + number: *905 + organization: *855 pull_request: title: Pull Request type: object @@ -201998,7 +205015,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -202079,10 +205096,10 @@ webhooks: type: string enum: - locked - enterprise: *852 - installation: *853 - number: *904 - organization: *854 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 pull_request: title: Pull Request type: object @@ -204450,7 +207467,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -204530,12 +207547,12 @@ webhooks: type: string enum: - milestoned - enterprise: *852 + enterprise: *853 milestone: *414 - number: *904 - organization: *854 - pull_request: *906 - repository: *855 + number: *905 + organization: *855 + pull_request: *907 + repository: *856 sender: *4 required: - action @@ -204614,12 +207631,12 @@ webhooks: type: string enum: - opened - enterprise: *852 - installation: *853 - number: *904 - organization: *854 - pull_request: *905 - repository: *855 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 + pull_request: *906 + repository: *856 sender: *4 required: - action @@ -204700,12 +207717,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *852 - installation: *853 - number: *904 - organization: *854 - pull_request: *905 - repository: *855 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 + pull_request: *906 + repository: *856 sender: *4 required: - action @@ -204785,12 +207802,12 @@ webhooks: type: string enum: - reopened - enterprise: *852 - installation: *853 - number: *904 - organization: *854 - pull_request: *905 - repository: *855 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 + pull_request: *906 + repository: *856 sender: *4 required: - action @@ -205165,9 +208182,9 @@ webhooks: - start_side - side - reactions - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: type: object properties: @@ -207419,7 +210436,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *855 + repository: *856 sender: *4 required: - action @@ -207499,7 +210516,7 @@ webhooks: type: string enum: - deleted - comment: &908 + comment: &909 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -207792,9 +210809,9 @@ webhooks: - start_side - side - reactions - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: type: object properties: @@ -210034,7 +213051,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *855 + repository: *856 sender: *4 required: - action @@ -210114,11 +213131,11 @@ webhooks: type: string enum: - edited - changes: *907 - comment: *908 - enterprise: *852 - installation: *853 - organization: *854 + changes: *908 + comment: *909 + enterprise: *853 + installation: *854 + organization: *855 pull_request: type: object properties: @@ -212361,7 +215378,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *855 + repository: *856 sender: *4 required: - action @@ -212442,9 +215459,9 @@ webhooks: type: string enum: - dismissed - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: title: Simple Pull Request type: object @@ -214699,7 +217716,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *855 + repository: *856 review: description: The review that was affected. type: object @@ -214950,9 +217967,9 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: title: Simple Pull Request type: object @@ -217066,8 +220083,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *855 - review: &909 + repository: *856 + review: &910 description: The review that was affected. type: object properties: @@ -217305,12 +220322,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: description: The pull request number. type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -219679,7 +222696,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 requested_reviewer: title: User type: @@ -219765,12 +222782,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: description: The pull request number. type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -222146,7 +225163,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 requested_team: title: Team description: Groups of organization members that gives permissions @@ -222341,12 +225358,12 @@ webhooks: type: string enum: - review_requested - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: description: The pull request number. type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -224717,7 +227734,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 requested_reviewer: title: User type: @@ -224804,12 +227821,12 @@ webhooks: type: string enum: - review_requested - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: description: The pull request number. type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -227171,7 +230188,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 requested_team: title: Team description: Groups of organization members that gives permissions @@ -227355,9 +230372,9 @@ webhooks: type: string enum: - submitted - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: title: Simple Pull Request type: object @@ -229615,8 +232632,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *855 - review: *909 + repository: *856 + review: *910 sender: *4 required: - action @@ -229696,9 +232713,9 @@ webhooks: type: string enum: - resolved - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: title: Simple Pull Request type: object @@ -231851,7 +234868,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *855 + repository: *856 sender: *4 thread: type: object @@ -232248,9 +235265,9 @@ webhooks: type: string enum: - unresolved - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: title: Simple Pull Request type: object @@ -234386,7 +237403,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *855 + repository: *856 sender: *4 thread: type: object @@ -234785,10 +237802,10 @@ webhooks: type: string before: type: string - enterprise: *852 - installation: *853 - number: *904 - organization: *854 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 pull_request: title: Pull Request type: object @@ -237145,7 +240162,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -237227,11 +240244,11 @@ webhooks: type: string enum: - unassigned - assignee: *910 - enterprise: *852 - installation: *853 - number: *904 - organization: *854 + assignee: *911 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 pull_request: title: Pull Request type: object @@ -239603,7 +242620,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -239682,11 +242699,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *852 - installation: *853 - label: *873 - number: *904 - organization: *854 + enterprise: *853 + installation: *854 + label: *874 + number: *905 + organization: *855 pull_request: title: Pull Request type: object @@ -242047,7 +245064,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -242128,10 +245145,10 @@ webhooks: type: string enum: - unlocked - enterprise: *852 - installation: *853 - number: *904 - organization: *854 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 pull_request: title: Pull Request type: object @@ -244482,7 +247499,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -244685,7 +247702,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *852 + enterprise: *853 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -244780,8 +247797,8 @@ webhooks: - url - author - committer - installation: *853 - organization: *854 + installation: *854 + organization: *855 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -245380,9 +248397,9 @@ webhooks: type: string enum: - published - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 registry_package: type: object properties: @@ -245859,7 +248876,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *893 + items: *894 summary: type: string tag_name: @@ -245915,7 +248932,7 @@ webhooks: - owner - package_version - registry - repository: *855 + repository: *856 sender: *4 required: - action @@ -245993,9 +249010,9 @@ webhooks: type: string enum: - updated - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 registry_package: type: object properties: @@ -246307,7 +249324,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *893 + items: *894 summary: type: string tag_name: @@ -246357,7 +249374,7 @@ webhooks: - owner - package_version - registry - repository: *855 + repository: *856 sender: *4 required: - action @@ -246434,10 +249451,10 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - release: &911 + enterprise: *853 + installation: *854 + organization: *855 + release: &912 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object. @@ -246768,7 +249785,7 @@ webhooks: - updated_at - zipball_url - body - repository: *855 + repository: *856 sender: *4 required: - action @@ -246845,11 +249862,11 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - release: *911 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + release: *912 + repository: *856 sender: *4 required: - action @@ -246966,11 +249983,11 @@ webhooks: type: boolean required: - to - enterprise: *852 - installation: *853 - organization: *854 - release: *911 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + release: *912 + repository: *856 sender: *4 required: - action @@ -247048,9 +250065,9 @@ webhooks: type: string enum: - prereleased - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) @@ -247386,7 +250403,7 @@ webhooks: - string - 'null' format: uri - repository: *855 + repository: *856 sender: *4 required: - action @@ -247462,10 +250479,10 @@ webhooks: type: string enum: - published - enterprise: *852 - installation: *853 - organization: *854 - release: &912 + enterprise: *853 + installation: *854 + organization: *855 + release: &913 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object. @@ -247798,7 +250815,7 @@ webhooks: - string - 'null' format: uri - repository: *855 + repository: *856 sender: *4 required: - action @@ -247874,11 +250891,11 @@ webhooks: type: string enum: - released - enterprise: *852 - installation: *853 - organization: *854 - release: *911 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + release: *912 + repository: *856 sender: *4 required: - action @@ -247954,11 +250971,11 @@ webhooks: type: string enum: - unpublished - enterprise: *852 - installation: *853 - organization: *854 - release: *912 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + release: *913 + repository: *856 sender: *4 required: - action @@ -248034,11 +251051,11 @@ webhooks: type: string enum: - published - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - repository_advisory: *753 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + repository_advisory: *754 sender: *4 required: - action @@ -248114,11 +251131,11 @@ webhooks: type: string enum: - reported - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - repository_advisory: *753 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + repository_advisory: *754 sender: *4 required: - action @@ -248194,10 +251211,10 @@ webhooks: type: string enum: - archived - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -248274,10 +251291,10 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -248355,10 +251372,10 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -248443,10 +251460,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -248561,10 +251578,10 @@ webhooks: - 'null' items: type: string - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -248636,10 +251653,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 status: type: string @@ -248720,10 +251737,10 @@ webhooks: type: string enum: - privatized - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -248800,10 +251817,10 @@ webhooks: type: string enum: - publicized - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -248897,10 +251914,10 @@ webhooks: - name required: - repository - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -248980,10 +251997,10 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 repository_ruleset: *187 sender: *4 required: @@ -249062,10 +252079,10 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 repository_ruleset: *187 sender: *4 required: @@ -249144,10 +252161,10 @@ webhooks: type: string enum: - edited - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 repository_ruleset: *187 changes: type: object @@ -249209,16 +252226,16 @@ webhooks: properties: added: type: array - items: *721 + items: *722 deleted: type: array - items: *721 + items: *722 updated: type: array items: type: object properties: - rule: *721 + rule: *722 changes: type: object properties: @@ -249455,10 +252472,10 @@ webhooks: - from required: - owner - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -249536,10 +252553,10 @@ webhooks: type: string enum: - unarchived - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -249617,7 +252634,7 @@ webhooks: type: string enum: - create - alert: &913 + alert: &914 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -249742,10 +252759,10 @@ webhooks: enum: - auto_dismissed - open - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -249955,10 +252972,10 @@ webhooks: type: string enum: - dismissed - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -250036,11 +253053,11 @@ webhooks: type: string enum: - reopen - alert: *913 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + alert: *914 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -250242,10 +253259,10 @@ webhooks: enum: - fixed - open - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -250323,7 +253340,7 @@ webhooks: type: string enum: - assigned - alert: &914 + alert: &915 type: object properties: number: *127 @@ -250463,10 +253480,10 @@ webhooks: - type: 'null' - *4 assignee: *4 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -250544,11 +253561,11 @@ webhooks: type: string enum: - created - alert: *914 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + alert: *915 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -250629,11 +253646,11 @@ webhooks: type: string enum: - created - alert: *914 - installation: *853 - location: *915 - organization: *854 - repository: *855 + alert: *915 + installation: *854 + location: *916 + organization: *855 + repository: *856 sender: *4 required: - location @@ -250871,11 +253888,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *914 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + alert: *915 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -250953,11 +253970,11 @@ webhooks: type: string enum: - reopened - alert: *914 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + alert: *915 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -251035,11 +254052,11 @@ webhooks: type: string enum: - resolved - alert: *914 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + alert: *915 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -251117,12 +254134,12 @@ webhooks: type: string enum: - unassigned - alert: *914 + alert: *915 assignee: *4 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -251200,11 +254217,11 @@ webhooks: type: string enum: - validated - alert: *914 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + alert: *915 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -251334,10 +254351,10 @@ webhooks: - organization - enterprise - - repository: *855 - enterprise: *852 - installation: *853 - organization: *854 + repository: *856 + enterprise: *853 + installation: *854 + organization: *855 sender: *4 required: - action @@ -251415,11 +254432,11 @@ webhooks: type: string enum: - published - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - security_advisory: &916 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + security_advisory: &917 description: The details of the security advisory, including summary, description, and severity. type: object @@ -251605,11 +254622,11 @@ webhooks: type: string enum: - updated - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - security_advisory: *916 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + security_advisory: *917 sender: *4 required: - action @@ -251682,10 +254699,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -251872,10 +254889,10 @@ webhooks: type: object properties: security_and_analysis: *425 - enterprise: *852 - installation: *853 - organization: *854 - repository: *470 + enterprise: *853 + installation: *854 + organization: *855 + repository: *471 sender: *4 required: - changes @@ -251953,12 +254970,12 @@ webhooks: type: string enum: - cancelled - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - sponsorship: &917 + sponsorship: &918 type: object properties: created_at: @@ -252263,12 +255280,12 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - sponsorship: *917 + sponsorship: *918 required: - action - sponsorship @@ -252356,12 +255373,12 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - sponsorship: *917 + sponsorship: *918 required: - action - changes @@ -252438,17 +255455,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &918 + effective_date: &919 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - sponsorship: *917 + sponsorship: *918 required: - action - sponsorship @@ -252522,7 +255539,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &919 + changes: &920 type: object properties: tier: @@ -252566,13 +255583,13 @@ webhooks: - from required: - tier - effective_date: *918 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + effective_date: *919 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - sponsorship: *917 + sponsorship: *918 required: - action - changes @@ -252649,13 +255666,13 @@ webhooks: type: string enum: - tier_changed - changes: *919 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + changes: *920 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - sponsorship: *917 + sponsorship: *918 required: - action - changes @@ -252729,10 +255746,10 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -252816,10 +255833,10 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -253253,15 +256270,15 @@ webhooks: type: - string - 'null' - enterprise: *852 + enterprise: *853 id: description: The unique identifier of the status. type: integer - installation: *853 + installation: *854 name: type: string - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 sha: description: The Commit SHA. @@ -253377,9 +256394,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *219 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -253469,9 +256486,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *219 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -253561,9 +256578,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *219 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -253653,9 +256670,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *219 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -253732,12 +256749,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - team: &920 + team: &921 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -253967,9 +256984,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 repository: title: Repository description: A git repository @@ -254439,7 +257456,7 @@ webhooks: - topics - visibility sender: *4 - team: *920 + team: *921 required: - action - team @@ -254515,9 +257532,9 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 repository: title: Repository description: A git repository @@ -254987,7 +258004,7 @@ webhooks: - topics - visibility sender: *4 - team: *920 + team: *921 required: - action - team @@ -255064,9 +258081,9 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 repository: title: Repository description: A git repository @@ -255536,7 +258553,7 @@ webhooks: - topics - visibility sender: *4 - team: *920 + team: *921 required: - action - team @@ -255680,9 +258697,9 @@ webhooks: - from required: - permissions - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 repository: title: Repository description: A git repository @@ -256152,7 +259169,7 @@ webhooks: - topics - visibility sender: *4 - team: *920 + team: *921 required: - action - changes @@ -256230,9 +259247,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 repository: title: Repository description: A git repository @@ -256702,7 +259719,7 @@ webhooks: - topics - visibility sender: *4 - team: *920 + team: *921 required: - action - team @@ -256778,10 +259795,10 @@ webhooks: type: string enum: - started - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -256854,17 +259871,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *852 + enterprise: *853 inputs: type: - object - 'null' additionalProperties: true - installation: *853 - organization: *854 + installation: *854 + organization: *855 ref: type: string - repository: *855 + repository: *856 sender: *4 workflow: type: string @@ -256946,10 +259963,10 @@ webhooks: type: string enum: - completed - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 workflow_job: allOf: @@ -257205,7 +260222,7 @@ webhooks: type: string required: - conclusion - deployment: *607 + deployment: *608 required: - action - repository @@ -257284,10 +260301,10 @@ webhooks: type: string enum: - in_progress - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 workflow_job: allOf: @@ -257569,7 +260586,7 @@ webhooks: required: - status - steps - deployment: *607 + deployment: *608 required: - action - repository @@ -257648,10 +260665,10 @@ webhooks: type: string enum: - queued - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 workflow_job: type: object @@ -257797,7 +260814,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *607 + deployment: *608 required: - action - repository @@ -257876,10 +260893,10 @@ webhooks: type: string enum: - waiting - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 workflow_job: type: object @@ -258026,7 +261043,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *607 + deployment: *608 required: - action - repository @@ -258106,12 +261123,12 @@ webhooks: type: string enum: - completed - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - workflow: *869 + workflow: *870 workflow_run: title: Workflow Run type: object @@ -259130,12 +262147,12 @@ webhooks: type: string enum: - in_progress - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - workflow: *869 + workflow: *870 workflow_run: title: Workflow Run type: object @@ -260139,12 +263156,12 @@ webhooks: type: string enum: - requested - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - workflow: *869 + workflow: *870 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json index f0deb8b20..8323dfb57 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json @@ -2168,6 +2168,3174 @@ } } }, + "/agents/repos/{owner}/{repo}/tasks": { + "get": { + "summary": "List tasks for repository", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n\n**Fine-grained access tokens for \"List tasks for repository\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#list-tasks-for-repository" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Start a task", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nStarts a new Copilot cloud agent task for a repository.\n\nThis endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription.\n\n**Fine-grained access tokens for \"Start a task\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read and write)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/create-task-in-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#start-a-task" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + } + ], + "requestBody": { + "required": true, + "description": "The task creation parameters, including the user's prompt and optional agent settings.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "prompt" + ], + "properties": { + "prompt": { + "type": "string", + "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`" + }, + "create_pull_request": { + "type": "boolean", + "description": "Whether to create a PR.", + "default": false + }, + "base_ref": { + "type": "string", + "description": "Base ref for new branch/PR" + } + } + }, + "examples": { + "default": { + "value": { + "prompt": "Fix the login button on the homepage", + "base_ref": "main" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Task created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "queued", + "session_count": 1, + "artifacts": [], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "400": { + "description": "Problems parsing JSON", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/repos/{owner}/{repo}/tasks/{task_id}": { + "get": { + "summary": "Get a task by repo", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n\n**Fine-grained access tokens for \"Get a task by repo\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-repo-and-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#get-a-task-by-repo" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "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": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks": { + "get": { + "summary": "List tasks", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n\n**Fine-grained access tokens for \"List tasks\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#list-tasks" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks/{task_id}": { + "get": { + "summary": "Get a task by ID", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n\n**Fine-grained access tokens for \"Get a task by ID\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#get-a-task-by-id" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "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": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, "/app": { "get": { "summary": "Get the authenticated app", @@ -70472,6 +73640,15 @@ "type": "boolean", "default": false } + }, + { + "name": "is_bypassed", + "in": "query", + "description": "A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -153456,7 +156633,7 @@ "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { "post": { "summary": "Set cluster deployment records", - "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.", + "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.\nNote: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments\narray resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use\nthe artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can\nonly have one name and version.", "tags": [ "orgs" ], @@ -153515,20 +156692,20 @@ "properties": { "name": { "type": "string", - "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", + "description": "The name of the artifact.", "minLength": 1, "maxLength": 256 }, "digest": { "type": "string", - "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", + "description": "The hex encoded digest of the artifact.", "minLength": 71, "maxLength": 71, "pattern": "^sha256:[a-f0-9]{64}$" }, "version": { "type": "string", - "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", + "description": "The artifact version.", "maxLength": 100, "x-multi-segment": true, "examples": [ @@ -247314,7 +250491,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -247399,6 +250577,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -247551,7 +250737,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -247642,7 +250828,7 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication.", "type": "string", "enum": [ "token", @@ -247650,7 +250836,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -247686,7 +250873,7 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { @@ -247704,6 +250891,14 @@ "api_host": { "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", "type": "string" + }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). Required when `auth_type` is `oidc_gcp`.", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).", + "type": "string" } }, "required": [ @@ -247762,6 +250957,17 @@ "service_slug": "my-service-account", "audience": "https://github.com/my-org" } + }, + "org-private-registry-with-oidc-gcp": { + "summary": "Example of an OIDC private registry configuration using Google Cloud Artifact Registry", + "value": { + "registry_type": "docker_registry", + "url": "https://us-docker.pkg.dev/my-project/my-repo", + "auth_type": "oidc_gcp", + "visibility": "all", + "workload_identity_provider": "projects/123456789/locations/global/workloadIdentityPools/github-pool/providers/github-provider", + "service_account": "dependabot@my-project.iam.gserviceaccount.com" + } } } } @@ -247813,7 +251019,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -247902,6 +251109,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -248241,7 +251456,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -248326,6 +251542,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -248394,7 +251618,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -248502,7 +251726,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -248538,7 +251763,7 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { @@ -248556,6 +251781,14 @@ "api_host": { "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", "type": "string" + }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). Required when `auth_type` is `oidc_gcp`.", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).", + "type": "string" } } }, @@ -296511,6 +299744,15 @@ "type": "boolean", "default": false } + }, + { + "name": "is_bypassed", + "in": "query", + "description": "A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -326525,25 +329767,547 @@ } }, { - "name": "cache_id", - "description": "The unique identifier of the GitHub Actions cache.", + "name": "cache_id", + "description": "The unique identifier of the GitHub Actions cache.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/concurrency_groups": { + "get": { + "summary": "List concurrency groups for a repository", + "description": "Lists the active concurrency groups for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-concurrency-groups-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Concurrency Group List", + "description": "A list of active concurrency groups for a repository.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "last_acquired_at" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "last_acquired_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "last_acquired_at": "2026-01-15T16:14:23Z" + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "last_acquired_at": "2026-01-15T16:13:55Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "concurrency-groups" + } + } + }, + "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}": { + "get": { + "summary": "Get a concurrency group for a repository", + "description": "Gets a specific concurrency group for a repository, including all instances in the group's queue.\nReturns 404 if the group is inactive or does not exist.\n\nOptionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items\nahead of the specified workflow run or job in the queue, plus the specified item itself\n(returned as the last element). This is useful for determining what is blocking a particular\nrun or job. Returns 422 if the specified run or job is not in this concurrency group.\n\nWhen using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow\nleases held on behalf of that run. Job-level leases within the run are not considered to\nblock the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow\nleases on the job's ancestor paths.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/get-concurrency-group-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "concurrency_group_name", + "description": "The name of the concurrency group.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "ahead_of_run", + "description": "Filter to items ahead of this workflow run ID in the queue, plus the run itself.\nMatches workflow-level concurrency and reusable-workflow leases held on behalf of\nthe run. Mutually exclusive with `ahead_of_job`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + }, + { + "name": "ahead_of_job", + "description": "Filter to items ahead of this job ID in the queue, plus the job itself.\nMatches job-level concurrency and reusable-workflow leases on the job's\nancestor paths. Mutually exclusive with `ahead_of_run`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 } } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Concurrency Group", + "description": "A concurrency group with the workflow runs and jobs that are either currently holding\nor waiting for the concurrency group lease.", + "type": "object", + "required": [ + "group_name", + "group_url", + "total_count", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "total_count": { + "type": "integer" + }, + "group_members": { + "type": "array", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "job_id": { + "type": "integer", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "total_count": 3, + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress" + }, + { + "run_id": 30433643, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433643", + "status": "pending" + }, + { + "run_id": 30433644, + "run_name": "Deploy hotfix", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644", + "job_id": 798245260, + "job_name": "deploy", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260", + "status": "pending" + } + ] + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "concurrency-groups" } } }, @@ -343927,99 +347691,386 @@ } }, { - "name": "attempt_number", - "description": "The attempt number of the workflow run.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "302": { - "description": "Response", - "headers": { - "Location": { - "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "workflow-runs" - } - } - }, - "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { - "post": { - "summary": "Cancel a workflow run", - "description": "Cancels a workflow run using its `id`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/cancel-workflow-run", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#cancel-a-workflow-run" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "attempt_number", + "description": "The attempt number of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + "post": { + "summary": "Cancel a workflow run", + "description": "Cancels a workflow run using its `id`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/cancel-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#cancel-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The unique identifier of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups": { + "get": { + "summary": "List concurrency groups for a workflow run", + "description": "Lists all concurrency groups associated with a workflow run or its jobs.\n\nThe set of groups is derived from the run's configuration, so a group is\nincluded even when the run no longer has any items currently holding or\nwaiting in it. In that case the `group_members` array will be empty.\n`total_count` reflects the number of groups the run participates in by\nconfiguration, not the number with active items.\n\nThis differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`,\nwhich returns 404 when a group has no active items. That endpoint reports\nthe live state of a group repo-wide, while this endpoint reports the\ngroups associated with a specific run by configuration.\n\nResults are sorted by group name and support cursor-based pagination via\n`before` and `after`. The `after` cursor paginates forward only and does\nnot emit a `rel=\"prev\"` Link; use `before` to page backward from a\nforward page's `next` cursor.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-concurrency-groups-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The unique identifier of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 } }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, "schema": { "type": "string" } }, { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "path", - "required": true, + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, "schema": { - "type": "integer" + "type": "string" } } ], "responses": { - "202": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", + "title": "Concurrency Group Run List", + "description": "A list of concurrency groups associated with a workflow run.", "type": "object", - "properties": {}, - "additionalProperties": false + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer", + "description": "The total number of concurrency groups this workflow run participates in,\nderived from the run's configuration. This count is not filtered by\nwhether the run currently holds or is waiting in each group, so it can\ninclude groups whose `group_members` array is empty (for example, when\nthe run has already released its lease in that group)." + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group. May return 404 if the group\nhas no active items at the time it is requested, since the\nget-by-name endpoint reports the live repo-wide state of a group\nwhile this endpoint lists groups associated with a run by\nconfiguration." + }, + "group_members": { + "type": "array", + "description": "Items belonging to this workflow run that are either currently holding or\nwaiting for the concurrency group lease. May be empty if the run no\nlonger has any active or queued items in this group.", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status", + "position", + "position_url" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "position": { + "type": "integer", + "description": "Queue position. 0 means the item holds the concurrency lease (in_progress), 1 or higher means queued (pending)." + }, + "position_url": { + "type": "string", + "format": "uri", + "description": "API URL to get items ahead of this item in the concurrency group." + }, + "job_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": [ + "string", + "null" + ], + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } }, "examples": { "default": { - "value": null + "value": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress", + "position": 0, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642" + } + ] + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "pending", + "position": 2, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260", + "job_id": 798245260, + "job_name": "build", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260" + } + ] + } + ] + } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, - "409": { - "description": "Conflict", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -344043,13 +348094,88 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "workflow-runs" + "subcategory": "concurrency-groups" } } }, @@ -684134,6 +688260,15 @@ "type": "boolean", "default": false } + }, + { + "name": "is_bypassed", + "in": "query", + "description": "A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { diff --git a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml index 74985f54e..112280439 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml @@ -889,7 +889,7 @@ paths: - subscriptions_url - type - url - type: &449 + type: &450 type: string description: The type of credit the user is receiving. enum: @@ -1054,7 +1054,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &755 + - &756 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1141,6 +1141,2530 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories + "/agents/repos/{owner}/{repo}/tasks": + get: + summary: List tasks for repository + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for a specific repository + + **Fine-grained access tokens for "List tasks for repository"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/list-tasks-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#list-tasks-for-repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, + `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived + tasks. When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + - name: creator_id + in: query + schema: + type: integer + description: Filter tasks by creator user ID + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="prev" (when current page > 1), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; + rel="next", ; + rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + post: + summary: Start a task + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Starts a new Copilot cloud agent task for a repository. + + This endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription. + + **Fine-grained access tokens for "Start a task"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read and write) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/create-task-in-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#start-a-task + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + requestBody: + required: true + description: The task creation parameters, including the user's prompt and + optional agent settings. + content: + application/json: + schema: + type: object + required: + - prompt + properties: + prompt: + type: string + 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`' + create_pull_request: + type: boolean + description: Whether to create a PR. + default: false + base_ref: + type: string + description: Base ref for new branch/PR + examples: + default: + value: + prompt: Fix the login button on the homepage + base_ref: main + responses: + '201': + description: Task created successfully + content: + application/json: + schema: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: queued + session_count: 1 + artifacts: [] + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '400': + description: Problems parsing JSON + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/repos/{owner}/{repo}/tasks/{task_id}": + get: + summary: Get a task by repo + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID scoped to an owner/repo path + + **Fine-grained access tokens for "Get a task by repo"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-repo-and-id + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#get-a-task-by-repo + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + allOf: + - type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + 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: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/tasks": + get: + summary: List tasks + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for the authenticated user + + **Fine-grained access tokens for "List tasks"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/list-tasks + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#list-tasks + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, + `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived + tasks. When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; rel="next", + ; rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/tasks/{task_id}": + get: + summary: Get a task by ID + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID with its associated sessions + + **Fine-grained access tokens for "Get a task by ID"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#get-a-task-by-id + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + allOf: + - type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + 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: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation "/app": get: summary: Get the authenticated app @@ -1793,7 +4317,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &764 + schema: &765 title: Scim Error description: Scim Error type: object @@ -9416,7 +11940,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &765 + '401': &766 description: Authorization failure '404': *6 x-github: @@ -13689,7 +16213,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &538 + instances_url: &539 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13725,7 +16249,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &539 + dismissed_reason: &540 type: - string - 'null' @@ -13736,14 +16260,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &540 + dismissed_comment: &541 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &541 + rule: &542 type: object properties: id: @@ -13804,7 +16328,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &542 + tool: &543 type: object properties: name: *111 @@ -13815,26 +16339,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *112 - most_recent_instance: &543 + most_recent_instance: &544 type: object properties: - ref: &536 + ref: &537 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &553 + analysis_key: &554 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - environment: &554 + environment: &555 type: string description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &555 + category: &556 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -13854,7 +16378,7 @@ paths: with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance. - location: &556 + location: &557 type: object description: Describe a region within a file for the alert. properties: @@ -13875,7 +16399,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &557 + items: &558 type: - string - 'null' @@ -18409,7 +20933,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &596 + - &597 name: has in: query description: |- @@ -18536,7 +21060,7 @@ paths: - transitive - inconclusive - - security_advisory: &597 + security_advisory: &598 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -18756,7 +21280,7 @@ paths: dismissal. maxLength: 280 fixed_at: *137 - auto_dismissed_at: &598 + auto_dismissed_at: &599 type: - string - 'null' @@ -18764,7 +21288,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &599 + dismissal_request: &600 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -20570,7 +23094,7 @@ paths: - name - created_on examples: - default: &453 + default: &454 value: total_count: 2 network_configurations: @@ -20821,7 +23345,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *39 - - &454 + - &455 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -20833,7 +23357,7 @@ paths: description: Response content: application/json: - schema: &455 + schema: &456 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -20872,7 +23396,7 @@ paths: - subnet_id - region examples: - default: &456 + default: &457 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -22978,7 +25502,7 @@ paths: - object rules: type: array - items: &721 + items: &722 title: Repository Rule type: object description: A repository rule. @@ -22987,7 +25511,7 @@ paths: - *167 - *168 - *169 - - &719 + - &720 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -23557,6 +26081,17 @@ paths: schema: type: boolean default: false + - &445 + name: is_bypassed + in: query + description: A boolean value (`true` or `false`) indicating whether to filter + alerts by their push protection bypass status. When set to `true`, only + alerts that were created because a push protection rule was bypassed will + be returned. When set to `false`, only alerts that were not caused by a + push protection bypass will be returned. + required: false + schema: + type: boolean responses: '200': description: Response @@ -23564,7 +26099,7 @@ paths: application/json: schema: type: array - items: &445 + items: &446 type: object properties: number: *127 @@ -23580,14 +26115,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &733 + state: &734 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &734 + resolution: &735 type: - string - 'null' @@ -23706,14 +26241,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &735 + - &736 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &737 + - &738 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -23777,7 +26312,7 @@ paths: - blob_url - commit_sha - commit_url - - &738 + - &739 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -23838,7 +26373,7 @@ paths: - page_url - commit_sha - commit_url - - &739 + - &740 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -23860,7 +26395,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &740 + - &741 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -23882,7 +26417,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &741 + - &742 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -23904,7 +26439,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &742 + - &743 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -23919,7 +26454,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &743 + - &744 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -23934,7 +26469,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &744 + - &745 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -23949,7 +26484,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &745 + - &746 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -23971,7 +26506,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &746 + - &747 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -23993,7 +26528,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &747 + - &748 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -24015,7 +26550,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &748 + - &749 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -24037,7 +26572,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &749 + - &750 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -24083,7 +26618,7 @@ paths: - type: 'null' - *4 examples: - default: &446 + default: &447 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -24292,7 +26827,7 @@ paths: description: Response content: application/json: - schema: &447 + schema: &448 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -24379,7 +26914,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *193 examples: - default: &448 + default: &449 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -24515,7 +27050,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *39 - - &450 + - &451 name: advanced_security_product in: query description: | @@ -24535,7 +27070,7 @@ paths: description: Success content: application/json: - schema: &451 + schema: &452 type: object properties: total_advanced_security_committers: @@ -24598,7 +27133,7 @@ paths: required: - repositories examples: - default: &452 + default: &453 value: total_advanced_security_committers: 2 total_count: 2 @@ -27758,7 +30293,7 @@ paths: properties: action: type: string - discussion: &870 + discussion: &871 title: Discussion description: A Discussion in a repository. type: object @@ -28543,7 +31078,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &792 + sub_issues_summary: &793 title: Sub-issues Summary type: object properties: @@ -28627,7 +31162,7 @@ paths: pin: anyOf: - type: 'null' - - &678 + - &679 title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. @@ -28654,7 +31189,7 @@ paths: - url - created_at - updated_at - issue_dependencies_summary: &793 + issue_dependencies_summary: &794 title: Issue Dependencies Summary type: object properties: @@ -28673,7 +31208,7 @@ paths: - total_blocking issue_field_values: type: array - items: &662 + items: &663 title: Issue Field Value description: A value assigned to an issue field type: object @@ -29453,7 +31988,7 @@ paths: type: string release: allOf: - - &712 + - &713 title: Release description: A release. type: object @@ -29535,7 +32070,7 @@ paths: author: *4 assets: type: array - items: &713 + items: &714 title: Release Asset description: Data related to a release. type: object @@ -33242,14 +35777,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &465 + - &466 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &466 + - &467 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -33311,7 +35846,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &471 + '301': &472 description: Moved permanently content: application/json: @@ -33333,7 +35868,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &686 + - &687 name: all description: If `true`, show notifications marked as read. in: query @@ -33341,7 +35876,7 @@ paths: schema: type: boolean default: false - - &687 + - &688 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -33351,7 +35886,7 @@ paths: type: boolean default: false - *224 - - &688 + - &689 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -33950,7 +36485,7 @@ paths: - url - subscription_url examples: - default: &689 + default: &690 value: - id: '1' repository: @@ -34731,7 +37266,7 @@ paths: type: array items: *152 examples: - default: &695 + default: &696 value: - property_name: environment value: production @@ -34781,7 +37316,7 @@ paths: required: - properties examples: - default: &696 + default: &697 value: properties: - property_name: environment @@ -35662,7 +38197,7 @@ paths: type: integer repository_cache_usages: type: array - items: &478 + items: &479 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -38979,7 +41514,7 @@ paths: description: Response content: application/json: - schema: &498 + schema: &499 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -39014,7 +41549,7 @@ paths: - key_id - key examples: - default: &499 + default: &500 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -39427,7 +41962,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-organization-variables parameters: - *87 - - &483 + - &484 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -40202,6 +42737,10 @@ paths: If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. If no existing records match, new records will be created. + Note: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments + array resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use + the artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can + only have one name and version. tags: - orgs operationId: orgs/set-cluster-deployment-records @@ -40244,24 +42783,18 @@ paths: properties: name: type: string - description: | - The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name parameter must also be identical across all entries. + description: The name of the artifact. minLength: 1 maxLength: 256 digest: type: string - description: | - The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name and version parameters must also be identical across all entries. + description: The hex encoded digest of the artifact. minLength: 71 maxLength: 71 pattern: "^sha256:[a-f0-9]{64}$" version: type: string - description: | - The artifact version. Note that if multiple deployments have identical 'digest' parameter values, - the version parameter must also be identical across all entries. + description: The artifact version. maxLength: 100 x-multi-segment: true examples: @@ -40738,12 +43271,12 @@ paths: required: - subject_digests examples: - default: &830 + default: &831 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &831 + withPredicateType: &832 value: subject_digests: - sha256:abc123 @@ -40788,7 +43321,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &832 + default: &833 value: attestations_subject_digests: - sha256:abc: @@ -41121,7 +43654,7 @@ paths: initiator: type: string examples: - default: &512 + default: &513 value: attestations: - bundle: @@ -42043,7 +44576,7 @@ paths: be returned. in: query required: false - schema: &537 + schema: &538 type: string description: Severity of a code scanning alert. enum: @@ -43145,7 +45678,7 @@ paths: machine: anyOf: - type: 'null' - - &569 + - &570 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -44097,7 +46630,7 @@ paths: - updated_at - visibility examples: - default: &570 + default: &571 value: total_count: 2 secrets: @@ -44135,7 +46668,7 @@ paths: description: Response content: application/json: - schema: &571 + schema: &572 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -44170,7 +46703,7 @@ paths: - key_id - key examples: - default: &572 + default: &573 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -44202,7 +46735,7 @@ paths: application/json: schema: *321 examples: - default: &574 + default: &575 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -48353,7 +50886,7 @@ paths: description: Response content: application/json: - schema: &602 + schema: &603 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -48372,7 +50905,7 @@ paths: - key_id - key examples: - default: &603 + default: &604 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -48698,7 +51231,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *87 - - &612 + - &613 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -48706,7 +51239,7 @@ paths: required: false schema: type: string - - &613 + - &614 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -48714,7 +51247,7 @@ paths: required: false schema: type: string - - &614 + - &615 name: time_period description: |- The time period to filter by. @@ -48730,7 +51263,7 @@ paths: - week - month default: month - - &615 + - &616 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -48755,7 +51288,7 @@ paths: application/json: schema: type: array - items: &616 + items: &617 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -48918,7 +51451,7 @@ paths: examples: - https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &617 + default: &618 value: - id: 21 number: 42 @@ -49020,7 +51553,7 @@ paths: application/json: schema: type: array - items: &618 + items: &619 title: Dependabot alert dismissal request description: Alert dismissal request made by a user asking to dismiss a Dependabot alert. @@ -49143,7 +51676,7 @@ paths: examples: - https://github.com/octo-org/smile/security/dependabot/1 examples: - default: &619 + default: &620 value: - id: 21 number: 42 @@ -49531,7 +52064,7 @@ paths: description: Response content: application/json: - schema: &462 + schema: &463 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -49621,7 +52154,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &463 + default: &464 value: group_id: '123' group_name: Octocat admins @@ -49676,7 +52209,7 @@ paths: description: Response content: application/json: - schema: &459 + schema: &460 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -49716,7 +52249,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &460 + default: &461 value: groups: - group_id: '123' @@ -51228,7 +53761,7 @@ paths: required: true content: application/json: - schema: &650 + schema: &651 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -52565,7 +55098,7 @@ paths: application/json: schema: *385 examples: - default: &568 + default: &569 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -53828,7 +56361,7 @@ paths: parameters: - *87 - *391 - - &812 + - &813 name: repo_name description: repo_name parameter in: path @@ -55063,7 +57596,7 @@ paths: - nuget - container - *87 - - &813 + - &814 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -55104,7 +57637,7 @@ paths: default: *396 '403': *27 '401': *23 - '400': &815 + '400': &816 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -56441,6 +58974,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -56511,6 +59045,15 @@ paths: api_host: description: The Cloudsmith API host. type: string + workload_identity_provider: + description: The full resource name of the GCP Workload + Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + type: string + service_account: + description: The GCP service account email to impersonate. + If omitted, the federated token is used directly (direct + WIF). + type: string created_at: type: string format: date-time @@ -56548,7 +59091,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -56642,7 +59185,477 @@ paths: auth_type: description: The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, - or `oidc_cloudsmith` for OIDC authentication. + `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication. + type: string + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + - oidc_cloudsmith + - oidc_gcp + tenant_id: + description: The tenant ID of the Azure AD application. Required + when `auth_type` is `oidc_azure`. + type: string + client_id: + description: The client ID of the Azure AD application. Required + when `auth_type` is `oidc_azure`. + type: string + aws_region: + description: The AWS region. Required when `auth_type` is `oidc_aws`. + type: string + account_id: + description: The AWS account ID. Required when `auth_type` is `oidc_aws`. + type: string + role_name: + description: The AWS IAM role name. Required when `auth_type` is + `oidc_aws`. + type: string + domain: + description: The CodeArtifact domain. Required when `auth_type` + is `oidc_aws`. + type: string + domain_owner: + description: The CodeArtifact domain owner (AWS account ID). Required + when `auth_type` is `oidc_aws`. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. Required when `auth_type` + is `oidc_jfrog`. + type: string + audience: + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and `oidc_gcp`, and required for `oidc_cloudsmith` auth types. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. Optional for `oidc_jfrog` + auth type. + type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + Required when `auth_type` is `oidc_gcp`. + type: string + service_account: + description: The GCP service account email to impersonate. Optional + for `oidc_gcp` auth type. If omitted, the federated token is used + directly (direct WIF). + type: string + required: + - registry_type + - url + - visibility + examples: + org-private-registry-with-private-visibility: + summary: Example of a private registry configuration with private + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + replaces_base: true + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: private + org-private-registry-with-selected-visibility: + summary: Example of a private registry configuration with selected + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + org-private-registry-with-oidc-azure: + summary: Example of an OIDC private registry configuration using Azure + value: + registry_type: docker_registry + url: https://myregistry.azurecr.io + auth_type: oidc_azure + visibility: all + tenant_id: 12345678-1234-1234-1234-123456789012 + client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org + org-private-registry-with-oidc-gcp: + summary: Example of an OIDC private registry configuration using Google + Cloud Artifact Registry + value: + registry_type: docker_registry + url: https://us-docker.pkg.dev/my-project/my-repo + auth_type: oidc_gcp + visibility: all + workload_identity_provider: projects/123456789/locations/global/workloadIdentityPools/github-pool/providers/github-provider + service_account: dependabot@my-project.iam.gserviceaccount.com + responses: + '201': + description: The organization private registry configuration + content: + application/json: + schema: + title: Organization private registry + description: Private registry configuration for an organization + type: object + properties: + name: + description: The name of the private registry configuration. + type: string + examples: + - MAVEN_REPOSITORY_SECRET + registry_type: + description: The registry type. + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + type: string + auth_type: + description: The authentication type for the private registry. + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + - oidc_cloudsmith + - oidc_gcp + type: string + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the + private registry. + type: string + examples: + - monalisa + replaces_base: + description: Whether this private registry replaces the base registry + (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, + Dependabot will only use this registry and will not fall back + to the public registry. When `false` (default), Dependabot will + use this registry for scoped packages but may fall back to the + public registry for other packages. + type: boolean + default: false + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + enum: + - all + - private + - selected + type: string + selected_repository_ids: + type: array + description: An array of repository IDs that can access the organization + private registry when `visibility` is set to `selected`. + items: + type: integer + tenant_id: + description: The tenant ID of the Azure AD application. + type: string + client_id: + description: The client ID of the Azure AD application. + type: string + aws_region: + description: The AWS region. + type: string + account_id: + description: The AWS account ID. + type: string + role_name: + description: The AWS IAM role name. + type: string + domain: + description: The CodeArtifact domain. + type: string + domain_owner: + description: The CodeArtifact domain owner. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. + type: string + audience: + description: The OIDC audience. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. + type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + type: string + service_account: + description: The GCP service account email to impersonate. If + omitted, the federated token is used directly (direct WIF). + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - registry_type + - visibility + - created_at + - updated_at + examples: + org-private-registry-with-selected-visibility: &410 + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: private + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + org-private-registry-with-private-visibility: + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/public-key": + get: + summary: Get private registries public key for an organization + description: |2- + + Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization + parameters: + - *87 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - key_id + - key + properties: + key_id: + description: The identifier for the key. + type: string + examples: + - '012345678912345678' + key: + description: The Base64 encoded public key. + type: string + examples: + - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + examples: + default: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + headers: + Link: *45 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/{secret_name}": + get: + summary: Get a private registry for an organization + description: |2- + + Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization + parameters: + - *87 + - *288 + responses: + '200': + description: The specified private registry configuration for the organization + content: + application/json: + schema: *409 + examples: + default: *410 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + patch: + summary: Update a private registry for an organization + description: |2- + + Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/update-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization + parameters: + - *87 + - *288 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + registry_type: + description: The registry type. + type: string + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the private + registry. This field should be omitted if the private registry + does not require a username for authentication. + type: + - string + - 'null' + replaces_base: + description: Whether this private registry should replace the base + registry (e.g., npmjs.org for npm, rubygems.org for rubygems). + When set to `true`, Dependabot will only use this registry and + will not fall back to the public registry. When set to `false` + (default), Dependabot will use this registry for scoped packages + but may fall back to the public registry for other packages. + type: boolean + default: false + encrypted_value: + description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get private registries + public key for an organization](https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + endpoint. + type: string + pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + key_id: + description: The ID of the key you used to encrypt the secret. + type: string + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + type: string + enum: + - all + - private + - selected + selected_repository_ids: + description: An array of repository IDs that can access the organization + private registry. You can only provide a list of repository IDs + when `visibility` is set to `selected`. This field should be omitted + if `visibility` is set to `all` or `private`. + type: array + items: + type: integer + auth_type: + description: The authentication type for the private registry. This + field cannot be changed after creation. If provided, it must match + the existing `auth_type` of the configuration. To change the authentication + type, delete and recreate the configuration. type: string enum: - token @@ -56651,6 +59664,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -56683,7 +59697,7 @@ paths: type: string audience: description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, - and required for `oidc_cloudsmith` auth types. + and `oidc_gcp`, and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` @@ -56701,445 +59715,15 @@ paths: description: The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default. type: string - required: - - registry_type - - url - - visibility - examples: - org-private-registry-with-private-visibility: - summary: Example of a private registry configuration with private - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - replaces_base: true - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: private - org-private-registry-with-selected-visibility: - summary: Example of a private registry configuration with selected - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - org-private-registry-with-oidc-azure: - summary: Example of an OIDC private registry configuration using Azure - value: - registry_type: docker_registry - url: https://myregistry.azurecr.io - auth_type: oidc_azure - visibility: all - tenant_id: 12345678-1234-1234-1234-123456789012 - client_id: abcdef01-2345-6789-abcd-ef0123456789 - org-private-registry-with-oidc-cloudsmith: - summary: Example of an OIDC private registry configuration using Cloudsmith - value: - registry_type: npm_registry - url: https://npm.cloudsmith.io/my-org/my-repo/ - auth_type: oidc_cloudsmith - visibility: all - namespace: my-org - service_slug: my-service-account - audience: https://github.com/my-org - responses: - '201': - description: The organization private registry configuration - content: - application/json: - schema: - title: Organization private registry - description: Private registry configuration for an organization - type: object - properties: - name: - description: The name of the private registry configuration. - type: string - examples: - - MAVEN_REPOSITORY_SECRET - registry_type: - description: The registry type. - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - type: string - auth_type: - description: The authentication type for the private registry. - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - - oidc_cloudsmith - type: string - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with the - private registry. - type: string - examples: - - monalisa - replaces_base: - description: Whether this private registry replaces the base registry - (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, - Dependabot will only use this registry and will not fall back - to the public registry. When `false` (default), Dependabot will - use this registry for scoped packages but may fall back to the - public registry for other packages. - type: boolean - default: false - visibility: - description: Which type of organization repositories have access - to the private registry. `selected` means only the repositories - specified by `selected_repository_ids` can access the private - registry. - enum: - - all - - private - - selected - type: string - selected_repository_ids: - type: array - description: An array of repository IDs that can access the organization - private registry when `visibility` is set to `selected`. - items: - type: integer - tenant_id: - description: The tenant ID of the Azure AD application. - type: string - client_id: - description: The client ID of the Azure AD application. - type: string - aws_region: - description: The AWS region. - type: string - account_id: - description: The AWS account ID. - type: string - role_name: - description: The AWS IAM role name. - type: string - domain: - description: The CodeArtifact domain. - type: string - domain_owner: - description: The CodeArtifact domain owner. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. - type: string - audience: - description: The OIDC audience. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. - type: string - namespace: - description: The Cloudsmith organization namespace. - type: string - service_slug: - description: The Cloudsmith service account slug. - type: string - api_host: - description: The Cloudsmith API host. - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - name - - registry_type - - visibility - - created_at - - updated_at - examples: - org-private-registry-with-selected-visibility: &410 - value: - name: MAVEN_REPOSITORY_SECRET - registry_type: maven_repository - username: monalisa - visibility: private - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - org-private-registry-with-private-visibility: - value: - name: MAVEN_REPOSITORY_SECRET - registry_type: maven_repository - username: monalisa - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/public-key": - get: - summary: Get private registries public key for an organization - description: |2- - - Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization - parameters: - - *87 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - key_id - - key - properties: - key_id: - description: The identifier for the key. - type: string - examples: - - '012345678912345678' - key: - description: The Base64 encoded public key. - type: string - examples: - - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - examples: - default: - value: - key_id: '012345678912345678' - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - headers: - Link: *45 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/{secret_name}": - get: - summary: Get a private registry for an organization - description: |2- - - Get the configuration of a single private registry defined for an organization, omitting its encrypted value. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization - parameters: - - *87 - - *288 - responses: - '200': - description: The specified private registry configuration for the organization - content: - application/json: - schema: *409 - examples: - default: *410 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - patch: - summary: Update a private registry for an organization - description: |2- - - Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/update-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization - parameters: - - *87 - - *288 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - registry_type: - description: The registry type. - type: string - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with the private - registry. This field should be omitted if the private registry - does not require a username for authentication. - type: - - string - - 'null' - replaces_base: - description: Whether this private registry should replace the base - registry (e.g., npmjs.org for npm, rubygems.org for rubygems). - When set to `true`, Dependabot will only use this registry and - will not fall back to the public registry. When set to `false` - (default), Dependabot will use this registry for scoped packages - but may fall back to the public registry for other packages. - type: boolean - default: false - encrypted_value: - description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get private registries - public key for an organization](https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) - endpoint. + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + Required when `auth_type` is `oidc_gcp`. type: string - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - description: The ID of the key you used to encrypt the secret. - type: string - visibility: - description: Which type of organization repositories have access - to the private registry. `selected` means only the repositories - specified by `selected_repository_ids` can access the private - registry. - type: string - enum: - - all - - private - - selected - selected_repository_ids: - description: An array of repository IDs that can access the organization - private registry. You can only provide a list of repository IDs - when `visibility` is set to `selected`. This field should be omitted - if `visibility` is set to `all` or `private`. - type: array - items: - type: integer - auth_type: - description: The authentication type for the private registry. This - field cannot be changed after creation. If provided, it must match - the existing `auth_type` of the configuration. To change the authentication - type, delete and recreate the configuration. - type: string - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - - oidc_cloudsmith - tenant_id: - description: The tenant ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - client_id: - description: The client ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - aws_region: - description: The AWS region. Required when `auth_type` is `oidc_aws`. - type: string - account_id: - description: The AWS account ID. Required when `auth_type` is `oidc_aws`. - type: string - role_name: - description: The AWS IAM role name. Required when `auth_type` is - `oidc_aws`. - type: string - domain: - description: The CodeArtifact domain. Required when `auth_type` - is `oidc_aws`. - type: string - domain_owner: - description: The CodeArtifact domain owner (AWS account ID). Required - when `auth_type` is `oidc_aws`. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. Required when `auth_type` - is `oidc_jfrog`. - type: string - audience: - description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, - and required for `oidc_cloudsmith` auth types. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. Optional for `oidc_jfrog` - auth type. - type: string - namespace: - description: The Cloudsmith organization namespace. Required when - `auth_type` is `oidc_cloudsmith`. - type: string - service_slug: - description: The Cloudsmith service account slug. Required when - `auth_type` is `oidc_cloudsmith`. - type: string - api_host: - description: The Cloudsmith API host. Optional for `oidc_cloudsmith` - auth type. If omitted, `api.cloudsmith.io` is used by default. + service_account: + description: The GCP service account email to impersonate. Optional + for `oidc_gcp` auth type. If omitted, the federated token is used + directly (direct WIF). type: string examples: secret-based-update: @@ -57295,7 +59879,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &903 + - &904 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -57569,7 +60153,7 @@ paths: content: oneOf: - *219 - - &583 + - &584 title: Pull Request Simple description: Pull Request Simple type: object @@ -57798,7 +60382,7 @@ paths: - review_comment - self author_association: *216 - auto_merge: &698 + auto_merge: &699 title: Auto merge description: The status of auto merging a pull request. type: @@ -58181,7 +60765,7 @@ paths: - updated_at - project_url examples: - default: &836 + default: &837 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -58358,7 +60942,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &837 + items: &838 type: object properties: name: @@ -58395,7 +60979,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &838 + iteration_configuration: &839 type: object description: The configuration for iteration fields. properties: @@ -58445,7 +61029,7 @@ paths: value: name: Due date data_type: date - single_select_field: &839 + single_select_field: &840 summary: Create a single select field value: name: Priority @@ -58472,7 +61056,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &840 + iteration_field: &841 summary: Create an iteration field value: name: Sprint @@ -58498,7 +61082,7 @@ paths: application/json: schema: *416 examples: - text_field: &841 + text_field: &842 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -58507,7 +61091,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &842 + number_field: &843 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -58516,7 +61100,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &843 + date_field: &844 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -58525,7 +61109,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &844 + single_select_field: &845 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -58559,7 +61143,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &845 + iteration_field: &846 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -58605,7 +61189,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-organization parameters: - *413 - - &846 + - &847 name: field_id description: The unique identifier of the field. in: path @@ -58620,7 +61204,7 @@ paths: application/json: schema: *416 examples: - default: &847 + default: &848 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -59831,7 +62415,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &827 + schema: &828 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -60014,7 +62598,7 @@ paths: parameters: - *413 - *87 - - &848 + - &849 name: view_number description: The number that identifies the project view. in: path @@ -60784,7 +63368,7 @@ paths: description: Response content: application/json: - schema: &470 + schema: &471 title: Full Repository description: Full Repository type: object @@ -61254,7 +63838,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &588 + code_of_conduct: &589 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -61368,7 +63952,7 @@ paths: - network_count - subscribers_count examples: - default: &472 + default: &473 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -61921,7 +64505,7 @@ paths: - *87 - *17 - *19 - - &720 + - &721 name: targets description: | A comma-separated list of rule targets to filter by. @@ -62138,7 +64722,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *87 - - &722 + - &723 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -62150,14 +64734,14 @@ paths: x-multi-segment: true - *304 - *105 - - &723 + - &724 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &724 + - &725 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -62177,7 +64761,7 @@ paths: description: Response content: application/json: - schema: &725 + schema: &726 title: Rule Suites description: Response type: array @@ -62233,7 +64817,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &726 + default: &727 value: - id: 21 actor_id: 12 @@ -62277,7 +64861,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *87 - - &727 + - &728 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -62293,7 +64877,7 @@ paths: description: Response content: application/json: - schema: &728 + schema: &729 title: Rule Suite description: Response type: object @@ -62400,7 +64984,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &729 + default: &730 value: id: 21 actor_id: 12 @@ -62736,7 +65320,7 @@ paths: - *110 - *19 - *17 - - &731 + - &732 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -62746,7 +65330,7 @@ paths: required: false schema: type: string - - &732 + - &733 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -62760,6 +65344,7 @@ paths: - *442 - *443 - *444 + - *445 responses: '200': description: Response @@ -62767,9 +65352,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *446 + default: *447 headers: Link: *45 '404': *6 @@ -62804,9 +65389,9 @@ paths: description: Response content: application/json: - schema: *447 + schema: *448 examples: - default: *448 + default: *449 '403': *27 '404': *6 patch: @@ -62959,7 +65544,7 @@ paths: application/json: schema: type: array - items: &753 + items: &754 description: A repository security advisory. type: object properties: @@ -63182,7 +65767,7 @@ paths: login: type: string description: The username of the user credited. - type: *449 + type: *450 credits_detailed: type: - array @@ -63193,7 +65778,7 @@ paths: type: object properties: user: *4 - type: *449 + type: *450 state: type: string description: The state of the user's acceptance of the @@ -63256,7 +65841,7 @@ paths: - private_fork additionalProperties: false examples: - default: &754 + default: &755 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -63742,7 +66327,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *87 - - *450 + - *451 - *17 - *19 responses: @@ -63750,9 +66335,9 @@ paths: description: Success content: application/json: - schema: *451 + schema: *452 examples: - default: *452 + default: *453 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -64035,7 +66620,7 @@ paths: type: array items: *145 examples: - default: *453 + default: *454 headers: Link: *45 x-github: @@ -64264,15 +66849,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - *87 - - *454 + - *455 responses: '200': description: Response content: application/json: - schema: *455 + schema: *456 examples: - default: *456 + default: *457 headers: Link: *45 x-github: @@ -64310,7 +66895,7 @@ paths: description: Response content: application/json: - schema: &467 + schema: &468 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -64362,7 +66947,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &468 + default: &469 value: groups: - group_id: '123' @@ -64574,7 +67159,7 @@ paths: description: Response content: application/json: - schema: &457 + schema: &458 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -64973,7 +67558,7 @@ paths: - repos_count - organization examples: - default: &458 + default: &459 value: id: 1 node_id: MDQ6VGVhbTE= @@ -65050,9 +67635,9 @@ paths: description: Response content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 '404': *6 x-github: githubCloudOnly: false @@ -65137,16 +67722,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 '201': description: Response content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 '404': *6 '422': *15 '403': *27 @@ -65176,7 +67761,7 @@ paths: responses: '204': description: Response - '422': &461 + '422': &462 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -65205,10 +67790,10 @@ paths: description: Response content: application/json: - schema: *459 + schema: *460 examples: - default: *460 - '422': *461 + default: *461 + '422': *462 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -65252,10 +67837,10 @@ paths: description: Response content: application/json: - schema: *462 + schema: *463 examples: - default: *463 - '422': *461 + default: *464 + '422': *462 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -65279,7 +67864,7 @@ paths: responses: '204': description: Response - '422': *461 + '422': *462 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -65316,7 +67901,7 @@ paths: default: *375 headers: Link: *45 - '422': *461 + '422': *462 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65398,7 +67983,7 @@ paths: description: Response content: application/json: - schema: &464 + schema: &465 title: Team Membership description: Team Membership type: object @@ -65426,7 +68011,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &795 + response-if-user-is-a-team-maintainer: &796 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -65489,9 +68074,9 @@ paths: description: Response content: application/json: - schema: *464 + schema: *465 examples: - response-if-users-membership-with-team-is-now-pending: &796 + response-if-users-membership-with-team-is-now-pending: &797 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -65598,14 +68183,14 @@ paths: parameters: - *87 - *214 - - *465 - *466 + - *467 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &797 + schema: &798 title: Team Repository description: A team's access to a repository. type: object @@ -66240,8 +68825,8 @@ paths: parameters: - *87 - *214 - - *465 - *466 + - *467 requestBody: required: false content: @@ -66288,8 +68873,8 @@ paths: parameters: - *87 - *214 - - *465 - *466 + - *467 responses: '204': description: Response @@ -66322,10 +68907,10 @@ paths: description: Response content: application/json: - schema: *467 + schema: *468 examples: - default: *468 - '422': *461 + default: *469 + '422': *462 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -66391,7 +68976,7 @@ paths: description: Response content: application/json: - schema: *467 + schema: *468 examples: default: value: @@ -66403,7 +68988,7 @@ paths: group_name: Octocat docs members group_description: The people who make your octoworld come to life. - '422': *461 + '422': *462 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -66437,7 +69022,7 @@ paths: type: array items: *307 examples: - response-if-child-teams-exist: &798 + response-if-child-teams-exist: &799 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -66591,7 +69176,7 @@ paths: resources: type: object properties: - core: &469 + core: &470 title: Rate Limit type: object properties: @@ -66608,17 +69193,17 @@ paths: - remaining - reset - used - graphql: *469 - search: *469 - code_search: *469 - source_import: *469 - integration_manifest: *469 - code_scanning_upload: *469 - actions_runner_registration: *469 - scim: *469 - dependency_snapshots: *469 - dependency_sbom: *469 - code_scanning_autofix: *469 + graphql: *470 + search: *470 + code_search: *470 + source_import: *470 + integration_manifest: *470 + code_scanning_upload: *470 + actions_runner_registration: *470 + scim: *470 + dependency_snapshots: *470 + dependency_sbom: *470 + code_scanning_autofix: *470 required: - core - search @@ -66720,14 +69305,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *470 + schema: *471 examples: default-response: summary: Default response @@ -67235,7 +69820,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *471 + '301': *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67253,8 +69838,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#update-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: false content: @@ -67563,10 +70148,10 @@ paths: description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: *472 - '307': &473 + default: *473 + '307': &474 description: Temporary Redirect content: application/json: @@ -67595,8 +70180,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -67618,7 +70203,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository - '307': *473 + '307': *474 '404': *6 '409': *119 x-github: @@ -67642,11 +70227,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *465 - *466 + - *467 - *17 - *19 - - &490 + - &491 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -67669,7 +70254,7 @@ paths: type: integer artifacts: type: array - items: &474 + items: &475 title: Artifact description: An artifact type: object @@ -67764,7 +70349,7 @@ paths: - expires_at - updated_at examples: - default: &491 + default: &492 value: total_count: 2 artifacts: @@ -67825,9 +70410,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#get-an-artifact parameters: - - *465 - *466 - - &475 + - *467 + - &476 name: artifact_id description: The unique identifier of the artifact. in: path @@ -67839,7 +70424,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *475 examples: default: value: @@ -67877,9 +70462,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#delete-an-artifact parameters: - - *465 - *466 - - *475 + - *467 + - *476 responses: '204': description: Response @@ -67903,9 +70488,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#download-an-artifact parameters: - - *465 - *466 - - *475 + - *467 + - *476 - name: archive_format in: path required: true @@ -67915,11 +70500,11 @@ paths: '302': description: Response headers: - Location: &605 + Location: &606 example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &653 + '410': &654 description: Gone content: application/json: @@ -67944,14 +70529,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: &476 + schema: &477 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -67985,13 +70570,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: application/json: - schema: *476 + schema: *477 examples: selected_actions: *42 responses: @@ -68020,14 +70605,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: &477 + schema: &478 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -68061,13 +70646,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: application/json: - schema: *477 + schema: *478 examples: selected_actions: *44 responses: @@ -68098,14 +70683,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *478 + schema: *479 examples: default: value: @@ -68131,11 +70716,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *465 - *466 + - *467 - *17 - *19 - - &479 + - &480 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -68169,7 +70754,7 @@ paths: description: Response content: application/json: - schema: &480 + schema: &481 title: Repository actions caches description: Repository actions caches type: object @@ -68219,7 +70804,7 @@ paths: - total_count - actions_caches examples: - default: &481 + default: &482 value: total_count: 1 actions_caches: @@ -68251,23 +70836,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *465 - *466 + - *467 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *479 + - *480 responses: '200': description: Response content: application/json: - schema: *480 + schema: *481 examples: - default: *481 + default: *482 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68287,8 +70872,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *465 - *466 + - *467 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -68303,6 +70888,245 @@ paths: enabledForGitHubApps: true category: actions subcategory: cache + "/repos/{owner}/{repo}/actions/concurrency_groups": + get: + summary: List concurrency groups for a repository + description: |- + Lists the active concurrency groups for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-concurrency-groups-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository + parameters: + - *466 + - *467 + - *17 + - *109 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Concurrency Group List + description: A list of active concurrency groups for a repository. + type: object + required: + - total_count + - concurrency_groups + properties: + total_count: + type: integer + concurrency_groups: + type: array + items: + type: object + required: + - group_name + - group_url + - last_acquired_at + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: API URL for this concurrency group. + last_acquired_at: + type: + - string + - 'null' + format: date-time + examples: + default: + value: + total_count: 2 + concurrency_groups: + - group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + last_acquired_at: '2026-01-15T16:14:23Z' + - group_name: ci-build + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build + last_acquired_at: '2026-01-15T16:13:55Z' + headers: + Link: *45 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups + "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}": + get: + summary: Get a concurrency group for a repository + description: |- + Gets a specific concurrency group for a repository, including all instances in the group's queue. + Returns 404 if the group is inactive or does not exist. + + Optionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items + ahead of the specified workflow run or job in the queue, plus the specified item itself + (returned as the last element). This is useful for determining what is blocking a particular + run or job. Returns 422 if the specified run or job is not in this concurrency group. + + When using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow + leases held on behalf of that run. Job-level leases within the run are not considered to + block the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow + leases on the job's ancestor paths. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-concurrency-group-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository + parameters: + - *466 + - *467 + - name: concurrency_group_name + description: The name of the concurrency group. + in: path + required: true + schema: + type: string + - name: ahead_of_run + description: |- + Filter to items ahead of this workflow run ID in the queue, plus the run itself. + Matches workflow-level concurrency and reusable-workflow leases held on behalf of + the run. Mutually exclusive with `ahead_of_job`. + in: query + required: false + schema: + type: integer + minimum: 1 + - name: ahead_of_job + description: |- + Filter to items ahead of this job ID in the queue, plus the job itself. + Matches job-level concurrency and reusable-workflow leases on the job's + ancestor paths. Mutually exclusive with `ahead_of_run`. + in: query + required: false + schema: + type: integer + minimum: 1 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Concurrency Group + description: |- + A concurrency group with the workflow runs and jobs that are either currently holding + or waiting for the concurrency group lease. + type: object + required: + - group_name + - group_url + - total_count + - group_members + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: API URL for this concurrency group. + total_count: + type: integer + group_members: + type: array + items: + type: object + required: + - run_id + - run_name + - run_url + - run_html_url + - status + properties: + run_id: + type: integer + description: The ID of the workflow run. + run_name: + type: string + description: The name of the workflow run. + run_url: + type: + - string + - 'null' + format: uri + description: API URL for the workflow run. + run_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the workflow run. + job_id: + type: integer + description: The ID of the job, when the item represents + a job-level or reusable-workflow-level lease. + job_name: + type: string + description: The display name of the job, when the item + represents a job-level or reusable-workflow-level lease. + job_url: + type: + - string + - 'null' + format: uri + description: API URL for the job. + job_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the job. + status: + type: string + enum: + - in_progress + - pending + examples: + default: + value: + group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + total_count: 3 + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: in_progress + - run_id: 30433643 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433643 + status: pending + - run_id: 30433644 + run_name: Deploy hotfix + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433644 + job_id: 798245260 + job_name: deploy + job_url: https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260 + job_html_url: https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260 + status: pending + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups "/repos/{owner}/{repo}/actions/jobs/{job_id}": get: summary: Get a job for a workflow run @@ -68319,9 +71143,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *465 - *466 - - &482 + - *467 + - &483 name: job_id description: The unique identifier of the job. in: path @@ -68333,7 +71157,7 @@ paths: description: Response content: application/json: - schema: &494 + schema: &495 title: Job description: Information of a job execution in a workflow run type: object @@ -68680,9 +71504,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *465 - *466 - - *482 + - *467 + - *483 responses: '302': description: Response @@ -68710,9 +71534,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *465 - *466 - - *482 + - *467 + - *483 requestBody: required: false content: @@ -68758,8 +71582,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Status response @@ -68818,8 +71642,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -68887,8 +71711,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-organization-secrets parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -68906,7 +71730,7 @@ paths: type: integer secrets: type: array - items: &496 + items: &497 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -68927,7 +71751,7 @@ paths: - created_at - updated_at examples: - default: &497 + default: &498 value: total_count: 2 secrets: @@ -68960,9 +71784,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-organization-variables parameters: - - *465 - *466 - - *483 + - *467 + - *484 - *19 responses: '200': @@ -68979,7 +71803,7 @@ paths: type: integer variables: type: array - items: &500 + items: &501 title: Actions Variable type: object properties: @@ -69013,7 +71837,7 @@ paths: - created_at - updated_at examples: - default: &501 + default: &502 value: total_count: 2 variables: @@ -69046,8 +71870,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -69056,7 +71880,7 @@ paths: schema: type: object properties: - enabled: &484 + enabled: &485 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *60 @@ -69091,8 +71915,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -69103,7 +71927,7 @@ paths: schema: type: object properties: - enabled: *484 + enabled: *485 allowed_actions: *60 sha_pinning_required: *61 required: @@ -69136,14 +71960,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: &485 + schema: &486 type: object properties: access_level: @@ -69161,7 +71985,7 @@ paths: required: - access_level examples: - default: &486 + default: &487 value: access_level: organization x-github: @@ -69186,15 +72010,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: application/json: - schema: *485 + schema: *486 examples: - default: *486 + default: *487 responses: '204': description: Response @@ -69218,8 +72042,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -69249,8 +72073,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Empty response for successful settings update @@ -69284,8 +72108,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -69312,8 +72136,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -69347,8 +72171,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -69376,8 +72200,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -69408,8 +72232,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -69440,8 +72264,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -69473,8 +72297,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -69503,8 +72327,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Success response @@ -69544,8 +72368,8 @@ paths: in: query schema: type: string - - *465 - *466 + - *467 - *17 - *19 responses: @@ -69589,8 +72413,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -69622,8 +72446,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -69697,8 +72521,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *465 - *466 + - *467 responses: '201': description: Response @@ -69734,8 +72558,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *465 - *466 + - *467 responses: '201': description: Response @@ -69765,8 +72589,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *465 - *466 + - *467 - *75 responses: '200': @@ -69796,8 +72620,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *465 - *466 + - *467 - *75 responses: '204': @@ -69824,8 +72648,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *465 - *466 + - *467 - *75 responses: '200': *81 @@ -69850,8 +72674,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *465 - *466 + - *467 - *75 requestBody: required: true @@ -69900,8 +72724,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *465 - *466 + - *467 - *75 requestBody: required: true @@ -69951,8 +72775,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *465 - *466 + - *467 - *75 responses: '200': *285 @@ -69982,8 +72806,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *465 - *466 + - *467 - *75 - *286 responses: @@ -70013,9 +72837,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *465 - *466 - - &504 + - *467 + - &505 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -70023,7 +72847,7 @@ paths: required: false schema: type: string - - &505 + - &506 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -70031,7 +72855,7 @@ paths: required: false schema: type: string - - &506 + - &507 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -70040,7 +72864,7 @@ paths: required: false schema: type: string - - &507 + - &508 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -70067,7 +72891,7 @@ paths: - pending - *17 - *19 - - &508 + - &509 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -70076,7 +72900,7 @@ paths: schema: type: string format: date-time - - &487 + - &488 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -70085,13 +72909,13 @@ paths: schema: type: boolean default: false - - &509 + - &510 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &510 + - &511 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -70114,7 +72938,7 @@ paths: type: integer workflow_runs: type: array - items: &488 + items: &489 title: Workflow Run description: An invocation of a workflow type: object @@ -70292,7 +73116,7 @@ paths: head_commit: anyOf: - type: 'null' - - &532 + - &533 title: Simple Commit description: A commit. type: object @@ -70407,7 +73231,7 @@ paths: - workflow_url - pull_requests examples: - default: &511 + default: &512 value: total_count: 1 workflow_runs: @@ -70643,24 +73467,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *465 - *466 - - &489 + - *467 + - &490 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *487 + - *488 responses: '200': description: Response content: application/json: - schema: *488 + schema: *489 examples: - default: &492 + default: &493 value: id: 30433642 name: Build @@ -70901,9 +73725,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '204': description: Response @@ -70926,9 +73750,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '200': description: Response @@ -71056,9 +73880,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '201': description: Response @@ -71091,12 +73915,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *465 - *466 - - *489 + - *467 + - *490 - *17 - *19 - - *490 + - *491 - *110 responses: '200': @@ -71113,9 +73937,9 @@ paths: type: integer artifacts: type: array - items: *474 + items: *475 examples: - default: *491 + default: *492 headers: Link: *45 x-github: @@ -71139,25 +73963,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *465 - *466 - - *489 - - &493 + - *467 + - *490 + - &494 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *487 + - *488 responses: '200': description: Response content: application/json: - schema: *488 + schema: *489 examples: - default: *492 + default: *493 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71180,10 +74004,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *465 - *466 - - *489 - - *493 + - *467 + - *490 + - *494 - *17 - *19 responses: @@ -71201,9 +74025,9 @@ paths: type: integer jobs: type: array - items: *494 + items: *495 examples: - default: &495 + default: &496 value: total_count: 1 jobs: @@ -71316,10 +74140,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *465 - *466 - - *489 - - *493 + - *467 + - *490 + - *494 responses: '302': description: Response @@ -71347,9 +74171,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '202': description: Response @@ -71365,6 +74189,198 @@ paths: enabledForGitHubApps: true category: actions subcategory: workflow-runs + "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups": + get: + summary: List concurrency groups for a workflow run + description: |- + Lists all concurrency groups associated with a workflow run or its jobs. + + The set of groups is derived from the run's configuration, so a group is + included even when the run no longer has any items currently holding or + waiting in it. In that case the `group_members` array will be empty. + `total_count` reflects the number of groups the run participates in by + configuration, not the number with active items. + + This differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`, + which returns 404 when a group has no active items. That endpoint reports + the live state of a group repo-wide, while this endpoint reports the + groups associated with a specific run by configuration. + + Results are sorted by group name and support cursor-based pagination via + `before` and `after`. The `after` cursor paginates forward only and does + not emit a `rel="prev"` Link; use `before` to page backward from a + forward page's `next` cursor. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-concurrency-groups-for-workflow-run + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run + parameters: + - *466 + - *467 + - *490 + - *17 + - *108 + - *109 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Concurrency Group Run List + description: A list of concurrency groups associated with a workflow + run. + type: object + required: + - total_count + - concurrency_groups + properties: + total_count: + type: integer + description: |- + The total number of concurrency groups this workflow run participates in, + derived from the run's configuration. This count is not filtered by + whether the run currently holds or is waiting in each group, so it can + include groups whose `group_members` array is empty (for example, when + the run has already released its lease in that group). + concurrency_groups: + type: array + items: + type: object + required: + - group_name + - group_url + - group_members + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: |- + API URL for this concurrency group. May return 404 if the group + has no active items at the time it is requested, since the + get-by-name endpoint reports the live repo-wide state of a group + while this endpoint lists groups associated with a run by + configuration. + group_members: + type: array + description: |- + Items belonging to this workflow run that are either currently holding or + waiting for the concurrency group lease. May be empty if the run no + longer has any active or queued items in this group. + items: + type: object + required: + - run_id + - run_name + - run_url + - run_html_url + - status + - position + - position_url + properties: + run_id: + type: integer + description: The ID of the workflow run. + run_name: + type: string + description: The name of the workflow run. + run_url: + type: + - string + - 'null' + format: uri + description: API URL for the workflow run. + run_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the workflow run. + position: + type: integer + description: Queue position. 0 means the item holds + the concurrency lease (in_progress), 1 or higher + means queued (pending). + position_url: + type: string + format: uri + description: API URL to get items ahead of this item + in the concurrency group. + job_id: + type: + - integer + - 'null' + description: The ID of the job, when the item represents + a job-level or reusable-workflow-level lease. + job_name: + type: + - string + - 'null' + description: The display name of the job, when the + item represents a job-level or reusable-workflow-level + lease. + job_url: + type: + - string + - 'null' + format: uri + description: API URL for the job. + job_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the job. + status: + type: string + enum: + - in_progress + - pending + examples: + default: + value: + total_count: 2 + concurrency_groups: + - group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: in_progress + position: 0 + position_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642 + - group_name: ci-build + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: pending + position: 2 + position_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260 + job_id: 798245260 + job_name: build + job_url: https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260 + job_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260 + headers: + Link: *45 + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": post: summary: Review custom deployment protection rules for a workflow run @@ -71382,9 +74398,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 requestBody: required: true content: @@ -71451,9 +74467,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '202': description: Response @@ -71486,9 +74502,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -71518,9 +74534,9 @@ paths: type: integer jobs: type: array - items: *494 + items: *495 examples: - default: *495 + default: *496 headers: Link: *45 x-github: @@ -71545,9 +74561,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '302': description: Response @@ -71574,9 +74590,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '204': description: Response @@ -71603,9 +74619,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '200': description: Response @@ -71674,7 +74690,7 @@ paths: items: type: object properties: - type: &620 + type: &621 type: string description: The type of reviewer. enum: @@ -71760,9 +74776,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 requestBody: required: true content: @@ -71812,7 +74828,7 @@ paths: application/json: schema: type: array - items: &607 + items: &608 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -71924,7 +74940,7 @@ paths: - created_at - updated_at examples: - default: &608 + default: &609 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -71980,9 +74996,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *465 - *466 - - *489 + - *467 + - *490 requestBody: required: false content: @@ -72027,9 +75043,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 requestBody: required: false content: @@ -72084,9 +75100,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '200': description: Response @@ -72223,8 +75239,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-secrets parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -72242,9 +75258,9 @@ paths: type: integer secrets: type: array - items: *496 + items: *497 examples: - default: *497 + default: *498 headers: Link: *45 x-github: @@ -72269,16 +75285,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-public-key parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *498 + schema: *499 examples: - default: *499 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72300,17 +75316,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 responses: '200': description: Response content: application/json: - schema: *496 + schema: *497 examples: - default: &633 + default: &634 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -72336,8 +75352,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 requestBody: required: true @@ -72395,8 +75411,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 responses: '204': @@ -72422,9 +75438,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-variables parameters: - - *465 - *466 - - *483 + - *467 + - *484 - *19 responses: '200': @@ -72441,9 +75457,9 @@ paths: type: integer variables: type: array - items: *500 + items: *501 examples: - default: *501 + default: *502 headers: Link: *45 x-github: @@ -72466,8 +75482,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-a-repository-variable parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -72519,17 +75535,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-a-repository-variable parameters: - - *465 - *466 + - *467 - *291 responses: '200': description: Response content: application/json: - schema: *500 + schema: *501 examples: - default: &634 + default: &635 value: name: USERNAME value: octocat @@ -72555,8 +75571,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-a-repository-variable parameters: - - *465 - *466 + - *467 - *291 requestBody: required: true @@ -72599,8 +75615,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-a-repository-variable parameters: - - *465 - *466 + - *467 - *291 responses: '204': @@ -72626,8 +75642,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#list-repository-workflows parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -72645,7 +75661,7 @@ paths: type: integer workflows: type: array - items: &502 + items: &503 title: Workflow description: A GitHub Actions workflow type: object @@ -72763,9 +75779,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-a-workflow parameters: - - *465 - *466 - - &503 + - *467 + - &504 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -72780,7 +75796,7 @@ paths: description: Response content: application/json: - schema: *502 + schema: *503 examples: default: value: @@ -72813,9 +75829,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#disable-a-workflow parameters: - - *465 - *466 - - *503 + - *467 + - *504 responses: '204': description: Response @@ -72840,9 +75856,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *465 - *466 - - *503 + - *467 + - *504 responses: '200': description: Response including the workflow run ID and URLs. @@ -72922,9 +75938,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#enable-a-workflow parameters: - - *465 - *466 - - *503 + - *467 + - *504 responses: '204': description: Response @@ -72951,19 +75967,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *465 - *466 - - *503 + - *467 - *504 - *505 - *506 - *507 + - *508 - *17 - *19 - - *508 - - *487 - *509 + - *488 - *510 + - *511 responses: '200': description: Response @@ -72979,9 +75995,9 @@ paths: type: integer workflow_runs: type: array - items: *488 + items: *489 examples: - default: *511 + default: *512 headers: Link: *45 x-github: @@ -73014,9 +76030,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-workflow-usage parameters: - - *465 - *466 - - *503 + - *467 + - *504 responses: '200': description: Response @@ -73077,8 +76093,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-activities parameters: - - *465 - *466 + - *467 - *110 - *17 - *108 @@ -73246,8 +76262,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#list-assignees parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -73284,8 +76300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *465 - *466 + - *467 - name: assignee in: path required: true @@ -73321,8 +76337,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#create-an-attestation parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -73432,8 +76448,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#list-attestations parameters: - - *465 - *466 + - *467 - *17 - *108 - *109 @@ -73474,7 +76490,7 @@ paths: initiator: type: string examples: - default: *512 + default: *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73494,8 +76510,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -73503,7 +76519,7 @@ paths: application/json: schema: type: array - items: &513 + items: &514 title: Autolink reference description: An autolink reference. type: object @@ -73562,8 +76578,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -73602,9 +76618,9 @@ paths: description: response content: application/json: - schema: *513 + schema: *514 examples: - default: &514 + default: &515 value: id: 1 key_prefix: TICKET- @@ -73635,9 +76651,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *465 - *466 - - &515 + - *467 + - &516 name: autolink_id description: The unique identifier of the autolink. in: path @@ -73649,9 +76665,9 @@ paths: description: Response content: application/json: - schema: *513 + schema: *514 examples: - default: *514 + default: *515 '404': *6 x-github: githubCloudOnly: false @@ -73671,9 +76687,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *465 - *466 - - *515 + - *467 + - *516 responses: '204': description: Response @@ -73697,8 +76713,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response if Dependabot is enabled @@ -73748,8 +76764,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-dependabot-security-updates parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -73770,8 +76786,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-dependabot-security-updates parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -73791,8 +76807,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#list-branches parameters: - - *465 - *466 + - *467 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -73830,7 +76846,7 @@ paths: - url protected: type: boolean - protection: &517 + protection: &518 title: Branch Protection description: Branch Protection type: object @@ -73873,7 +76889,7 @@ paths: required: - contexts - checks - enforce_admins: &520 + enforce_admins: &521 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -73890,7 +76906,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &522 + required_pull_request_reviews: &523 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -73974,7 +76990,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &519 + restrictions: &520 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -74267,9 +77283,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#get-a-branch parameters: - - *465 - *466 - - &518 + - *467 + - &519 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql). @@ -74283,14 +77299,14 @@ paths: description: Response content: application/json: - schema: &528 + schema: &529 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &579 + commit: &580 title: Commit description: Commit type: object @@ -74329,7 +77345,7 @@ paths: author: anyOf: - type: 'null' - - &516 + - &517 title: Git User description: Metaproperties for Git author/committer information. @@ -74351,7 +77367,7 @@ paths: committer: anyOf: - type: 'null' - - *516 + - *517 message: type: string examples: @@ -74375,7 +77391,7 @@ paths: required: - sha - url - verification: &640 + verification: &641 title: Verification type: object properties: @@ -74455,7 +77471,7 @@ paths: type: integer files: type: array - items: &590 + items: &591 title: Diff Entry description: Diff Entry type: object @@ -74551,7 +77567,7 @@ paths: - self protected: type: boolean - protection: *517 + protection: *518 protection_url: type: string format: uri @@ -74660,7 +77676,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *471 + '301': *472 '404': *6 x-github: githubCloudOnly: false @@ -74682,15 +77698,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-branch-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *517 + schema: *518 examples: default: value: @@ -74884,9 +77900,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-branch-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -75146,7 +78162,7 @@ paths: url: type: string format: uri - required_status_checks: &525 + required_status_checks: &526 title: Status Check Policy description: Status Check Policy type: object @@ -75305,7 +78321,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *519 + restrictions: *520 required_conversation_resolution: type: object properties: @@ -75417,9 +78433,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-branch-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '204': description: Response @@ -75444,17 +78460,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *520 + schema: *521 examples: - default: &521 + default: &522 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -75476,17 +78492,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *520 + schema: *521 examples: - default: *521 + default: *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75505,9 +78521,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '204': description: Response @@ -75532,17 +78548,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *522 + schema: *523 examples: - default: &523 + default: &524 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -75638,9 +78654,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: false content: @@ -75738,9 +78754,9 @@ paths: description: Response content: application/json: - schema: *522 + schema: *523 examples: - default: *523 + default: *524 '422': *15 x-github: githubCloudOnly: false @@ -75761,9 +78777,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '204': description: Response @@ -75790,17 +78806,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *520 + schema: *521 examples: - default: &524 + default: &525 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -75823,17 +78839,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *520 + schema: *521 examples: - default: *524 + default: *525 '404': *6 x-github: githubCloudOnly: false @@ -75853,9 +78869,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '204': description: Response @@ -75880,17 +78896,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-status-checks-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *525 + schema: *526 examples: - default: &526 + default: &527 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -75916,9 +78932,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-status-check-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: false content: @@ -75970,9 +78986,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *526 examples: - default: *526 + default: *527 '404': *6 '422': *15 x-github: @@ -75994,9 +79010,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '204': description: Response @@ -76020,9 +79036,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response @@ -76056,9 +79072,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-status-check-contexts parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: false content: @@ -76125,9 +79141,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-status-check-contexts parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: false content: @@ -76191,9 +79207,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: content: application/json: @@ -76259,15 +79275,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *519 + schema: *520 examples: default: value: @@ -76358,9 +79374,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '204': description: Response @@ -76383,9 +79399,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response @@ -76395,7 +79411,7 @@ paths: type: array items: *5 examples: - default: &527 + default: &528 value: - id: 1 slug: octoapp @@ -76452,9 +79468,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -76488,7 +79504,7 @@ paths: type: array items: *5 examples: - default: *527 + default: *528 '422': *15 x-github: githubCloudOnly: false @@ -76509,9 +79525,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -76545,7 +79561,7 @@ paths: type: array items: *5 examples: - default: *527 + default: *528 '422': *15 x-github: githubCloudOnly: false @@ -76566,9 +79582,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -76602,7 +79618,7 @@ paths: type: array items: *5 examples: - default: *527 + default: *528 '422': *15 x-github: githubCloudOnly: false @@ -76624,9 +79640,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response @@ -76656,9 +79672,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: false content: @@ -76717,9 +79733,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: false content: @@ -76778,9 +79794,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: content: application/json: @@ -76839,9 +79855,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response @@ -76875,9 +79891,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -76935,9 +79951,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -76995,9 +80011,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -77057,9 +80073,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#rename-a-branch parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -77081,7 +80097,7 @@ paths: description: Response content: application/json: - schema: *528 + schema: *529 examples: default: value: @@ -77195,8 +80211,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *465 - *466 + - *467 - *103 - *104 - *105 @@ -77232,8 +80248,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *465 - *466 + - *467 - name: bypass_request_number in: path required: true @@ -77306,8 +80322,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *465 - *466 + - *467 - *103 - *104 - *105 @@ -77347,8 +80363,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *465 - *466 + - *467 - name: bypass_request_number in: path required: true @@ -77418,8 +80434,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *465 - *466 + - *467 - name: bypass_request_number in: path required: true @@ -77490,8 +80506,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *465 - *466 + - *467 - name: bypass_response_id in: path required: true @@ -77524,8 +80540,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#create-a-check-run parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -77804,7 +80820,7 @@ paths: description: Response content: application/json: - schema: &529 + schema: &530 title: CheckRun description: A check performed on the code of a given code change type: object @@ -77940,7 +80956,7 @@ paths: check. type: array items: *222 - deployment: &859 + deployment: &860 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -78227,9 +81243,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#get-a-check-run parameters: - - *465 - *466 - - &530 + - *467 + - &531 name: check_run_id description: The unique identifier of the check run. in: path @@ -78241,9 +81257,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *530 examples: - default: &531 + default: &532 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -78343,9 +81359,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run parameters: - - *465 - *466 - - *530 + - *467 + - *531 requestBody: required: true content: @@ -78585,9 +81601,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *530 examples: - default: *531 + default: *532 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78607,9 +81623,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-run-annotations parameters: - - *465 - *466 - - *530 + - *467 + - *531 - *17 - *19 responses: @@ -78719,9 +81735,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#rerequest-a-check-run parameters: - - *465 - *466 - - *530 + - *467 + - *531 responses: '201': description: Response @@ -78765,8 +81781,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -78788,7 +81804,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &533 + schema: &534 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -78886,7 +81902,7 @@ paths: - string - 'null' format: date-time - head_commit: *532 + head_commit: *533 latest_check_runs_count: type: integer check_runs_url: @@ -78914,7 +81930,7 @@ paths: - check_runs_url - pull_requests examples: - default: &534 + default: &535 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -79205,9 +82221,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *533 + schema: *534 examples: - default: *534 + default: *535 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79226,8 +82242,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -79536,9 +82552,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite parameters: - - *465 - *466 - - &535 + - *467 + - &536 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -79550,9 +82566,9 @@ paths: description: Response content: application/json: - schema: *533 + schema: *534 examples: - default: *534 + default: *535 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79575,17 +82591,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *465 - *466 - - *535 - - &585 + - *467 + - *536 + - &586 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &586 + - &587 name: status description: Returns check runs with the specified `status`. in: query @@ -79624,9 +82640,9 @@ paths: type: integer check_runs: type: array - items: *529 + items: *530 examples: - default: &587 + default: &588 value: total_count: 1 check_runs: @@ -79728,9 +82744,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#rerequest-a-check-suite parameters: - - *465 - *466 - - *535 + - *467 + - *536 responses: '201': description: Response @@ -79763,21 +82779,21 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *465 - *466 + - *467 - *311 - *312 - *19 - *17 - - &551 + - &552 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *536 - - &552 + schema: *537 + - &553 name: pr description: The number of the pull request for the results you want to list. in: query @@ -79808,7 +82824,7 @@ paths: be returned. in: query required: false - schema: *537 + schema: *538 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -79832,7 +82848,7 @@ paths: updated_at: *135 url: *132 html_url: *133 - instances_url: *538 + instances_url: *539 state: *113 fixed_at: *137 dismissed_by: @@ -79840,11 +82856,11 @@ paths: - type: 'null' - *4 dismissed_at: *136 - dismissed_reason: *539 - dismissed_comment: *540 - rule: *541 - tool: *542 - most_recent_instance: *543 + dismissed_reason: *540 + dismissed_comment: *541 + rule: *542 + tool: *543 + most_recent_instance: *544 dismissal_approved_by: anyOf: - type: 'null' @@ -79967,7 +82983,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &544 + '403': &545 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -79994,9 +83010,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *465 - *466 - - &545 + - *467 + - &546 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -80010,7 +83026,7 @@ paths: description: Response content: application/json: - schema: &546 + schema: &547 type: object properties: number: *127 @@ -80018,7 +83034,7 @@ paths: updated_at: *135 url: *132 html_url: *133 - instances_url: *538 + instances_url: *539 state: *113 fixed_at: *137 dismissed_by: @@ -80026,8 +83042,8 @@ paths: - type: 'null' - *4 dismissed_at: *136 - dismissed_reason: *539 - dismissed_comment: *540 + dismissed_reason: *540 + dismissed_comment: *541 rule: type: object properties: @@ -80089,8 +83105,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *542 - most_recent_instance: *543 + tool: *543 + most_recent_instance: *544 dismissal_approved_by: anyOf: - type: 'null' @@ -80186,7 +83202,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -80206,9 +83222,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 requestBody: required: true content: @@ -80223,8 +83239,8 @@ paths: enum: - open - dismissed - dismissed_reason: *539 - dismissed_comment: *540 + dismissed_reason: *540 + dismissed_comment: *541 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -80252,7 +83268,7 @@ paths: description: Response content: application/json: - schema: *546 + schema: *547 examples: default: value: @@ -80328,7 +83344,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &550 + '403': &551 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -80355,15 +83371,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 responses: '200': description: Response content: application/json: - schema: &547 + schema: &548 type: object properties: status: @@ -80390,13 +83406,13 @@ paths: - description - started_at examples: - default: &548 + default: &549 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &549 + '400': &550 description: Bad Request content: application/json: @@ -80407,7 +83423,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -80432,29 +83448,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 responses: '200': description: OK content: application/json: - schema: *547 + schema: *548 examples: - default: *548 + default: *549 '202': description: Accepted content: application/json: - schema: *547 + schema: *548 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *549 + '400': *550 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -80486,9 +83502,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 requestBody: required: false content: @@ -80534,8 +83550,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *549 - '403': *550 + '400': *550 + '403': *551 '404': *6 '422': description: Unprocessable Entity @@ -80559,13 +83575,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 - *19 - *17 - - *551 - *552 + - *553 responses: '200': description: Response @@ -80576,10 +83592,10 @@ paths: items: type: object properties: - ref: *536 - analysis_key: *553 - environment: *554 - category: *555 + ref: *537 + analysis_key: *554 + environment: *555 + category: *556 state: type: - string @@ -80596,7 +83612,7 @@ paths: properties: text: type: string - location: *556 + location: *557 html_url: type: string classifications: @@ -80604,7 +83620,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: *557 + items: *558 examples: default: value: @@ -80641,7 +83657,7 @@ paths: end_column: 50 classifications: - source - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -80675,25 +83691,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *465 - *466 + - *467 - *311 - *312 - *19 - *17 - - *552 + - *553 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *536 + schema: *537 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &558 + schema: &559 type: string description: An identifier for the upload. examples: @@ -80715,23 +83731,23 @@ paths: application/json: schema: type: array - items: &559 + items: &560 type: object properties: - ref: *536 - commit_sha: &567 + ref: *537 + commit_sha: &568 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *553 + analysis_key: *554 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *555 + category: *556 error: type: string examples: @@ -80756,8 +83772,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *558 - tool: *542 + sarif_id: *559 + tool: *543 deletable: type: boolean warning: @@ -80819,7 +83835,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -80855,8 +83871,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *465 - *466 + - *467 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -80869,7 +83885,7 @@ paths: description: Response content: application/json: - schema: *559 + schema: *560 examples: response: summary: application/json response @@ -80923,7 +83939,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *544 + '403': *545 '404': *6 '422': description: Response if analysis could not be processed @@ -81010,8 +84026,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *465 - *466 + - *467 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -81067,7 +84083,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *550 + '403': *551 '404': *6 '503': *192 x-github: @@ -81089,8 +84105,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -81098,7 +84114,7 @@ paths: application/json: schema: type: array - items: &560 + items: &561 title: CodeQL Database description: A CodeQL database. type: object @@ -81210,7 +84226,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -81239,8 +84255,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *465 - *466 + - *467 - name: language in: path description: The language of the CodeQL database. @@ -81252,7 +84268,7 @@ paths: description: Response content: application/json: - schema: *560 + schema: *561 examples: default: value: @@ -81284,9 +84300,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &594 + '302': &595 description: Found - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -81308,8 +84324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *465 - *466 + - *467 - name: language in: path description: The language of the CodeQL database. @@ -81319,7 +84335,7 @@ paths: responses: '204': description: Response - '403': *550 + '403': *551 '404': *6 '503': *192 x-github: @@ -81347,8 +84363,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -81357,7 +84373,7 @@ paths: type: object additionalProperties: false properties: - language: &561 + language: &562 type: string description: The language targeted by the CodeQL query enum: @@ -81437,7 +84453,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &565 + schema: &566 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -81447,7 +84463,7 @@ paths: description: The ID of the variant analysis. controller_repo: *120 actor: *4 - query_language: *561 + query_language: *562 query_pack_url: type: string description: The download url for the query pack. @@ -81495,7 +84511,7 @@ paths: items: type: object properties: - repository: &562 + repository: &563 title: Repository Identifier description: Repository Identifier type: object @@ -81537,7 +84553,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &566 + analysis_status: &567 type: string description: The new status of the CodeQL variant analysis repository task. @@ -81569,7 +84585,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &563 + access_mismatch_repos: &564 type: object properties: repository_count: @@ -81584,7 +84600,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *562 + items: *563 required: - repository_count - repositories @@ -81607,8 +84623,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *563 - over_limit_repos: *563 + no_codeql_db_repos: *564 + over_limit_repos: *564 required: - access_mismatch_repos - not_found_repos @@ -81624,7 +84640,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &564 + value: &565 summary: Default response value: id: 1 @@ -81770,10 +84786,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *564 + value: *565 repository_lists: summary: Response for a successful variant analysis submission - value: *564 + value: *565 '404': *6 '422': description: Unable to process variant analysis submission @@ -81801,8 +84817,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *465 - *466 + - *467 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -81814,9 +84830,9 @@ paths: description: Response content: application/json: - schema: *565 + schema: *566 examples: - default: *564 + default: *565 '404': *6 '503': *192 x-github: @@ -81839,7 +84855,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *465 + - *466 - name: repo in: path description: The name of the controller repository. @@ -81874,7 +84890,7 @@ paths: type: object properties: repository: *120 - analysis_status: *566 + analysis_status: *567 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -81999,8 +85015,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -82091,7 +85107,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -82112,8 +85128,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -82207,7 +85223,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *550 + '403': *551 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -82278,8 +85294,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -82287,7 +85303,7 @@ paths: schema: type: object properties: - commit_sha: *567 + commit_sha: *568 ref: type: string description: |- @@ -82347,7 +85363,7 @@ paths: schema: type: object properties: - id: *558 + id: *559 url: type: string description: The REST API URL for checking the status of the upload. @@ -82361,7 +85377,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *550 + '403': *551 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -82384,8 +85400,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *465 - *466 + - *467 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -82433,7 +85449,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *544 + '403': *545 '404': description: Not Found if the sarif id does not match any upload '503': *192 @@ -82458,8 +85474,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -82540,8 +85556,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-codeowners-errors parameters: - - *465 - *466 + - *467 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -82669,8 +85685,8 @@ paths: parameters: - *17 - *19 - - *465 - *466 + - *467 responses: '200': description: Response @@ -82984,8 +86000,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -83051,7 +86067,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -83059,7 +86075,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '400': *14 '401': *23 '403': *27 @@ -83088,8 +86104,8 @@ paths: parameters: - *17 - *19 - - *465 - *466 + - *467 responses: '200': description: Response @@ -83153,8 +86169,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *465 - *466 + - *467 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -83191,9 +86207,9 @@ paths: type: integer machines: type: array - items: *569 + items: *570 examples: - default: &803 + default: &804 value: total_count: 2 machines: @@ -83233,8 +86249,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *465 - *466 + - *467 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -83321,8 +86337,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *465 - *466 + - *467 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -83391,8 +86407,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -83410,7 +86426,7 @@ paths: type: integer secrets: type: array - items: &573 + items: &574 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -83431,7 +86447,7 @@ paths: - created_at - updated_at examples: - default: *570 + default: *571 headers: Link: *45 x-github: @@ -83454,16 +86470,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *571 + schema: *572 examples: - default: *572 + default: *573 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -83483,17 +86499,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 responses: '200': description: Response content: application/json: - schema: *573 + schema: *574 examples: - default: *574 + default: *575 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83513,8 +86529,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 requestBody: required: true @@ -83567,8 +86583,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 responses: '204': @@ -83597,8 +86613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *465 - *466 + - *467 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -83636,7 +86652,7 @@ paths: application/json: schema: type: array - items: &575 + items: &576 title: Collaborator description: Collaborator type: object @@ -83829,8 +86845,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *465 - *466 + - *467 - *140 responses: '204': @@ -83877,8 +86893,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *465 - *466 + - *467 - *140 requestBody: required: false @@ -83905,7 +86921,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &652 + schema: &653 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -84133,8 +87149,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *465 - *466 + - *467 - *140 responses: '204': @@ -84166,8 +87182,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *465 - *466 + - *467 - *140 responses: '200': @@ -84188,7 +87204,7 @@ paths: user: anyOf: - type: 'null' - - *575 + - *576 required: - permission - role_name @@ -84242,8 +87258,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -84253,7 +87269,7 @@ paths: application/json: schema: type: array - items: &576 + items: &577 title: Commit Comment description: Commit Comment type: object @@ -84311,7 +87327,7 @@ paths: - created_at - updated_at examples: - default: &581 + default: &582 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -84370,17 +87386,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment parameters: - - *465 - *466 + - *467 - *233 responses: '200': description: Response content: application/json: - schema: *576 + schema: *577 examples: - default: &582 + default: &583 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -84437,8 +87453,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#update-a-commit-comment parameters: - - *465 - *466 + - *467 - *233 requestBody: required: true @@ -84461,7 +87477,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *577 examples: default: value: @@ -84512,8 +87528,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#delete-a-commit-comment parameters: - - *465 - *466 + - *467 - *233 responses: '204': @@ -84535,8 +87551,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *465 - *466 + - *467 - *233 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). @@ -84563,7 +87579,7 @@ paths: application/json: schema: type: array - items: &577 + items: &578 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -84607,7 +87623,7 @@ paths: - content - created_at examples: - default: &655 + default: &656 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -84652,8 +87668,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *465 - *466 + - *467 - *233 requestBody: required: true @@ -84686,9 +87702,9 @@ paths: description: Reaction exists content: application/json: - schema: *577 + schema: *578 examples: - default: &578 + default: &579 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -84717,9 +87733,9 @@ paths: description: Reaction created content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '422': *15 x-github: githubCloudOnly: false @@ -84741,10 +87757,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *465 - *466 + - *467 - *233 - - &656 + - &657 name: reaction_id description: The unique identifier of the reaction. in: path @@ -84799,8 +87815,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-commits parameters: - - *465 - *466 + - *467 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -84856,9 +87872,9 @@ paths: application/json: schema: type: array - items: *579 + items: *580 examples: - default: &705 + default: &706 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -84952,9 +87968,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-branches-for-head-commit parameters: - - *465 - *466 - - &580 + - *467 + - &581 name: commit_sha description: The SHA of the commit. in: path @@ -85026,9 +88042,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments parameters: - - *465 - *466 - - *580 + - *467 + - *581 - *17 - *19 responses: @@ -85038,9 +88054,9 @@ paths: application/json: schema: type: array - items: *576 + items: *577 examples: - default: *581 + default: *582 headers: Link: *45 x-github: @@ -85068,9 +88084,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#create-a-commit-comment parameters: - - *465 - *466 - - *580 + - *467 + - *581 requestBody: required: true content: @@ -85105,9 +88121,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *577 examples: - default: *582 + default: *583 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -85135,9 +88151,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *465 - *466 - - *580 + - *467 + - *581 - *17 - *19 responses: @@ -85147,9 +88163,9 @@ paths: application/json: schema: type: array - items: *583 + items: *584 examples: - default: &697 + default: &698 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -85686,11 +88702,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#get-a-commit parameters: - - *465 - *466 + - *467 - *19 - *17 - - &584 + - &585 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -85705,9 +88721,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: &683 + default: &684 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -85795,7 +88811,7 @@ paths: schema: type: string examples: - default: &591 + default: &592 value: | diff --git a/testfile b/testfile index 9bdeaeb..912c7ef 100644 @@ -85808,7 +88824,7 @@ paths: schema: type: string examples: - default: &592 + default: &593 value: | From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 From: Mona Lisa <87831417+monalisa@users.noreply.github.com> @@ -85861,11 +88877,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *465 - *466 - - *584 + - *467 - *585 - *586 + - *587 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -85899,9 +88915,9 @@ paths: type: integer check_runs: type: array - items: *529 + items: *530 examples: - default: *587 + default: *588 headers: Link: *45 x-github: @@ -85926,9 +88942,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *465 - *466 - - *584 + - *467 + - *585 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -85936,7 +88952,7 @@ paths: schema: type: integer example: 1 - - *585 + - *586 - *17 - *19 responses: @@ -85954,7 +88970,7 @@ paths: type: integer check_suites: type: array - items: *533 + items: *534 examples: default: value: @@ -86154,9 +89170,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *465 - *466 - - *584 + - *467 + - *585 - *17 - *19 responses: @@ -86358,9 +89374,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *465 - *466 - - *584 + - *467 + - *585 - *17 - *19 responses: @@ -86370,7 +89386,7 @@ paths: application/json: schema: type: array - items: &758 + items: &759 title: Status description: The status of a commit. type: object @@ -86451,7 +89467,7 @@ paths: site_admin: false headers: Link: *45 - '301': *471 + '301': *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86479,8 +89495,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/community#get-community-profile-metrics parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -86513,11 +89529,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *588 + - *589 code_of_conduct_file: anyOf: - type: 'null' - - &589 + - &590 title: Community Health File type: object properties: @@ -86537,19 +89553,19 @@ paths: contributing: anyOf: - type: 'null' - - *589 + - *590 readme: anyOf: - type: 'null' - - *589 + - *590 issue_template: anyOf: - type: 'null' - - *589 + - *590 pull_request_template: anyOf: - type: 'null' - - *589 + - *590 required: - code_of_conduct - code_of_conduct_file @@ -86678,8 +89694,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#compare-two-commits parameters: - - *465 - *466 + - *467 - *19 - *17 - name: basehead @@ -86727,8 +89743,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *579 - merge_base_commit: *579 + base_commit: *580 + merge_base_commit: *580 status: type: string enum: @@ -86752,10 +89768,10 @@ paths: - 6 commits: type: array - items: *579 + items: *580 files: type: array - items: *590 + items: *591 required: - url - html_url @@ -87001,12 +90017,12 @@ paths: schema: type: string examples: - default: *591 + default: *592 application/vnd.github.patch: schema: type: string examples: - default: *592 + default: *593 '404': *6 '500': *38 '503': *192 @@ -87051,8 +90067,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-repository-content parameters: - - *465 - *466 + - *467 - name: path description: path parameter in: path @@ -87222,7 +90238,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &593 + response-if-content-is-a-file-github-object: &594 summary: Response if content is a file value: type: file @@ -87359,7 +90375,7 @@ paths: - size - type - url - - &710 + - &711 title: Content File description: Content File type: object @@ -87577,7 +90593,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *593 + response-if-content-is-a-file: *594 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -87646,7 +90662,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *594 + '302': *595 '304': *35 x-github: githubCloudOnly: false @@ -87669,8 +90685,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#create-or-update-file-contents parameters: - - *465 - *466 + - *467 - name: path description: path parameter in: path @@ -87765,7 +90781,7 @@ paths: description: Response content: application/json: - schema: &595 + schema: &596 title: File Commit description: File Commit type: object @@ -87921,7 +90937,7 @@ paths: description: Response content: application/json: - schema: *595 + schema: *596 examples: example-for-creating-a-file: value: @@ -87975,7 +90991,7 @@ paths: schema: oneOf: - *3 - - &635 + - &636 description: Repository rule violation was detected type: object properties: @@ -87996,7 +91012,7 @@ paths: items: type: object properties: - placeholder_id: &750 + placeholder_id: &751 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -88028,8 +91044,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#delete-a-file parameters: - - *465 - *466 + - *467 - name: path description: path parameter in: path @@ -88090,7 +91106,7 @@ paths: description: Response content: application/json: - schema: *595 + schema: *596 examples: default: value: @@ -88145,8 +91161,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-contributors parameters: - - *465 - *466 + - *467 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -88270,8 +91286,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *465 - *466 + - *467 - *332 - *333 - *334 @@ -88284,7 +91300,7 @@ paths: schema: type: string - *337 - - *596 + - *597 - *338 - *339 - *340 @@ -88299,7 +91315,7 @@ paths: application/json: schema: type: array - items: &600 + items: &601 type: object description: A Dependabot alert. properties: @@ -88350,7 +91366,7 @@ paths: - transitive - inconclusive - - security_advisory: *597 + security_advisory: *598 security_vulnerability: *131 url: *132 html_url: *133 @@ -88381,8 +91397,8 @@ paths: dismissal. maxLength: 280 fixed_at: *137 - auto_dismissed_at: *598 - dismissal_request: *599 + auto_dismissed_at: *599 + dismissal_request: *600 assignees: type: array description: The users assigned to this alert. @@ -88637,9 +91653,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *465 - *466 - - &601 + - *467 + - &602 name: alert_number in: path description: |- @@ -88654,7 +91670,7 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: default: value: @@ -88786,9 +91802,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *465 - *466 - - *601 + - *467 + - *602 requestBody: required: true content: @@ -88844,7 +91860,7 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: default: value: @@ -88974,8 +91990,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-repository-secrets parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -88993,7 +92009,7 @@ paths: type: integer secrets: type: array - items: &604 + items: &605 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -89047,16 +92063,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *602 + schema: *603 examples: - default: *603 + default: *604 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89076,15 +92092,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 responses: '200': description: Response content: application/json: - schema: *604 + schema: *605 examples: default: value: @@ -89110,8 +92126,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 requestBody: required: true @@ -89164,8 +92180,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 responses: '204': @@ -89188,8 +92204,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *465 - *466 + - *467 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -89363,8 +92379,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -89623,8 +92639,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *465 - *466 + - *467 - name: sbom_uuid in: path required: true @@ -89635,7 +92651,7 @@ paths: '302': description: Redirects to a temporary download URL for the completed SBOM. headers: - Location: *605 + Location: *606 '202': description: SBOM is still being processed, no content is returned. '404': *6 @@ -89656,8 +92672,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *465 - *466 + - *467 responses: '201': description: Response @@ -89695,8 +92711,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -89779,7 +92795,7 @@ paths: - version - url additionalProperties: false - metadata: &606 + metadata: &607 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -89818,7 +92834,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *606 + metadata: *607 resolved: type: object description: A collection of resolved package dependencies. @@ -89832,7 +92848,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *606 + metadata: *607 relationship: type: string description: A notation of whether a dependency is requested @@ -89965,8 +92981,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments parameters: - - *465 - *466 + - *467 - name: sha description: The SHA recorded at creation time. in: query @@ -90007,9 +93023,9 @@ paths: application/json: schema: type: array - items: *607 + items: *608 examples: - default: *608 + default: *609 headers: Link: *45 x-github: @@ -90075,8 +93091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#create-a-deployment parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -90158,7 +93174,7 @@ paths: description: Response content: application/json: - schema: *607 + schema: *608 examples: simple-example: summary: Simple example @@ -90231,9 +93247,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#get-a-deployment parameters: - - *465 - *466 - - &609 + - *467 + - &610 name: deployment_id description: deployment_id parameter in: path @@ -90245,7 +93261,7 @@ paths: description: Response content: application/json: - schema: *607 + schema: *608 examples: default: value: @@ -90310,9 +93326,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#delete-a-deployment parameters: - - *465 - *466 - - *609 + - *467 + - *610 responses: '204': description: Response @@ -90334,9 +93350,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#list-deployment-statuses parameters: - - *465 - *466 - - *609 + - *467 + - *610 - *17 - *19 responses: @@ -90346,7 +93362,7 @@ paths: application/json: schema: type: array - items: &610 + items: &611 title: Deployment Status description: The status of a deployment. type: object @@ -90510,9 +93526,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#create-a-deployment-status parameters: - - *465 - *466 - - *609 + - *467 + - *610 requestBody: required: true content: @@ -90587,9 +93603,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *611 examples: - default: &611 + default: &612 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -90645,9 +93661,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#get-a-deployment-status parameters: - - *465 - *466 - - *609 + - *467 + - *610 - name: status_id in: path required: true @@ -90658,9 +93674,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *611 examples: - default: *611 + default: *612 '404': *6 x-github: githubCloudOnly: false @@ -90687,12 +93703,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *465 - *466 - - *612 + - *467 - *613 - *614 - *615 + - *616 - *17 - *19 responses: @@ -90702,9 +93718,9 @@ paths: application/json: schema: type: array - items: *616 + items: *617 examples: - default: *617 + default: *618 '404': *6 '403': *27 '500': *38 @@ -90728,8 +93744,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -90741,7 +93757,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *616 + schema: *617 examples: default: value: @@ -90797,8 +93813,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -90857,12 +93873,12 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *465 - *466 - - *612 + - *467 - *613 - *614 - *615 + - *616 - *17 - *19 responses: @@ -90872,9 +93888,9 @@ paths: application/json: schema: type: array - items: *618 + items: *619 examples: - default: *619 + default: *620 '404': *6 '403': *27 '500': *38 @@ -90898,8 +93914,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -90911,7 +93927,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -90962,8 +93978,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -91001,7 +94017,7 @@ paths: description: The created dismissal request. content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -91052,8 +94068,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -91124,8 +94140,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -91158,8 +94174,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - *103 - *104 - *105 @@ -91200,8 +94216,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -91271,8 +94287,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -91341,8 +94357,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -91399,8 +94415,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#list-environments parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -91418,7 +94434,7 @@ paths: - 5 environments: type: array - items: &621 + items: &622 title: Environment description: Details of a deployment environment type: object @@ -91480,7 +94496,7 @@ paths: type: string examples: - wait_timer - wait_timer: &623 + wait_timer: &624 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -91522,7 +94538,7 @@ paths: items: type: object properties: - type: *620 + type: *621 reviewer: anyOf: - *4 @@ -91549,7 +94565,7 @@ paths: - id - node_id - type - deployment_branch_policy: &624 + deployment_branch_policy: &625 type: - object - 'null' @@ -91666,9 +94682,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#get-an-environment parameters: - - *465 - *466 - - &622 + - *467 + - &623 name: environment_name in: path required: true @@ -91681,9 +94697,9 @@ paths: description: Response content: application/json: - schema: *621 + schema: *622 examples: - default: &625 + default: &626 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -91767,9 +94783,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#create-or-update-an-environment parameters: - - *465 - *466 - - *622 + - *467 + - *623 requestBody: required: false content: @@ -91779,7 +94795,7 @@ paths: - object - 'null' properties: - wait_timer: *623 + wait_timer: *624 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -91798,14 +94814,14 @@ paths: items: type: object properties: - type: *620 + type: *621 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *624 + deployment_branch_policy: *625 additionalProperties: false examples: default: @@ -91825,9 +94841,9 @@ paths: description: Response content: application/json: - schema: *621 + schema: *622 examples: - default: *625 + default: *626 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -91851,9 +94867,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#delete-an-environment parameters: - - *465 - *466 - - *622 + - *467 + - *623 responses: '204': description: Default response @@ -91878,9 +94894,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *465 - *466 - - *622 + - *467 + - *623 - *17 - *19 responses: @@ -91899,7 +94915,7 @@ paths: - 2 branch_policies: type: array - items: &626 + items: &627 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -91960,9 +94976,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *465 - *466 - - *622 + - *467 + - *623 requestBody: required: true content: @@ -92010,9 +95026,9 @@ paths: description: Response content: application/json: - schema: *626 + schema: *627 examples: - example-wildcard: &627 + example-wildcard: &628 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -92054,10 +95070,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *465 - *466 - - *622 - - &628 + - *467 + - *623 + - &629 name: branch_policy_id in: path required: true @@ -92069,9 +95085,9 @@ paths: description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: *627 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92090,10 +95106,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *465 - *466 - - *622 - - *628 + - *467 + - *623 + - *629 requestBody: required: true content: @@ -92122,9 +95138,9 @@ paths: description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: *627 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92143,10 +95159,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *465 - *466 - - *622 - - *628 + - *467 + - *623 + - *629 responses: '204': description: Response @@ -92171,9 +95187,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *622 + - *623 + - *467 - *466 - - *465 responses: '200': description: List of deployment protection rules @@ -92190,7 +95206,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &629 + items: &630 title: Deployment protection rule description: Deployment protection rule type: object @@ -92212,7 +95228,7 @@ paths: for the environment. examples: - true - app: &630 + app: &631 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -92315,9 +95331,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *622 + - *623 + - *467 - *466 - - *465 requestBody: content: application/json: @@ -92338,9 +95354,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *629 + schema: *630 examples: - default: &631 + default: &632 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -92375,9 +95391,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *622 + - *623 + - *467 - *466 - - *465 - *19 - *17 responses: @@ -92397,7 +95413,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *630 + items: *631 examples: default: value: @@ -92432,10 +95448,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *465 - *466 - - *622 - - &632 + - *467 + - *623 + - &633 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -92447,9 +95463,9 @@ paths: description: Response content: application/json: - schema: *629 + schema: *630 examples: - default: *631 + default: *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92470,10 +95486,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *622 + - *623 + - *467 - *466 - - *465 - - *632 + - *633 responses: '204': description: Response @@ -92499,9 +95515,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-environment-secrets parameters: - - *465 - *466 - - *622 + - *467 + - *623 - *17 - *19 responses: @@ -92519,9 +95535,9 @@ paths: type: integer secrets: type: array - items: *496 + items: *497 examples: - default: *497 + default: *498 headers: Link: *45 x-github: @@ -92546,17 +95562,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-public-key parameters: - - *465 - *466 - - *622 + - *467 + - *623 responses: '200': description: Response content: application/json: - schema: *498 + schema: *499 examples: - default: *499 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92578,18 +95594,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-secret parameters: - - *465 - *466 - - *622 + - *467 + - *623 - *288 responses: '200': description: Response content: application/json: - schema: *496 + schema: *497 examples: - default: *633 + default: *634 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92611,9 +95627,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *465 - *466 - - *622 + - *467 + - *623 - *288 requestBody: required: true @@ -92671,9 +95687,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-an-environment-secret parameters: - - *465 - *466 - - *622 + - *467 + - *623 - *288 responses: '204': @@ -92699,10 +95715,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-environment-variables parameters: - - *465 - *466 - - *622 - - *483 + - *467 + - *623 + - *484 - *19 responses: '200': @@ -92719,9 +95735,9 @@ paths: type: integer variables: type: array - items: *500 + items: *501 examples: - default: *501 + default: *502 headers: Link: *45 x-github: @@ -92744,9 +95760,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-an-environment-variable parameters: - - *465 - *466 - - *622 + - *467 + - *623 requestBody: required: true content: @@ -92798,18 +95814,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-an-environment-variable parameters: - - *465 - *466 - - *622 + - *467 + - *623 - *291 responses: '200': description: Response content: application/json: - schema: *500 + schema: *501 examples: - default: *634 + default: *635 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92830,10 +95846,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-an-environment-variable parameters: - - *465 - *466 + - *467 - *291 - - *622 + - *623 requestBody: required: true content: @@ -92875,10 +95891,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-an-environment-variable parameters: - - *465 - *466 + - *467 - *291 - - *622 + - *623 responses: '204': description: Response @@ -92900,8 +95916,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-repository-events parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -92969,8 +95985,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#list-forks parameters: - - *465 - *466 + - *467 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -93129,8 +96145,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#create-a-fork parameters: - - *465 - *466 + - *467 requestBody: required: false content: @@ -93163,9 +96179,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: *472 + default: *473 '400': *14 '422': *15 '403': *27 @@ -93186,8 +96202,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#create-a-blob parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -93247,7 +96263,7 @@ paths: schema: oneOf: - *253 - - *635 + - *636 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93272,8 +96288,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#get-a-blob parameters: - - *465 - *466 + - *467 - name: file_sha in: path required: true @@ -93373,8 +96389,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/commits#create-a-commit parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -93483,7 +96499,7 @@ paths: description: Response content: application/json: - schema: &636 + schema: &637 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -93710,15 +96726,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/commits#get-a-commit-object parameters: - - *465 - *466 - - *580 + - *467 + - *581 responses: '200': description: Response content: application/json: - schema: *636 + schema: *637 examples: default: value: @@ -93774,9 +96790,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#list-matching-references parameters: - - *465 - *466 - - &637 + - *467 + - &638 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -93793,7 +96809,7 @@ paths: application/json: schema: type: array - items: &638 + items: &639 title: Git Reference description: Git references within a repository type: object @@ -93869,17 +96885,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference parameters: - - *465 - *466 - - *637 + - *467 + - *638 responses: '200': description: Response content: application/json: - schema: *638 + schema: *639 examples: - default: &639 + default: &640 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -93908,8 +96924,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#create-a-reference parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -93938,9 +96954,9 @@ paths: description: Response content: application/json: - schema: *638 + schema: *639 examples: - default: *639 + default: *640 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -93966,9 +96982,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#update-a-reference parameters: - - *465 - *466 - - *637 + - *467 + - *638 requestBody: required: true content: @@ -93997,9 +97013,9 @@ paths: description: Response content: application/json: - schema: *638 + schema: *639 examples: - default: *639 + default: *640 '422': *15 '409': *119 x-github: @@ -94017,9 +97033,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#delete-a-reference parameters: - - *465 - *466 - - *637 + - *467 + - *638 responses: '204': description: Response @@ -94074,8 +97090,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/tags#create-a-tag-object parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -94142,7 +97158,7 @@ paths: description: Response content: application/json: - schema: &641 + schema: &642 title: Git Tag description: Metadata for a Git tag type: object @@ -94198,7 +97214,7 @@ paths: - sha - type - url - verification: *640 + verification: *641 required: - sha - url @@ -94208,7 +97224,7 @@ paths: - tag - message examples: - default: &642 + default: &643 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -94281,8 +97297,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/tags#get-a-tag parameters: - - *465 - *466 + - *467 - name: tag_sha in: path required: true @@ -94293,9 +97309,9 @@ paths: description: Response content: application/json: - schema: *641 + schema: *642 examples: - default: *642 + default: *643 '404': *6 '409': *119 x-github: @@ -94319,8 +97335,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/trees#create-a-tree parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -94394,7 +97410,7 @@ paths: description: Response content: application/json: - schema: &643 + schema: &644 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -94496,8 +97512,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/trees#get-a-tree parameters: - - *465 - *466 + - *467 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -94520,7 +97536,7 @@ paths: description: Response content: application/json: - schema: *643 + schema: *644 examples: default-response: summary: Default response @@ -94579,8 +97595,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-repository-webhooks parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -94590,7 +97606,7 @@ paths: application/json: schema: type: array - items: &644 + items: &645 title: Webhook description: Webhooks for repositories. type: object @@ -94653,7 +97669,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &895 + last_response: &896 title: Hook Response type: object properties: @@ -94730,8 +97746,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#create-a-repository-webhook parameters: - - *465 - *466 + - *467 requestBody: required: false content: @@ -94784,9 +97800,9 @@ paths: description: Response content: application/json: - schema: *644 + schema: *645 examples: - default: &645 + default: &646 value: type: Repository id: 12345678 @@ -94834,17 +97850,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 responses: '200': description: Response content: application/json: - schema: *644 + schema: *645 examples: - default: *645 + default: *646 '404': *6 x-github: githubCloudOnly: false @@ -94864,8 +97880,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#update-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 requestBody: required: true @@ -94911,9 +97927,9 @@ paths: description: Response content: application/json: - schema: *644 + schema: *645 examples: - default: *645 + default: *646 '422': *15 '404': *6 x-github: @@ -94934,8 +97950,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 responses: '204': @@ -94960,8 +97976,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *465 - *466 + - *467 - *352 responses: '200': @@ -94989,8 +98005,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *465 - *466 + - *467 - *352 requestBody: required: false @@ -95035,8 +98051,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 - *17 - *353 @@ -95069,8 +98085,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 - *16 responses: @@ -95099,8 +98115,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 - *16 responses: @@ -95124,8 +98140,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 responses: '204': @@ -95151,8 +98167,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *465 - *466 + - *467 - *352 responses: '204': @@ -95176,8 +98192,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response if immutable releases are enabled @@ -95225,8 +98241,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-immutable-releases parameters: - - *465 - *466 + - *467 responses: '204': *126 '409': *119 @@ -95246,8 +98262,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-immutable-releases parameters: - - *465 - *466 + - *467 responses: '204': *126 '409': *119 @@ -95304,14 +98320,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-an-import-status parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: &646 + schema: &647 title: Import description: A repository import from an external source. type: object @@ -95418,7 +98434,7 @@ paths: - html_url - authors_url examples: - default: &649 + default: &650 value: vcs: subversion use_lfs: true @@ -95434,7 +98450,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &647 + '503': &648 description: Unavailable due to service under maintenance. content: application/json: @@ -95463,8 +98479,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#start-an-import parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -95512,7 +98528,7 @@ paths: description: Response content: application/json: - schema: *646 + schema: *647 examples: default: value: @@ -95537,7 +98553,7 @@ paths: type: string '422': *15 '404': *6 - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95565,8 +98581,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import parameters: - - *465 - *466 + - *467 requestBody: required: false content: @@ -95618,7 +98634,7 @@ paths: description: Response content: application/json: - schema: *646 + schema: *647 examples: example-1: summary: Example 1 @@ -95666,7 +98682,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95689,12 +98705,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#cancel-an-import parameters: - - *465 - *466 + - *467 responses: '204': description: Response - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95720,9 +98736,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-commit-authors parameters: - - *465 - *466 - - &825 + - *467 + - &826 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -95736,7 +98752,7 @@ paths: application/json: schema: type: array - items: &648 + items: &649 title: Porter Author description: Porter Author type: object @@ -95790,7 +98806,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95815,8 +98831,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#map-a-commit-author parameters: - - *465 - *466 + - *467 - name: author_id in: path required: true @@ -95846,7 +98862,7 @@ paths: description: Response content: application/json: - schema: *648 + schema: *649 examples: default: value: @@ -95859,7 +98875,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95883,8 +98899,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-large-files parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -95925,7 +98941,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95953,8 +98969,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -95981,11 +98997,11 @@ paths: description: Response content: application/json: - schema: *646 + schema: *647 examples: - default: *649 + default: *650 '422': *15 - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96008,8 +99024,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -96018,7 +99034,7 @@ paths: schema: *20 examples: default: *370 - '301': *471 + '301': *472 '404': *6 x-github: githubCloudOnly: false @@ -96038,8 +99054,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -96052,7 +99068,7 @@ paths: properties: {} additionalProperties: false examples: - default: &651 + default: &652 value: limit: collaborators_only origin: repository @@ -96077,13 +99093,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: application/json: - schema: *650 + schema: *651 examples: default: summary: Example request body @@ -96097,7 +99113,7 @@ paths: application/json: schema: *372 examples: - default: *651 + default: *652 '409': description: Response x-github: @@ -96119,8 +99135,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -96143,8 +99159,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#list-repository-invitations parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -96154,9 +99170,9 @@ paths: application/json: schema: type: array - items: *652 + items: *653 examples: - default: &817 + default: &818 value: - id: 1 repository: @@ -96287,8 +99303,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *465 - *466 + - *467 - *376 requestBody: required: false @@ -96318,7 +99334,7 @@ paths: description: Response content: application/json: - schema: *652 + schema: *653 examples: default: value: @@ -96449,8 +99465,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *465 - *466 + - *467 - *376 responses: '204': @@ -96482,8 +99498,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-repository-issues parameters: - - *465 - *466 + - *467 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -96556,7 +99572,7 @@ paths: type: array items: *219 examples: - default: &661 + default: &662 value: - id: 1 node_id: MDU6SXNzdWUx @@ -96705,7 +99721,7 @@ paths: state_reason: completed headers: Link: *45 - '301': *471 + '301': *472 '422': *15 '404': *6 x-github: @@ -96734,8 +99750,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#create-an-issue parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -96819,7 +99835,7 @@ paths: application/json: schema: *219 examples: - default: &658 + default: &659 value: id: 1 node_id: MDU6SXNzdWUx @@ -96957,7 +99973,7 @@ paths: '422': *15 '503': *192 '404': *6 - '410': *653 + '410': *654 x-github: triggersNotification: true githubCloudOnly: false @@ -96985,8 +100001,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *465 - *466 + - *467 - *241 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -97009,7 +100025,7 @@ paths: type: array items: *220 examples: - default: &660 + default: &661 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -97067,8 +100083,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 responses: '200': @@ -97077,7 +100093,7 @@ paths: application/json: schema: *220 examples: - default: &654 + default: &655 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -97132,8 +100148,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#update-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 requestBody: required: true @@ -97158,7 +100174,7 @@ paths: application/json: schema: *220 examples: - default: *654 + default: *655 '422': *15 x-github: githubCloudOnly: false @@ -97176,8 +100192,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#delete-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 responses: '204': @@ -97206,8 +100222,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#pin-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 responses: '200': @@ -97270,7 +100286,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *653 + '410': *654 '422': *15 x-github: githubCloudOnly: false @@ -97287,8 +100303,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#unpin-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 responses: '204': @@ -97296,7 +100312,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *653 + '410': *654 '503': *192 x-github: githubCloudOnly: false @@ -97314,8 +100330,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). @@ -97342,9 +100358,9 @@ paths: application/json: schema: type: array - items: *577 + items: *578 examples: - default: *655 + default: *656 headers: Link: *45 '404': *6 @@ -97365,8 +100381,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 requestBody: required: true @@ -97399,16 +100415,16 @@ paths: description: Reaction exists content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '201': description: Reaction created content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '422': *15 x-github: githubCloudOnly: false @@ -97430,10 +100446,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *465 - *466 + - *467 - *233 - - *656 + - *657 responses: '204': description: Response @@ -97453,8 +100469,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events-for-a-repository parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -97464,7 +100480,7 @@ paths: application/json: schema: type: array - items: &657 + items: &658 title: Issue Event description: Issue Event type: object @@ -97804,8 +100820,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#get-an-issue-event parameters: - - *465 - *466 + - *467 - name: event_id in: path required: true @@ -97816,7 +100832,7 @@ paths: description: Response content: application/json: - schema: *657 + schema: *658 examples: default: value: @@ -98009,7 +101025,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *653 + '410': *654 '403': *27 x-github: githubCloudOnly: false @@ -98043,9 +101059,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue parameters: - - *465 - *466 - - &659 + - *467 + - &660 name: issue_number description: The number that identifies the issue. in: path @@ -98061,7 +101077,7 @@ paths: examples: default: summary: Issue - value: *658 + value: *659 pinned_comment: summary: Issue with pinned comment value: @@ -98241,9 +101257,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 '304': *35 x-github: githubCloudOnly: false @@ -98268,9 +101284,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#update-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: false content: @@ -98405,13 +101421,13 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 '422': *15 '503': *192 '403': *27 - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98429,9 +101445,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: false content: @@ -98459,7 +101475,7 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98475,9 +101491,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: content: application/json: @@ -98504,7 +101520,7 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98526,9 +101542,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - name: assignee in: path required: true @@ -98568,9 +101584,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *224 - *17 - *19 @@ -98583,11 +101599,11 @@ paths: type: array items: *220 examples: - default: *660 + default: *661 headers: Link: *45 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98616,9 +101632,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#create-an-issue-comment parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -98642,14 +101658,14 @@ paths: application/json: schema: *220 examples: - default: *654 + default: *655 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *653 + '410': *654 '422': *15 '404': *6 x-github: @@ -98677,9 +101693,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -98691,12 +101707,12 @@ paths: type: array items: *219 examples: - default: *661 + default: *662 headers: Link: *45 - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98724,9 +101740,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -98750,15 +101766,15 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *471 + '301': *472 '403': *27 - '410': *653 + '410': *654 '422': *15 '404': *6 x-github: @@ -98789,9 +101805,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *465 - *466 - - *659 + - *467 + - *660 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -98805,13 +101821,13 @@ paths: application/json: schema: *219 examples: - default: *658 - '301': *471 + default: *659 + '301': *472 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *653 + '410': *654 x-github: triggersNotification: true githubCloudOnly: false @@ -98837,9 +101853,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -98851,12 +101867,12 @@ paths: type: array items: *219 examples: - default: *661 + default: *662 headers: Link: *45 - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98873,9 +101889,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -98889,7 +101905,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &665 + - &666 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -98938,7 +101954,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &666 + - &667 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -99066,7 +102082,7 @@ paths: - performed_via_github_app - assignee - assigner - - &667 + - &668 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -99112,7 +102128,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &668 + - &669 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -99158,7 +102174,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &669 + - &670 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -99207,7 +102223,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &670 + - &671 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -99249,7 +102265,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &671 + - &672 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -99291,7 +102307,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &672 + - &673 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -99347,7 +102363,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &673 + - &674 title: Locked Issue Event description: Locked Issue Event type: object @@ -99392,7 +102408,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &674 + - &675 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -99453,7 +102469,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &675 + - &676 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -99514,7 +102530,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &676 + - &677 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -99575,7 +102591,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &677 + - &678 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -99668,7 +102684,7 @@ paths: color: red headers: Link: *45 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99685,9 +102701,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -99697,9 +102713,9 @@ paths: application/json: schema: type: array - items: *662 + items: *663 examples: - default: &663 + default: &664 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -99723,9 +102739,9 @@ paths: value: '2025-12-25' headers: Link: *45 - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99754,9 +102770,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -99822,9 +102838,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *662 + items: *663 examples: - default: *663 + default: *664 '400': *14 '403': *27 '404': *6 @@ -99860,9 +102876,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -99929,9 +102945,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *662 + items: *663 examples: - default: *663 + default: *664 '400': *14 '403': *27 '404': *6 @@ -99962,9 +102978,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *379 responses: '204': @@ -99990,9 +103006,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -100004,7 +103020,7 @@ paths: type: array items: *218 examples: - default: &664 + default: &665 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -100022,9 +103038,9 @@ paths: default: false headers: Link: *45 - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100040,9 +103056,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#add-labels-to-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: false content: @@ -100087,10 +103103,10 @@ paths: type: array items: *218 examples: - default: *664 - '301': *471 + default: *665 + '301': *472 '404': *6 - '410': *653 + '410': *654 '422': *15 x-github: githubCloudOnly: false @@ -100107,9 +103123,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#set-labels-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: false content: @@ -100171,10 +103187,10 @@ paths: type: array items: *218 examples: - default: *664 - '301': *471 + default: *665 + '301': *472 '404': *6 - '410': *653 + '410': *654 '422': *15 x-github: githubCloudOnly: false @@ -100191,15 +103207,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 responses: '204': description: Response - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100218,9 +103234,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - name: name in: path required: true @@ -100244,9 +103260,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100266,9 +103282,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#lock-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: false content: @@ -100297,7 +103313,7 @@ paths: '204': description: Response '403': *27 - '410': *653 + '410': *654 '404': *6 '422': *15 x-github: @@ -100315,9 +103331,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#unlock-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 responses: '204': description: Response @@ -100347,9 +103363,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#get-parent-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 responses: '200': description: Response @@ -100357,10 +103373,10 @@ paths: application/json: schema: *219 examples: - default: *658 - '301': *471 + default: *659 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100377,9 +103393,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -100405,13 +103421,13 @@ paths: application/json: schema: type: array - items: *577 + items: *578 examples: - default: *655 + default: *656 headers: Link: *45 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100429,9 +103445,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -100463,16 +103479,16 @@ paths: description: Response content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '201': description: Response content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '422': *15 x-github: githubCloudOnly: false @@ -100494,10 +103510,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *465 - *466 - - *659 - - *656 + - *467 + - *660 + - *657 responses: '204': description: Response @@ -100526,9 +103542,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#remove-sub-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -100552,7 +103568,7 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -100585,9 +103601,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#list-sub-issues parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -100599,11 +103615,11 @@ paths: type: array items: *219 examples: - default: *661 + default: *662 headers: Link: *45 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100631,9 +103647,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#add-sub-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -100662,14 +103678,14 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *653 + '410': *654 '422': *15 '404': *6 x-github: @@ -100689,9 +103705,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -100724,7 +103740,7 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 '403': *27 '404': *6 '422': *7 @@ -100746,9 +103762,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -100763,7 +103779,6 @@ paths: description: Timeline Event type: object anyOf: - - *665 - *666 - *667 - *668 @@ -100776,6 +103791,7 @@ paths: - *675 - *676 - *677 + - *678 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -100832,7 +103848,7 @@ paths: pin: anyOf: - type: 'null' - - *678 + - *679 required: - event - actor @@ -101108,7 +104124,7 @@ paths: type: string comments: type: array - items: &699 + items: &700 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -101349,7 +104365,7 @@ paths: type: string comments: type: array - items: *576 + items: *577 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -101624,7 +104640,7 @@ paths: headers: Link: *45 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101641,8 +104657,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -101652,7 +104668,7 @@ paths: application/json: schema: type: array - items: &679 + items: &680 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -101720,8 +104736,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -101757,9 +104773,9 @@ paths: description: Response content: application/json: - schema: *679 + schema: *680 examples: - default: &680 + default: &681 value: id: 1 key: ssh-rsa AAA... @@ -101793,9 +104809,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *465 - *466 - - &681 + - *467 + - &682 name: key_id description: The unique identifier of the key. in: path @@ -101807,9 +104823,9 @@ paths: description: Response content: application/json: - schema: *679 + schema: *680 examples: - default: *680 + default: *681 '404': *6 x-github: githubCloudOnly: false @@ -101827,9 +104843,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *465 - *466 - - *681 + - *467 + - *682 responses: '204': description: Response @@ -101849,8 +104865,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-a-repository parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -101862,7 +104878,7 @@ paths: type: array items: *218 examples: - default: *664 + default: *665 headers: Link: *45 '404': *6 @@ -101883,8 +104899,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#create-a-label parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -101922,7 +104938,7 @@ paths: application/json: schema: *218 examples: - default: &682 + default: &683 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -101954,8 +104970,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#get-a-label parameters: - - *465 - *466 + - *467 - name: name in: path required: true @@ -101968,7 +104984,7 @@ paths: application/json: schema: *218 examples: - default: *682 + default: *683 '404': *6 x-github: githubCloudOnly: false @@ -101985,8 +105001,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#update-a-label parameters: - - *465 - *466 + - *467 - name: name in: path required: true @@ -102051,8 +105067,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#delete-a-label parameters: - - *465 - *466 + - *467 - name: name in: path required: true @@ -102078,8 +105094,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-languages parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -102115,8 +105131,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *465 - *466 + - *467 responses: '202': *37 '403': @@ -102144,8 +105160,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -102171,9 +105187,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *465 - *466 - - *551 + - *467 + - *552 responses: '200': description: Response @@ -102320,8 +105336,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -102386,8 +105402,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#merge-a-branch parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -102421,9 +105437,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *579 + schema: *580 examples: - default: *683 + default: *684 '204': description: Response when already merged '404': @@ -102448,8 +105464,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#list-milestones parameters: - - *465 - *466 + - *467 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -102546,8 +105562,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#create-a-milestone parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -102589,7 +105605,7 @@ paths: application/json: schema: *414 examples: - default: &684 + default: &685 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -102648,9 +105664,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#get-a-milestone parameters: - - *465 - *466 - - &685 + - *467 + - &686 name: milestone_number description: The number that identifies the milestone. in: path @@ -102664,7 +105680,7 @@ paths: application/json: schema: *414 examples: - default: *684 + default: *685 '404': *6 x-github: githubCloudOnly: false @@ -102681,9 +105697,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#update-a-milestone parameters: - - *465 - *466 - - *685 + - *467 + - *686 requestBody: required: false content: @@ -102723,7 +105739,7 @@ paths: application/json: schema: *414 examples: - default: *684 + default: *685 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102739,9 +105755,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#delete-a-milestone parameters: - - *465 - *466 - - *685 + - *467 + - *686 responses: '204': description: Response @@ -102762,9 +105778,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *465 - *466 - - *685 + - *467 + - *686 - *17 - *19 responses: @@ -102776,7 +105792,7 @@ paths: type: array items: *218 examples: - default: *664 + default: *665 headers: Link: *45 x-github: @@ -102795,12 +105811,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *465 - *466 - - *686 + - *467 - *687 - - *224 - *688 + - *224 + - *689 - *17 - *19 responses: @@ -102812,7 +105828,7 @@ paths: type: array items: *244 examples: - default: *689 + default: *690 headers: Link: *45 x-github: @@ -102836,8 +105852,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *465 - *466 + - *467 requestBody: required: false content: @@ -102895,14 +105911,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-a-apiname-pages-site parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: &690 + schema: &691 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -103046,7 +106062,7 @@ paths: - custom_404 - public examples: - default: &691 + default: &692 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -103087,8 +106103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-apiname-pages-site parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -103143,9 +106159,9 @@ paths: description: Response content: application/json: - schema: *690 + schema: *691 examples: - default: *691 + default: *692 '422': *15 '409': *119 x-github: @@ -103168,8 +106184,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -103277,8 +106293,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -103304,8 +106320,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#list-apiname-pages-builds parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -103315,7 +106331,7 @@ paths: application/json: schema: type: array - items: &692 + items: &693 title: Page Build description: Page Build type: object @@ -103407,8 +106423,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#request-a-apiname-pages-build parameters: - - *465 - *466 + - *467 responses: '201': description: Response @@ -103455,16 +106471,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-latest-pages-build parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *692 + schema: *693 examples: - default: &693 + default: &694 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -103512,8 +106528,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-apiname-pages-build parameters: - - *465 - *466 + - *467 - name: build_id in: path required: true @@ -103524,9 +106540,9 @@ paths: description: Response content: application/json: - schema: *692 + schema: *693 examples: - default: *693 + default: *694 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103546,8 +106562,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-github-pages-deployment parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -103655,9 +106671,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *465 - *466 - - &694 + - *467 + - &695 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -103715,9 +106731,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *465 - *466 - - *694 + - *467 + - *695 responses: '204': *126 '404': *6 @@ -103744,8 +106760,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -104040,8 +107056,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Private vulnerability reporting status @@ -104078,8 +107094,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': *126 '422': *14 @@ -104100,8 +107116,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': *126 '422': *14 @@ -104123,8 +107139,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -104134,7 +107150,7 @@ paths: type: array items: *152 examples: - default: *695 + default: *696 '403': *27 '404': *6 x-github: @@ -104156,8 +107172,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -104173,7 +107189,7 @@ paths: required: - properties examples: - default: *696 + default: *697 responses: '204': description: No Content when custom property values are successfully created @@ -104211,8 +107227,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests parameters: - - *465 - *466 + - *467 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -104272,9 +107288,9 @@ paths: application/json: schema: type: array - items: *583 + items: *584 examples: - default: *697 + default: *698 headers: Link: *45 '304': *35 @@ -104306,8 +107322,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#create-a-pull-request parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -104374,7 +107390,7 @@ paths: description: Response content: application/json: - schema: &701 + schema: &702 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -104598,7 +107614,7 @@ paths: - review_comment - self author_association: *216 - auto_merge: *698 + auto_merge: *699 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -104698,7 +107714,7 @@ paths: - merged_by - review_comments examples: - default: &702 + default: &703 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -105205,8 +108221,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *465 - *466 + - *467 - name: sort in: query required: false @@ -105235,9 +108251,9 @@ paths: application/json: schema: type: array - items: *699 + items: *700 examples: - default: &704 + default: &705 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -105314,17 +108330,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *465 - *466 + - *467 - *233 responses: '200': description: Response content: application/json: - schema: *699 + schema: *700 examples: - default: &700 + default: &701 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -105399,8 +108415,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *465 - *466 + - *467 - *233 requestBody: required: true @@ -105423,9 +108439,9 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: - default: *700 + default: *701 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105441,8 +108457,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *465 - *466 + - *467 - *233 responses: '204': @@ -105464,8 +108480,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *465 - *466 + - *467 - *233 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). @@ -105492,9 +108508,9 @@ paths: application/json: schema: type: array - items: *577 + items: *578 examples: - default: *655 + default: *656 headers: Link: *45 '404': *6 @@ -105515,8 +108531,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *465 - *466 + - *467 - *233 requestBody: required: true @@ -105549,16 +108565,16 @@ paths: description: Reaction exists content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '201': description: Reaction created content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '422': *15 x-github: githubCloudOnly: false @@ -105580,10 +108596,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *465 - *466 + - *467 - *233 - - *656 + - *657 responses: '204': description: Response @@ -105626,9 +108642,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request parameters: - - *465 - *466 - - &703 + - *467 + - &704 name: pull_number description: The number that identifies the pull request. in: path @@ -105641,9 +108657,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *701 + schema: *702 examples: - default: *702 + default: *703 '304': *35 '404': *6 '406': @@ -105678,9 +108694,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: false content: @@ -105722,9 +108738,9 @@ paths: description: Response content: application/json: - schema: *701 + schema: *702 examples: - default: *702 + default: *703 '422': *15 '403': *27 x-github: @@ -105746,9 +108762,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#archive-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 responses: '204': description: Response @@ -105773,9 +108789,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#unarchive-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 responses: '204': description: Response @@ -105801,9 +108817,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: true content: @@ -105866,7 +108882,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -105874,7 +108890,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '401': *23 '403': *27 '404': *6 @@ -105904,9 +108920,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 - *241 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -105927,9 +108943,9 @@ paths: application/json: schema: type: array - items: *699 + items: *700 examples: - default: *704 + default: *705 headers: Link: *45 x-github: @@ -105962,9 +108978,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: true content: @@ -106070,7 +109086,7 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: example-for-a-multi-line-comment: value: @@ -106158,9 +109174,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *465 - *466 - - *703 + - *467 + - *704 - *233 requestBody: required: true @@ -106183,7 +109199,7 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: default: value: @@ -106269,9 +109285,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 - *17 - *19 responses: @@ -106281,9 +109297,9 @@ paths: application/json: schema: type: array - items: *579 + items: *580 examples: - default: *705 + default: *706 headers: Link: *45 x-github: @@ -106313,9 +109329,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests-files parameters: - - *465 - *466 - - *703 + - *467 + - *704 - *17 - *19 responses: @@ -106325,7 +109341,7 @@ paths: application/json: schema: type: array - items: *590 + items: *591 examples: default: value: @@ -106363,9 +109379,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *465 - *466 - - *703 + - *467 + - *704 responses: '204': description: Response if pull request has been merged @@ -106388,9 +109404,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#merge-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: false content: @@ -106502,9 +109518,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 responses: '200': description: Response @@ -106579,9 +109595,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: false content: @@ -106618,7 +109634,7 @@ paths: description: Response content: application/json: - schema: *583 + schema: *584 examples: default: value: @@ -107154,9 +110170,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: true content: @@ -107190,7 +110206,7 @@ paths: description: Response content: application/json: - schema: *583 + schema: *584 examples: default: value: @@ -107675,9 +110691,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 - *17 - *19 responses: @@ -107687,7 +110703,7 @@ paths: application/json: schema: type: array - items: &706 + items: &707 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -107843,9 +110859,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: false content: @@ -107935,9 +110951,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: &708 + default: &709 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -108000,10 +111016,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *465 - *466 - - *703 - - &707 + - *467 + - *704 + - &708 name: review_id description: The unique identifier of the review. in: path @@ -108015,9 +111031,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: &709 + default: &710 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -108076,10 +111092,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *465 - *466 - - *703 - - *707 + - *467 + - *704 + - *708 requestBody: required: true content: @@ -108102,7 +111118,7 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: default: value: @@ -108164,18 +111180,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *465 - *466 - - *703 - - *707 + - *467 + - *704 + - *708 responses: '200': description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: *708 + default: *709 '422': *7 '404': *6 x-github: @@ -108202,10 +111218,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *465 - *466 - - *703 - - *707 + - *467 + - *704 + - *708 - *17 - *19 responses: @@ -108463,10 +111479,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *465 - *466 - - *703 - - *707 + - *467 + - *704 + - *708 requestBody: required: true content: @@ -108495,7 +111511,7 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: default: value: @@ -108558,10 +111574,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *465 - *466 - - *703 - - *707 + - *467 + - *704 + - *708 requestBody: required: true content: @@ -108596,9 +111612,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: *709 + default: *710 '404': *6 '422': *7 '403': *27 @@ -108620,9 +111636,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: false content: @@ -108686,8 +111702,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-a-repository-readme parameters: - - *465 - *466 + - *467 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -108700,9 +111716,9 @@ paths: description: Response content: application/json: - schema: *710 + schema: *711 examples: - default: &711 + default: &712 value: type: file encoding: base64 @@ -108744,8 +111760,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *465 - *466 + - *467 - name: dir description: The alternate path to look for a README file in: path @@ -108765,9 +111781,9 @@ paths: description: Response content: application/json: - schema: *710 + schema: *711 examples: - default: *711 + default: *712 '404': *6 '422': *15 x-github: @@ -108789,8 +111805,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#list-releases parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -108800,7 +111816,7 @@ paths: application/json: schema: type: array - items: *712 + items: *713 examples: default: value: @@ -108894,8 +111910,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#create-a-release parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -108971,9 +111987,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: &716 + default: &717 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -109078,9 +112094,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#get-a-release-asset parameters: - - *465 - *466 - - &714 + - *467 + - &715 name: asset_id description: The unique identifier of the asset. in: path @@ -109092,9 +112108,9 @@ paths: description: Response content: application/json: - schema: *713 + schema: *714 examples: - default: &715 + default: &716 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -109129,7 +112145,7 @@ paths: type: User site_admin: false '404': *6 - '302': *594 + '302': *595 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109145,9 +112161,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#update-a-release-asset parameters: - - *465 - *466 - - *714 + - *467 + - *715 requestBody: required: false content: @@ -109176,9 +112192,9 @@ paths: description: Response content: application/json: - schema: *713 + schema: *714 examples: - default: *715 + default: *716 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109194,9 +112210,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#delete-a-release-asset parameters: - - *465 - *466 - - *714 + - *467 + - *715 responses: '204': description: Response @@ -109221,8 +112237,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -109308,16 +112324,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-the-latest-release parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: *716 + default: *717 '404': *6 x-github: githubCloudOnly: false @@ -109335,8 +112351,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release-by-tag-name parameters: - - *465 - *466 + - *467 - name: tag description: tag parameter in: path @@ -109349,9 +112365,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: *716 + default: *717 '404': *6 x-github: githubCloudOnly: false @@ -109373,9 +112389,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release parameters: - - *465 - *466 - - &717 + - *467 + - &718 name: release_id description: The unique identifier of the release. in: path @@ -109389,9 +112405,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *712 + schema: *713 examples: - default: *716 + default: *717 '401': description: Unauthorized x-github: @@ -109409,9 +112425,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#update-a-release parameters: - - *465 - *466 - - *717 + - *467 + - *718 requestBody: required: false content: @@ -109475,9 +112491,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: *716 + default: *717 '404': description: Not Found if the discussion category name is invalid content: @@ -109498,9 +112514,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#delete-a-release parameters: - - *465 - *466 - - *717 + - *467 + - *718 responses: '204': description: Response @@ -109521,9 +112537,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#list-release-assets parameters: - - *465 - *466 - - *717 + - *467 + - *718 - *17 - *19 responses: @@ -109533,7 +112549,7 @@ paths: application/json: schema: type: array - items: *713 + items: *714 examples: default: value: @@ -109615,9 +112631,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *465 - *466 - - *717 + - *467 + - *718 - name: name in: query required: true @@ -109643,7 +112659,7 @@ paths: description: Response for successful upload content: application/json: - schema: *713 + schema: *714 examples: response-for-successful-upload: value: @@ -109698,9 +112714,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *465 - *466 - - *717 + - *467 + - *718 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -109724,9 +112740,9 @@ paths: application/json: schema: type: array - items: *577 + items: *578 examples: - default: *655 + default: *656 headers: Link: *45 '404': *6 @@ -109747,9 +112763,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *465 - *466 - - *717 + - *467 + - *718 requestBody: required: true content: @@ -109779,16 +112795,16 @@ paths: description: Reaction exists content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '201': description: Reaction created content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '422': *15 x-github: githubCloudOnly: false @@ -109810,10 +112826,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-release-reaction parameters: - - *465 - *466 - - *717 - - *656 + - *467 + - *718 + - *657 responses: '204': description: Response @@ -109837,9 +112853,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-rules-for-a-branch parameters: - - *465 - *466 - - *518 + - *467 + - *519 - *17 - *19 responses: @@ -109856,7 +112872,7 @@ paths: oneOf: - allOf: - *166 - - &718 + - &719 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -109877,67 +112893,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *167 - - *718 + - *719 - allOf: - *168 - - *718 + - *719 - allOf: - *169 - - *718 + - *719 - allOf: + - *720 - *719 - - *718 - allOf: - *170 - - *718 + - *719 - allOf: - *171 - - *718 + - *719 - allOf: - *172 - - *718 + - *719 - allOf: - *173 - - *718 + - *719 - allOf: - *174 - - *718 + - *719 - allOf: - *175 - - *718 + - *719 - allOf: - *176 - - *718 + - *719 - allOf: - *177 - - *718 + - *719 - allOf: - *178 - - *718 + - *719 - allOf: - *179 - - *718 + - *719 - allOf: - *180 - - *718 + - *719 - allOf: - *181 - - *718 + - *719 - allOf: - *182 - - *718 + - *719 - allOf: - *183 - - *718 + - *719 - allOf: - *184 - - *718 + - *719 - allOf: - *185 - - *718 + - *719 - allOf: - *186 - - *718 + - *719 examples: default: value: @@ -109976,8 +112992,8 @@ paths: category: repos subcategory: rules parameters: - - *465 - *466 + - *467 - *17 - *19 - name: includes_parents @@ -109988,7 +113004,7 @@ paths: schema: type: boolean default: true - - *720 + - *721 responses: '200': description: Response @@ -110043,8 +113059,8 @@ paths: category: repos subcategory: rules parameters: - - *465 - *466 + - *467 requestBody: description: Request body required: true @@ -110073,7 +113089,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *721 + items: *722 required: - name - enforcement @@ -110106,7 +113122,7 @@ paths: application/json: schema: *187 examples: - default: &730 + default: &731 value: id: 42 name: super cool ruleset @@ -110154,12 +113170,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *465 - *466 - - *722 - - *105 + - *467 - *723 + - *105 - *724 + - *725 - *17 - *19 responses: @@ -110167,9 +113183,9 @@ paths: description: Response content: application/json: - schema: *725 + schema: *726 examples: - default: *726 + default: *727 '404': *6 '500': *38 x-github: @@ -110190,17 +113206,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *465 - *466 - - *727 + - *467 + - *728 responses: '200': description: Response content: application/json: - schema: *728 + schema: *729 examples: - default: *729 + default: *730 '404': *6 '500': *38 x-github: @@ -110228,8 +113244,8 @@ paths: category: repos subcategory: rules parameters: - - *465 - *466 + - *467 - name: ruleset_id description: The ID of the ruleset. in: path @@ -110251,7 +113267,7 @@ paths: application/json: schema: *187 examples: - default: *730 + default: *731 '404': *6 '500': *38 put: @@ -110269,8 +113285,8 @@ paths: category: repos subcategory: rules parameters: - - *465 - *466 + - *467 - name: ruleset_id description: The ID of the ruleset. in: path @@ -110304,7 +113320,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *721 + items: *722 examples: default: value: @@ -110334,7 +113350,7 @@ paths: application/json: schema: *187 examples: - default: *730 + default: *731 '404': *6 '422': *15 '500': *38 @@ -110353,8 +113369,8 @@ paths: category: repos subcategory: rules parameters: - - *465 - *466 + - *467 - name: ruleset_id description: The ID of the ruleset. in: path @@ -110377,8 +113393,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-history parameters: - - *465 - *466 + - *467 - *17 - *19 - name: ruleset_id @@ -110415,8 +113431,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-version parameters: - - *465 - *466 + - *467 - name: ruleset_id description: The ID of the ruleset. in: path @@ -110489,8 +113505,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *465 - *466 + - *467 - *433 - *434 - *435 @@ -110502,12 +113518,13 @@ paths: - *110 - *19 - *17 - - *731 - *732 + - *733 - *441 - *442 - *443 - *444 + - *445 responses: '200': description: Response @@ -110515,7 +113532,7 @@ paths: application/json: schema: type: array - items: &736 + items: &737 type: object properties: number: *127 @@ -110531,8 +113548,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *733 - resolution: *734 + state: *734 + resolution: *735 resolved_at: type: - string @@ -110638,7 +113655,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *735 + - *736 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -110797,16 +113814,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 - *444 responses: '200': description: Response content: application/json: - schema: *736 + schema: *737 examples: default: value: @@ -110860,9 +113877,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 requestBody: required: true content: @@ -110870,8 +113887,8 @@ paths: schema: type: object properties: - state: *733 - resolution: *734 + state: *734 + resolution: *735 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -110919,7 +113936,7 @@ paths: description: Response content: application/json: - schema: *736 + schema: *737 examples: default: value: @@ -111015,9 +114032,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 - *19 - *17 responses: @@ -111028,7 +114045,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &915 + items: &916 type: object properties: type: @@ -111055,7 +114072,6 @@ paths: - commit details: oneOf: - - *737 - *738 - *739 - *740 @@ -111068,6 +114084,7 @@ paths: - *747 - *748 - *749 + - *750 examples: default: value: @@ -111153,8 +114170,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -111162,14 +114179,14 @@ paths: schema: type: object properties: - reason: &751 + reason: &752 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *750 + placeholder_id: *751 required: - reason - placeholder_id @@ -111186,7 +114203,7 @@ paths: schema: type: object properties: - reason: *751 + reason: *752 expire_at: type: - string @@ -111233,8 +114250,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *465 - *466 + - *467 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -111249,7 +114266,7 @@ paths: properties: incremental_scans: type: array - items: &752 + items: &753 description: Information on a single scan performed by secret scanning on the repository type: object @@ -111277,15 +114294,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *752 + items: *753 backfill_scans: type: array - items: *752 + items: *753 custom_pattern_backfill_scans: type: array items: allOf: - - *752 + - *753 - type: object properties: pattern_name: @@ -111298,7 +114315,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *752 + items: *753 examples: default: value: @@ -111363,8 +114380,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *465 - *466 + - *467 - *110 - name: sort description: The property to sort the results by. @@ -111408,9 +114425,9 @@ paths: application/json: schema: type: array - items: *753 + items: *754 examples: - default: *754 + default: *755 '400': *14 '404': *6 x-github: @@ -111433,8 +114450,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -111514,7 +114531,7 @@ paths: login: type: string description: The username of the user credited. - type: *449 + type: *450 required: - login - type @@ -111604,9 +114621,9 @@ paths: description: Response content: application/json: - schema: *753 + schema: *754 examples: - default: &756 + default: &757 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -111836,8 +114853,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -111950,7 +114967,7 @@ paths: description: Response content: application/json: - schema: *753 + schema: *754 examples: default: value: @@ -112096,17 +115113,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *465 - *466 - - *755 + - *467 + - *756 responses: '200': description: Response content: application/json: - schema: *753 + schema: *754 examples: - default: *756 + default: *757 '403': *27 '404': *6 x-github: @@ -112130,9 +115147,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *465 - *466 - - *755 + - *467 + - *756 requestBody: required: true content: @@ -112212,7 +115229,7 @@ paths: login: type: string description: The username of the user credited. - type: *449 + type: *450 required: - login - type @@ -112303,10 +115320,10 @@ paths: description: Response content: application/json: - schema: *753 + schema: *754 examples: - default: *756 - add_credit: *756 + default: *757 + add_credit: *757 '403': *27 '404': *6 '422': @@ -112344,9 +115361,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *465 - *466 - - *755 + - *467 + - *756 responses: '202': *37 '400': *14 @@ -112373,17 +115390,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *465 - *466 - - *755 + - *467 + - *756 responses: '202': description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: *472 + default: *473 '400': *14 '422': *15 '403': *27 @@ -112409,8 +115426,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-stargazers parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -112506,8 +115523,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *465 - *466 + - *467 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -112516,7 +115533,7 @@ paths: application/json: schema: type: array - items: &757 + items: &758 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -112549,8 +115566,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -112628,8 +115645,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -112723,8 +115740,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *465 - *466 + - *467 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -112878,8 +115895,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *465 - *466 + - *467 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -112889,7 +115906,7 @@ paths: application/json: schema: type: array - items: *757 + items: *758 examples: default: value: @@ -112922,8 +115939,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#create-a-commit-status parameters: - - *465 - *466 + - *467 - name: sha in: path required: true @@ -112979,7 +115996,7 @@ paths: description: Response content: application/json: - schema: *758 + schema: *759 examples: default: value: @@ -113033,8 +116050,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#list-watchers parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -113066,14 +116083,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#get-a-repository-subscription parameters: - - *465 - *466 + - *467 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &759 + schema: &760 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -113146,8 +116163,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#set-a-repository-subscription parameters: - - *465 - *466 + - *467 requestBody: required: false content: @@ -113173,7 +116190,7 @@ paths: description: Response content: application/json: - schema: *759 + schema: *760 examples: default: value: @@ -113200,8 +116217,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#delete-a-repository-subscription parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -113221,8 +116238,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-tags parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -113304,8 +116321,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *465 - *466 + - *467 - name: ref in: path required: true @@ -113341,8 +116358,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-teams parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -113374,8 +116391,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-all-repository-topics parameters: - - *465 - *466 + - *467 - *19 - *17 responses: @@ -113383,7 +116400,7 @@ paths: description: Response content: application/json: - schema: &760 + schema: &761 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -113395,7 +116412,7 @@ paths: required: - names examples: - default: &761 + default: &762 value: names: - octocat @@ -113418,8 +116435,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#replace-all-repository-topics parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -113450,9 +116467,9 @@ paths: description: Response content: application/json: - schema: *760 + schema: *761 examples: - default: *761 + default: *762 '404': *6 '422': *7 x-github: @@ -113473,9 +116490,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-repository-clones parameters: - - *465 - *466 - - &762 + - *467 + - &763 name: per description: The time frame to display results for. in: query @@ -113506,7 +116523,7 @@ paths: - 128 clones: type: array - items: &763 + items: &764 title: Traffic type: object properties: @@ -113593,8 +116610,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-paths parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -113688,8 +116705,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-sources parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -113752,9 +116769,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-page-views parameters: - - *465 - *466 - - *762 + - *467 + - *763 responses: '200': description: Response @@ -113775,7 +116792,7 @@ paths: - 3782 views: type: array - items: *763 + items: *764 required: - uniques - count @@ -113852,8 +116869,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#transfer-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -114126,8 +117143,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -114150,8 +117167,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-vulnerability-alerts parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -114173,8 +117190,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-vulnerability-alerts parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -114200,8 +117217,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *465 - *466 + - *467 - name: ref in: path required: true @@ -114293,9 +117310,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: *472 + default: *473 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -114446,7 +117463,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &771 + - &772 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -114456,7 +117473,7 @@ paths: type: string examples: - members - - &776 + - &777 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -114468,7 +117485,7 @@ paths: format: int32 examples: - 1 - - &777 + - &778 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -114512,7 +117529,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &766 + items: &767 allOf: - type: object required: @@ -114594,7 +117611,7 @@ paths: - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 - meta: &778 + meta: &779 type: object description: The metadata associated with the creation/updates to the user. @@ -114659,30 +117676,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &767 + '400': &768 description: Bad request content: application/json: - schema: *764 + schema: *765 application/scim+json: - schema: *764 - '401': *765 - '403': &768 + schema: *765 + '401': *766 + '403': &769 description: Permission denied - '429': &769 + '429': &770 description: Too many requests content: application/json: - schema: *764 + schema: *765 application/scim+json: - schema: *764 - '500': &770 + schema: *765 + '500': &771 description: Internal server error content: application/json: - schema: *764 + schema: *765 application/scim+json: - schema: *764 + schema: *765 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -114706,7 +117723,7 @@ paths: required: true content: application/json: - schema: &774 + schema: &775 type: object required: - schemas @@ -114770,9 +117787,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *766 + schema: *767 examples: - group: &772 + group: &773 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -114791,13 +117808,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *767 - '401': *765 - '403': *768 - '409': &775 + '400': *768 + '401': *766 + '403': *769 + '409': &776 description: Duplicate record detected - '429': *769 - '500': *770 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -114814,7 +117831,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - - &773 + - &774 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -114823,22 +117840,22 @@ paths: type: string examples: - 7fce0092-d52e-4f76-b727-3955bd72c939 - - *771 + - *772 - *39 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *766 + schema: *767 examples: - default: *772 - '400': *767 - '401': *765 - '403': *768 + default: *773 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '429': *769 - '500': *770 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -114857,13 +117874,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - - *773 + - *774 - *39 requestBody: required: true content: application/json: - schema: *774 + schema: *775 examples: group: summary: Group @@ -114889,17 +117906,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *766 + schema: *767 examples: - group: *772 - groupWithMembers: *772 - '400': *767 - '401': *765 - '403': *768 + group: *773 + groupWithMembers: *773 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '409': *775 - '429': *769 - '500': *770 + '409': *776 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -114923,13 +117940,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - - *773 + - *774 - *39 requestBody: required: true content: application/json: - schema: &785 + schema: &786 type: object required: - Operations @@ -114989,17 +118006,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *766 + schema: *767 examples: - updateGroup: *772 - addMembers: *772 - '400': *767 - '401': *765 - '403': *768 + updateGroup: *773 + addMembers: *773 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '409': *775 - '429': *769 - '500': *770 + '409': *776 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -115015,17 +118032,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - - *773 + - *774 - *39 responses: '204': description: Group was deleted, no content - '400': *767 - '401': *765 - '403': *768 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '429': *769 - '500': *770 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -115059,8 +118076,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *776 - *777 + - *778 - *39 responses: '200': @@ -115094,7 +118111,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &780 + items: &781 allOf: - type: object required: @@ -115186,7 +118203,7 @@ paths: address. examples: - true - roles: &779 + roles: &780 type: array description: The roles assigned to the user. items: @@ -115245,7 +118262,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *778 + meta: *779 startIndex: type: integer description: A starting index for the returned page @@ -115284,11 +118301,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *767 - '401': *765 - '403': *768 - '429': *769 - '500': *770 + '400': *768 + '401': *766 + '403': *769 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -115312,7 +118329,7 @@ paths: required: true content: application/json: - schema: &783 + schema: &784 type: object required: - schemas @@ -115405,9 +118422,9 @@ paths: description: Whether this email address is the primary address. examples: - true - roles: *779 + roles: *780 examples: - user: &784 + user: &785 summary: User value: schemas: @@ -115454,9 +118471,9 @@ paths: description: User has been created content: application/scim+json: - schema: *780 + schema: *781 examples: - user: &781 + user: &782 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -115482,13 +118499,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 - enterpriseOwner: *781 - '400': *767 - '401': *765 - '403': *768 - '409': *775 - '429': *769 - '500': *770 + enterpriseOwner: *782 + '400': *768 + '401': *766 + '403': *769 + '409': *776 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -115505,7 +118522,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - - &782 + - &783 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -115518,15 +118535,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *780 + schema: *781 examples: - default: *781 - '400': *767 - '401': *765 - '403': *768 + default: *782 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '429': *769 - '500': *770 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -115577,30 +118594,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - - *782 + - *783 - *39 requestBody: required: true content: application/json: - schema: *783 + schema: *784 examples: - user: *784 + user: *785 responses: '200': description: User was updated content: application/scim+json: - schema: *780 + schema: *781 examples: - user: *781 - '400': *767 - '401': *765 - '403': *768 + user: *782 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '409': *775 - '429': *769 - '500': *770 + '409': *776 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -115641,13 +118658,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - - *782 + - *783 - *39 requestBody: required: true content: application/json: - schema: *785 + schema: *786 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -115687,18 +118704,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *780 - examples: - userMultiValuedProperties: *781 - userSingleValuedProperties: *781 - disableUser: *781 - '400': *767 - '401': *765 - '403': *768 + schema: *781 + examples: + userMultiValuedProperties: *782 + userSingleValuedProperties: *782 + disableUser: *782 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '409': *775 - '429': *769 - '500': *770 + '409': *776 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -115718,17 +118735,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - - *782 + - *783 - *39 responses: '204': description: User was deleted, no content - '400': *767 - '401': *765 - '403': *768 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '429': *769 - '500': *770 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -115819,7 +118836,7 @@ paths: - 1 Resources: type: array - items: &786 + items: &787 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -116066,22 +119083,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *35 - '404': &787 + '404': &788 description: Resource not found content: application/json: - schema: *764 + schema: *765 application/scim+json: - schema: *764 - '403': &788 + schema: *765 + '403': &789 description: Forbidden content: application/json: - schema: *764 + schema: *765 application/scim+json: - schema: *764 - '400': *767 - '429': *769 + schema: *765 + '400': *768 + '429': *770 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -116107,9 +119124,9 @@ paths: description: Response content: application/scim+json: - schema: *786 + schema: *787 examples: - default: &789 + default: &790 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -116132,17 +119149,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *35 - '404': *787 - '403': *788 - '500': *770 + '404': *788 + '403': *789 + '500': *771 '409': description: Conflict content: application/json: - schema: *764 + schema: *765 application/scim+json: - schema: *764 - '400': *767 + schema: *765 + '400': *768 requestBody: required: true content: @@ -116242,17 +119259,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *87 - - *782 + - *783 responses: '200': description: Response content: application/scim+json: - schema: *786 + schema: *787 examples: - default: *789 - '404': *787 - '403': *788 + default: *790 + '404': *788 + '403': *789 '304': *35 x-github: githubCloudOnly: true @@ -116276,18 +119293,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-a-provisioned-organization-membership parameters: - *87 - - *782 + - *783 responses: '200': description: Response content: application/scim+json: - schema: *786 + schema: *787 examples: - default: *789 + default: *790 '304': *35 - '404': *787 - '403': *788 + '404': *788 + '403': *789 requestBody: required: true content: @@ -116402,19 +119419,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *87 - - *782 + - *783 responses: '200': description: Response content: application/scim+json: - schema: *786 + schema: *787 examples: - default: *789 + default: *790 '304': *35 - '404': *787 - '403': *788 - '400': *767 + '404': *788 + '403': *789 + '400': *768 '429': description: Response content: @@ -116510,12 +119527,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *87 - - *782 + - *783 responses: '204': description: Response - '404': *787 - '403': *788 + '404': *788 + '403': *789 '304': *35 x-github: githubCloudOnly: true @@ -116652,7 +119669,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &790 + text_matches: &791 title: Search Result Text Matches type: array items: @@ -116816,7 +119833,7 @@ paths: enum: - author-date - committer-date - - &791 + - &792 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -116885,7 +119902,7 @@ paths: committer: anyOf: - type: 'null' - - *516 + - *517 comment_count: type: integer message: @@ -116904,7 +119921,7 @@ paths: url: type: string format: uri - verification: *640 + verification: *641 required: - author - committer @@ -116919,7 +119936,7 @@ paths: committer: anyOf: - type: 'null' - - *516 + - *517 parents: type: array items: @@ -116936,7 +119953,7 @@ paths: type: number node_id: type: string - text_matches: *790 + text_matches: *791 required: - sha - node_id @@ -117129,7 +120146,7 @@ paths: - interactions - created - updated - - *791 + - *792 - *17 - *19 - name: advanced_search @@ -117243,11 +120260,11 @@ paths: type: - string - 'null' - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: type: string state_reason: @@ -117271,7 +120288,7 @@ paths: - string - 'null' format: date-time - text_matches: *790 + text_matches: *791 pull_request: type: object properties: @@ -117535,7 +120552,7 @@ paths: enum: - created - updated - - *791 + - *792 - *17 - *19 responses: @@ -117580,7 +120597,7 @@ paths: - 'null' score: type: number - text_matches: *790 + text_matches: *791 required: - id - node_id @@ -117666,7 +120683,7 @@ paths: - forks - help-wanted-issues - updated - - *791 + - *792 - *17 - *19 responses: @@ -117912,7 +120929,7 @@ paths: - admin - pull - push - text_matches: *790 + text_matches: *791 temp_clone_token: type: string allow_merge_commit: @@ -118221,7 +121238,7 @@ paths: - string - 'null' format: uri - text_matches: *790 + text_matches: *791 related: type: - array @@ -118416,7 +121433,7 @@ paths: - followers - repositories - joined - - *791 + - *792 - *17 - *19 responses: @@ -118526,7 +121543,7 @@ paths: type: - boolean - 'null' - text_matches: *790 + text_matches: *791 blog: type: - string @@ -118608,7 +121625,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#get-a-team-legacy parameters: - - &794 + - &795 name: team_id description: The unique identifier of the team. in: path @@ -118620,9 +121637,9 @@ paths: description: Response content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 '404': *6 x-github: githubCloudOnly: false @@ -118649,7 +121666,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#update-a-team-legacy parameters: - - *794 + - *795 requestBody: required: true content: @@ -118713,16 +121730,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 '201': description: Response content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 '404': *6 '422': *15 '403': *27 @@ -118750,7 +121767,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#delete-a-team-legacy parameters: - - *794 + - *795 responses: '204': description: Response @@ -118779,7 +121796,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *794 + - *795 - *17 - *19 responses: @@ -118817,7 +121834,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-team-members-legacy parameters: - - *794 + - *795 - name: role description: Filters members returned by their role in the team. in: query @@ -118868,7 +121885,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-member-legacy parameters: - - *794 + - *795 - *140 responses: '204': @@ -118905,7 +121922,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-team-member-legacy parameters: - - *794 + - *795 - *140 responses: '204': @@ -118945,7 +121962,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-member-legacy parameters: - - *794 + - *795 - *140 responses: '204': @@ -118982,16 +121999,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *794 + - *795 - *140 responses: '200': description: Response content: application/json: - schema: *464 + schema: *465 examples: - response-if-user-is-a-team-maintainer: *795 + response-if-user-is-a-team-maintainer: *796 '404': *6 x-github: githubCloudOnly: false @@ -119024,7 +122041,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *794 + - *795 - *140 requestBody: required: false @@ -119050,9 +122067,9 @@ paths: description: Response content: application/json: - schema: *464 + schema: *465 examples: - response-if-users-membership-with-team-is-now-pending: *796 + response-if-users-membership-with-team-is-now-pending: *797 '403': description: Forbidden if team synchronization is set up '422': @@ -119086,7 +122103,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *794 + - *795 - *140 responses: '204': @@ -119114,7 +122131,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-team-repositories-legacy parameters: - - *794 + - *795 - *17 - *19 responses: @@ -119156,15 +122173,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *794 - - *465 + - *795 - *466 + - *467 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *797 + schema: *798 examples: alternative-response-with-extra-repository-information: value: @@ -119314,9 +122331,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *794 - - *465 + - *795 - *466 + - *467 requestBody: required: false content: @@ -119366,9 +122383,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *794 - - *465 + - *795 - *466 + - *467 responses: '204': description: Response @@ -119397,15 +122414,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - - *794 + - *795 responses: '200': description: Response content: application/json: - schema: *467 + schema: *468 examples: - default: *468 + default: *469 '403': *27 '404': *6 x-github: @@ -119432,7 +122449,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - - *794 + - *795 requestBody: required: true content: @@ -119493,7 +122510,7 @@ paths: description: Response content: application/json: - schema: *467 + schema: *468 examples: default: value: @@ -119524,7 +122541,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-child-teams-legacy parameters: - - *794 + - *795 - *17 - *19 responses: @@ -119536,7 +122553,7 @@ paths: type: array items: *307 examples: - response-if-child-teams-exist: *798 + response-if-child-teams-exist: *799 headers: Link: *45 '404': *6 @@ -119569,7 +122586,7 @@ paths: application/json: schema: oneOf: - - &799 + - &800 title: Private User description: Private User type: object @@ -119819,7 +122836,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - &824 + - &825 title: Public User description: Public User type: object @@ -120153,7 +123170,7 @@ paths: description: Response content: application/json: - schema: *799 + schema: *800 examples: default: value: @@ -120499,7 +123516,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -120507,7 +123524,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '401': *23 '403': *27 '404': *6 @@ -120551,7 +123568,7 @@ paths: type: integer secrets: type: array - items: &800 + items: &801 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -120593,7 +123610,7 @@ paths: - visibility - selected_repositories_url examples: - default: *570 + default: *571 headers: Link: *45 x-github: @@ -120671,7 +123688,7 @@ paths: description: Response content: application/json: - schema: *800 + schema: *801 examples: default: value: @@ -120969,7 +123986,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '304': *35 '500': *38 '401': *23 @@ -121027,7 +124044,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '401': *23 '403': *27 '404': *6 @@ -121084,7 +124101,7 @@ paths: description: Response content: application/json: - schema: &801 + schema: &802 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -121137,7 +124154,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &802 + default: &803 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -121182,9 +124199,9 @@ paths: description: Response content: application/json: - schema: *801 + schema: *802 examples: - default: *802 + default: *803 '404': *6 x-github: githubCloudOnly: false @@ -121221,9 +124238,9 @@ paths: type: integer machines: type: array - items: *569 + items: *570 examples: - default: *803 + default: *804 '304': *35 '500': *38 '401': *23 @@ -121308,11 +124325,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *470 + repository: *471 machine: anyOf: - type: 'null' - - *569 + - *570 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -122117,7 +125134,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '304': *35 '500': *38 '400': *14 @@ -122157,7 +125174,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '500': *38 '401': *23 '403': *27 @@ -122189,7 +125206,7 @@ paths: type: array items: *395 examples: - default: &814 + default: &815 value: - id: 197 name: hello_docker @@ -122290,7 +125307,7 @@ paths: application/json: schema: type: array - items: &804 + items: &805 title: Email description: Email type: object @@ -122360,9 +125377,9 @@ paths: application/json: schema: type: array - items: *804 + items: *805 examples: - default: &816 + default: &817 value: - email: octocat@github.com verified: true @@ -122439,7 +125456,7 @@ paths: application/json: schema: type: array - items: *804 + items: *805 examples: default: value: @@ -122697,7 +125714,7 @@ paths: application/json: schema: type: array - items: &805 + items: &806 title: GPG Key description: A unique encryption key type: object @@ -122842,7 +125859,7 @@ paths: - subkeys - revoked examples: - default: &834 + default: &835 value: - id: 3 name: Octocat's GPG Key @@ -122927,9 +125944,9 @@ paths: description: Response content: application/json: - schema: *805 + schema: *806 examples: - default: &806 + default: &807 value: id: 3 name: Octocat's GPG Key @@ -122986,7 +126003,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &807 + - &808 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -122998,9 +126015,9 @@ paths: description: Response content: application/json: - schema: *805 + schema: *806 examples: - default: *806 + default: *807 '404': *6 '304': *35 '403': *27 @@ -123023,7 +126040,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *807 + - *808 responses: '204': description: Response @@ -123331,7 +126348,7 @@ paths: required: true content: application/json: - schema: *650 + schema: *651 examples: default: value: @@ -123481,7 +126498,7 @@ paths: application/json: schema: type: array - items: &808 + items: &809 title: Key description: Key type: object @@ -123584,9 +126601,9 @@ paths: description: Response content: application/json: - schema: *808 + schema: *809 examples: - default: &809 + default: &810 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -123619,15 +126636,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *681 + - *682 responses: '200': description: Response content: application/json: - schema: *808 + schema: *809 examples: - default: *809 + default: *810 '404': *6 '304': *35 '403': *27 @@ -123650,7 +126667,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *681 + - *682 responses: '204': description: Response @@ -123683,7 +126700,7 @@ paths: application/json: schema: type: array - items: &810 + items: &811 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -123762,7 +126779,7 @@ paths: - account - plan examples: - default: &811 + default: &812 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -123824,9 +126841,9 @@ paths: application/json: schema: type: array - items: *810 + items: *811 examples: - default: *811 + default: *812 headers: Link: *45 '304': *35 @@ -124844,7 +127861,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#unlock-a-user-repository parameters: - *391 - - *812 + - *813 responses: '204': description: Response @@ -124957,7 +127974,7 @@ paths: - docker - nuget - container - - *813 + - *814 - *19 - *17 responses: @@ -124969,8 +127986,8 @@ paths: type: array items: *395 examples: - default: *814 - '400': *815 + default: *815 + '400': *816 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -124999,7 +128016,7 @@ paths: application/json: schema: *395 examples: - default: &835 + default: &836 value: id: 40201 name: octo-name @@ -125361,9 +128378,9 @@ paths: application/json: schema: type: array - items: *804 + items: *805 examples: - default: *816 + default: *817 headers: Link: *45 '304': *35 @@ -125476,7 +128493,7 @@ paths: type: array items: *78 examples: - default: &823 + default: &824 summary: Default response value: - id: 1296269 @@ -125794,9 +128811,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: *472 + default: *473 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -125835,9 +128852,9 @@ paths: application/json: schema: type: array - items: *652 + items: *653 examples: - default: *817 + default: *818 headers: Link: *45 '304': *35 @@ -125917,7 +128934,7 @@ paths: application/json: schema: type: array - items: &818 + items: &819 title: Social account description: Social media account type: object @@ -125934,7 +128951,7 @@ paths: - provider - url examples: - default: &819 + default: &820 value: - provider: twitter url: https://twitter.com/github @@ -125997,9 +129014,9 @@ paths: application/json: schema: type: array - items: *818 + items: *819 examples: - default: *819 + default: *820 '422': *15 '304': *35 '404': *6 @@ -126087,7 +129104,7 @@ paths: application/json: schema: type: array - items: &820 + items: &821 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -126107,7 +129124,7 @@ paths: - title - created_at examples: - default: &849 + default: &850 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -126172,9 +129189,9 @@ paths: description: Response content: application/json: - schema: *820 + schema: *821 examples: - default: &821 + default: &822 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -126204,7 +129221,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &822 + - &823 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -126216,9 +129233,9 @@ paths: description: Response content: application/json: - schema: *820 + schema: *821 examples: - default: *821 + default: *822 '404': *6 '304': *35 '403': *27 @@ -126241,7 +129258,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *822 + - *823 responses: '204': description: Response @@ -126270,7 +129287,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &850 + - &851 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -126295,11 +129312,11 @@ paths: type: array items: *78 examples: - default-response: *823 + default-response: *824 application/vnd.github.v3.star+json: schema: type: array - items: &851 + items: &852 title: Starred Repository description: Starred Repository type: object @@ -126455,8 +129472,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *465 - *466 + - *467 responses: '204': description: Response if this repository is starred by you @@ -126484,8 +129501,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -126509,8 +129526,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -126582,7 +129599,7 @@ paths: application/json: schema: type: array - items: *457 + items: *458 examples: default: value: @@ -126668,10 +129685,10 @@ paths: application/json: schema: oneOf: - - *799 - - *824 + - *800 + - *825 examples: - default-response: &828 + default-response: &829 summary: Default response value: login: octocat @@ -126706,7 +129723,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &829 + response-with-git-hub-plan-information: &830 summary: Response with GitHub plan information value: login: octocat @@ -126763,7 +129780,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &826 + - &827 name: user_id description: The unique identifier of the user. in: path @@ -126829,7 +129846,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/users#list-users parameters: - - *825 + - *826 - *17 responses: '200': @@ -126864,7 +129881,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *826 + - *827 - *413 requestBody: required: true @@ -126939,7 +129956,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *827 + schema: *828 examples: table_view: summary: Response for creating a table view @@ -126991,11 +130008,11 @@ paths: application/json: schema: oneOf: - - *799 - - *824 + - *800 + - *825 examples: - default-response: *828 - response-with-git-hub-plan-information: *829 + default-response: *829 + response-with-git-hub-plan-information: *830 '404': *6 x-github: githubCloudOnly: false @@ -127045,8 +130062,8 @@ paths: required: - subject_digests examples: - default: *830 - withPredicateType: *831 + default: *831 + withPredicateType: *832 responses: '200': description: Response @@ -127086,7 +130103,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *832 + default: *833 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -127275,7 +130292,7 @@ paths: initiator: type: string examples: - default: *512 + default: *513 '201': description: Response content: @@ -127559,7 +130576,7 @@ paths: application/json: schema: *322 examples: - default: &833 + default: &834 summary: Example response for a user copilot space value: id: 42 @@ -127660,7 +130677,7 @@ paths: application/json: schema: *322 examples: - default: *833 + default: *834 '403': *27 '404': *6 x-github: @@ -127786,7 +130803,7 @@ paths: application/json: schema: *322 examples: - default: *833 + default: *834 '403': *27 '404': *6 '422': *15 @@ -128554,7 +131571,7 @@ paths: type: array items: *395 examples: - default: *814 + default: *815 '403': *27 '401': *23 x-github: @@ -128938,9 +131955,9 @@ paths: application/json: schema: type: array - items: *805 + items: *806 examples: - default: *834 + default: *835 headers: Link: *45 x-github: @@ -129169,7 +132186,7 @@ paths: - docker - nuget - container - - *813 + - *814 - *140 - *19 - *17 @@ -129182,10 +132199,10 @@ paths: type: array items: *395 examples: - default: *814 + default: *815 '403': *27 '401': *23 - '400': *815 + '400': *816 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -129215,7 +132232,7 @@ paths: application/json: schema: *395 examples: - default: *835 + default: *836 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -129564,7 +132581,7 @@ paths: type: array items: *416 examples: - default: *836 + default: *837 headers: Link: *45 '304': *35 @@ -129624,7 +132641,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *837 + items: *838 required: - name - data_type @@ -129640,7 +132657,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *838 + iteration_configuration: *839 required: - name - data_type @@ -129662,8 +132679,8 @@ paths: value: name: Due date data_type: date - single_select_field: *839 - iteration_field: *840 + single_select_field: *840 + iteration_field: *841 responses: '201': description: Response @@ -129671,11 +132688,11 @@ paths: application/json: schema: *416 examples: - text_field: *841 - number_field: *842 - date_field: *843 - single_select_field: *844 - iteration_field: *845 + text_field: *842 + number_field: *843 + date_field: *844 + single_select_field: *845 + iteration_field: *846 '304': *35 '403': *27 '401': *23 @@ -129697,7 +132714,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-user parameters: - *413 - - *846 + - *847 - *140 responses: '200': @@ -129706,7 +132723,7 @@ paths: application/json: schema: *416 examples: - default: *847 + default: *848 headers: Link: *45 '304': *35 @@ -130063,7 +133080,7 @@ paths: parameters: - *413 - *140 - - *848 + - *849 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -130342,9 +133359,9 @@ paths: application/json: schema: type: array - items: *818 + items: *819 examples: - default: *819 + default: *820 headers: Link: *45 x-github: @@ -130374,9 +133391,9 @@ paths: application/json: schema: type: array - items: *820 + items: *821 examples: - default: *849 + default: *850 headers: Link: *45 x-github: @@ -130401,7 +133418,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *140 - - *850 + - *851 - *110 - *17 - *19 @@ -130413,11 +133430,11 @@ paths: schema: anyOf: - type: array - items: *851 + items: *852 - type: array items: *78 examples: - default-response: *823 + default-response: *824 headers: Link: *45 x-github: @@ -130577,7 +133594,7 @@ webhooks: type: string enum: - disabled - enterprise: &852 + enterprise: &853 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -130646,7 +133663,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &853 + installation: &854 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -130667,7 +133684,7 @@ webhooks: required: - id - node_id - organization: &854 + organization: &855 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -130740,7 +133757,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &855 + repository: &856 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -131655,10 +134672,10 @@ webhooks: type: string enum: - enabled - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -131734,11 +134751,11 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - rule: &856 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + rule: &857 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -131961,11 +134978,11 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - rule: *856 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + rule: *857 sender: *4 required: - action @@ -132153,11 +135170,11 @@ webhooks: - everyone required: - from - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - rule: *856 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + rule: *857 sender: *4 required: - action @@ -132230,7 +135247,7 @@ webhooks: required: true content: application/json: - schema: &876 + schema: &877 title: Exemption request cancellation event type: object properties: @@ -132238,11 +135255,11 @@ webhooks: type: string enum: - cancelled - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - exemption_request: &857 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + exemption_request: &858 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -132551,7 +135568,7 @@ webhooks: - array - 'null' description: The responses to the exemption request. - items: &858 + items: &859 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -132663,7 +135680,7 @@ webhooks: required: true content: application/json: - schema: &877 + schema: &878 title: Exemption request completed event type: object properties: @@ -132671,11 +135688,11 @@ webhooks: type: string enum: - completed - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - exemption_request: *857 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + exemption_request: *858 sender: *4 required: - action @@ -132747,7 +135764,7 @@ webhooks: required: true content: application/json: - schema: &874 + schema: &875 title: Exemption request created event type: object properties: @@ -132755,11 +135772,11 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - exemption_request: *857 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + exemption_request: *858 sender: *4 required: - action @@ -132831,7 +135848,7 @@ webhooks: required: true content: application/json: - schema: &878 + schema: &879 title: Exemption response dismissed event type: object properties: @@ -132839,12 +135856,12 @@ webhooks: type: string enum: - response_dismissed - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - exemption_request: *857 - exemption_response: *858 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + exemption_request: *858 + exemption_response: *859 sender: *4 required: - action @@ -132918,7 +135935,7 @@ webhooks: required: true content: application/json: - schema: &875 + schema: &876 title: Exemption response submitted event type: object properties: @@ -132926,12 +135943,12 @@ webhooks: type: string enum: - response_submitted - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - exemption_request: *857 - exemption_response: *858 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + exemption_request: *858 + exemption_response: *859 sender: *4 required: - action @@ -133015,7 +136032,7 @@ webhooks: type: string enum: - completed - check_run: &860 + check_run: &861 title: CheckRun description: A check performed on the code of a given code change type: object @@ -133125,7 +136142,7 @@ webhooks: - examples: - neutral - deployment: *859 + deployment: *860 details_url: type: string examples: @@ -133223,10 +136240,10 @@ webhooks: - output - app - pull_requests - installation: *853 - enterprise: *852 - organization: *854 - repository: *855 + installation: *854 + enterprise: *853 + organization: *855 + repository: *856 sender: *4 required: - check_run @@ -133617,11 +136634,11 @@ webhooks: type: string enum: - created - check_run: *860 - installation: *853 - enterprise: *852 - organization: *854 - repository: *855 + check_run: *861 + installation: *854 + enterprise: *853 + organization: *855 + repository: *856 sender: *4 required: - check_run @@ -134015,11 +137032,11 @@ webhooks: type: string enum: - requested_action - check_run: *860 - installation: *853 - enterprise: *852 - organization: *854 - repository: *855 + check_run: *861 + installation: *854 + enterprise: *853 + organization: *855 + repository: *856 requested_action: description: The action requested by the user. type: object @@ -134422,11 +137439,11 @@ webhooks: type: string enum: - rerequested - check_run: *860 - installation: *853 - enterprise: *852 - organization: *854 - repository: *855 + check_run: *861 + installation: *854 + enterprise: *853 + organization: *855 + repository: *856 sender: *4 required: - check_run @@ -135411,10 +138428,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -136118,10 +139135,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -136819,10 +139836,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -136991,7 +140008,7 @@ webhooks: required: - login - id - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -137143,20 +140160,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &861 + commit_oid: &862 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *852 - installation: *853 - organization: *854 - ref: &862 + enterprise: *853 + installation: *854 + organization: *855 + ref: &863 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *855 + repository: *856 sender: *4 required: - action @@ -137323,7 +140340,7 @@ webhooks: required: - login - id - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -137564,12 +140581,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *861 - enterprise: *852 - installation: *853 - organization: *854 - ref: *862 - repository: *855 + commit_oid: *862 + enterprise: *853 + installation: *854 + organization: *855 + ref: *863 + repository: *856 sender: *4 required: - action @@ -137667,7 +140684,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -137852,12 +140869,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *861 - enterprise: *852 - installation: *853 - organization: *854 - ref: *862 - repository: *855 + commit_oid: *862 + enterprise: *853 + installation: *854 + organization: *855 + ref: *863 + repository: *856 sender: *4 required: - action @@ -138026,7 +141043,7 @@ webhooks: required: - login - id - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -138203,12 +141220,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *861 - enterprise: *852 - installation: *853 - organization: *854 - ref: *862 - repository: *855 + commit_oid: *862 + enterprise: *853 + installation: *854 + organization: *855 + ref: *863 + repository: *856 sender: *4 required: - action @@ -138309,7 +141326,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -138498,9 +141515,9 @@ webhooks: type: - string - 'null' - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -138508,7 +141525,7 @@ webhooks: type: - string - 'null' - repository: *855 + repository: *856 sender: *4 required: - action @@ -138607,7 +141624,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -138754,12 +141771,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *861 - enterprise: *852 - installation: *853 - organization: *854 - ref: *862 - repository: *855 + commit_oid: *862 + enterprise: *853 + installation: *854 + organization: *855 + ref: *863 + repository: *856 sender: *4 required: - action @@ -138928,7 +141945,7 @@ webhooks: required: - login - id - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -139080,10 +142097,10 @@ webhooks: - dismissed_reason - rule - tool - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -139343,10 +142360,10 @@ webhooks: - updated_at - author_association - body - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -139427,18 +142444,18 @@ webhooks: type: - string - 'null' - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *854 - pusher_type: &863 + organization: *855 + pusher_type: &864 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &864 + ref: &865 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference) resource. type: string @@ -139448,7 +142465,7 @@ webhooks: enum: - tag - branch - repository: *855 + repository: *856 sender: *4 required: - ref @@ -139531,9 +142548,9 @@ webhooks: enum: - created definition: *153 - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 sender: *4 required: - action @@ -139618,9 +142635,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 sender: *4 required: - action @@ -139698,9 +142715,9 @@ webhooks: enum: - promote_to_enterprise definition: *153 - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 sender: *4 required: - action @@ -139778,9 +142795,9 @@ webhooks: enum: - updated definition: *153 - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 sender: *4 required: - action @@ -139857,10 +142874,10 @@ webhooks: type: string enum: - updated - enterprise: *852 - installation: *853 - repository: *855 - organization: *854 + enterprise: *853 + installation: *854 + repository: *856 + organization: *855 sender: *4 new_property_values: type: array @@ -139945,18 +142962,18 @@ webhooks: title: delete event type: object properties: - enterprise: *852 - installation: *853 - organization: *854 - pusher_type: *863 - ref: *864 + enterprise: *853 + installation: *854 + organization: *855 + pusher_type: *864 + ref: *865 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *855 + repository: *856 sender: *4 required: - ref @@ -140036,11 +143053,11 @@ webhooks: type: string enum: - assignees_changed - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -140120,11 +143137,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -140205,11 +143222,11 @@ webhooks: type: string enum: - auto_reopened - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -140290,11 +143307,11 @@ webhooks: type: string enum: - created - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -140373,11 +143390,11 @@ webhooks: type: string enum: - dismissed - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -140456,11 +143473,11 @@ webhooks: type: string enum: - fixed - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -140540,11 +143557,11 @@ webhooks: type: string enum: - reintroduced - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -140623,11 +143640,11 @@ webhooks: type: string enum: - reopened - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -140704,9 +143721,9 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - key: &865 + enterprise: *853 + installation: *854 + key: &866 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -140744,8 +143761,8 @@ webhooks: - verified - created_at - read_only - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -140822,11 +143839,11 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - key: *865 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + key: *866 + organization: *855 + repository: *856 sender: *4 required: - action @@ -141393,12 +144410,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - workflow: &869 + workflow: &870 title: Workflow type: - object @@ -142149,13 +145166,13 @@ webhooks: deployment: anyOf: - type: 'null' - - *607 + - *608 pull_requests: type: array - items: *701 - repository: *855 - organization: *854 - installation: *853 + items: *702 + repository: *856 + organization: *855 + installation: *854 sender: *4 responses: '200': @@ -142226,7 +145243,7 @@ webhooks: type: string enum: - approved - approver: &866 + approver: &867 type: object properties: avatar_url: @@ -142269,11 +145286,11 @@ webhooks: type: string comment: type: string - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - reviewers: &867 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + reviewers: &868 type: array items: type: object @@ -142354,7 +145371,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &868 + workflow_job_run: &869 type: object properties: conclusion: @@ -143100,18 +146117,18 @@ webhooks: type: string enum: - rejected - approver: *866 + approver: *867 comment: type: string - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - reviewers: *867 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + reviewers: *868 sender: *4 since: type: string - workflow_job_run: *868 + workflow_job_run: *869 workflow_job_runs: type: array items: @@ -143828,13 +146845,13 @@ webhooks: type: string enum: - requested - enterprise: *852 + enterprise: *853 environment: type: string - installation: *853 - organization: *854 - repository: *855 - requestor: &879 + installation: *854 + organization: *855 + repository: *856 + requestor: &880 title: User type: - object @@ -145767,12 +148784,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - workflow: *869 + workflow: *870 workflow_run: title: Deployment Workflow Run type: @@ -146463,7 +149480,7 @@ webhooks: type: string enum: - answered - answer: &872 + answer: &873 type: object properties: author_association: @@ -146623,11 +149640,11 @@ webhooks: - created_at - updated_at - body - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -146754,11 +149771,11 @@ webhooks: - from required: - category - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -146841,11 +149858,11 @@ webhooks: type: string enum: - closed - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -146927,7 +149944,7 @@ webhooks: type: string enum: - created - comment: &871 + comment: &872 type: object properties: author_association: @@ -147087,11 +150104,11 @@ webhooks: - updated_at - body - reactions - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -147174,12 +150191,12 @@ webhooks: type: string enum: - deleted - comment: *871 - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + comment: *872 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -147274,12 +150291,12 @@ webhooks: - from required: - body - comment: *871 - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + comment: *872 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -147363,11 +150380,11 @@ webhooks: type: string enum: - created - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -147449,11 +150466,11 @@ webhooks: type: string enum: - deleted - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -147553,11 +150570,11 @@ webhooks: type: string required: - from - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -147639,10 +150656,10 @@ webhooks: type: string enum: - labeled - discussion: *870 - enterprise: *852 - installation: *853 - label: &873 + discussion: *871 + enterprise: *853 + installation: *854 + label: &874 title: Label type: object properties: @@ -147675,8 +150692,8 @@ webhooks: - color - default - description - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -147759,11 +150776,11 @@ webhooks: type: string enum: - locked - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -147845,11 +150862,11 @@ webhooks: type: string enum: - pinned - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -147931,11 +150948,11 @@ webhooks: type: string enum: - reopened - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148020,16 +151037,16 @@ webhooks: changes: type: object properties: - new_discussion: *870 - new_repository: *855 + new_discussion: *871 + new_repository: *856 required: - new_discussion - new_repository - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148112,10 +151129,10 @@ webhooks: type: string enum: - unanswered - discussion: *870 - old_answer: *872 - organization: *854 - repository: *855 + discussion: *871 + old_answer: *873 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148197,12 +151214,12 @@ webhooks: type: string enum: - unlabeled - discussion: *870 - enterprise: *852 - installation: *853 - label: *873 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148285,11 +151302,11 @@ webhooks: type: string enum: - unlocked - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148371,11 +151388,11 @@ webhooks: type: string enum: - unpinned - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148444,7 +151461,7 @@ webhooks: required: true content: application/json: - schema: *874 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -148507,7 +151524,7 @@ webhooks: required: true content: application/json: - schema: *875 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -148570,7 +151587,7 @@ webhooks: required: true content: application/json: - schema: *876 + schema: *877 responses: '200': description: Return a 200 status to indicate that the data was received @@ -148633,7 +151650,7 @@ webhooks: required: true content: application/json: - schema: *874 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -148696,7 +151713,7 @@ webhooks: required: true content: application/json: - schema: *875 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -148762,7 +151779,7 @@ webhooks: required: true content: application/json: - schema: *876 + schema: *877 responses: '200': description: Return a 200 status to indicate that the data was received @@ -148828,7 +151845,7 @@ webhooks: required: true content: application/json: - schema: *877 + schema: *878 responses: '200': description: Return a 200 status to indicate that the data was received @@ -148894,7 +151911,7 @@ webhooks: required: true content: application/json: - schema: *874 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -148960,7 +151977,7 @@ webhooks: required: true content: application/json: - schema: *878 + schema: *879 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149026,7 +152043,7 @@ webhooks: required: true content: application/json: - schema: *875 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149091,7 +152108,7 @@ webhooks: required: true content: application/json: - schema: *876 + schema: *877 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149156,7 +152173,7 @@ webhooks: required: true content: application/json: - schema: *877 + schema: *878 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149221,7 +152238,7 @@ webhooks: required: true content: application/json: - schema: *874 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149286,7 +152303,7 @@ webhooks: required: true content: application/json: - schema: *878 + schema: *879 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149352,7 +152369,7 @@ webhooks: required: true content: application/json: - schema: *875 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149419,7 +152436,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *852 + enterprise: *853 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) resource. @@ -150097,9 +153114,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - forkee @@ -150245,9 +153262,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pages: description: The pages that were updated. type: array @@ -150285,7 +153302,7 @@ webhooks: - action - sha - html_url - repository: *855 + repository: *856 sender: *4 required: - pages @@ -150361,10 +153378,10 @@ webhooks: type: string enum: - created - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories: &880 + organization: *855 + repositories: &881 description: An array of repository objects that the installation can access. type: array @@ -150390,8 +153407,8 @@ webhooks: - name - full_name - private - repository: *855 - requester: *879 + repository: *856 + requester: *880 sender: *4 required: - action @@ -150466,11 +153483,11 @@ webhooks: type: string enum: - deleted - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories: *880 - repository: *855 + organization: *855 + repositories: *881 + repository: *856 requester: type: - 'null' @@ -150547,11 +153564,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories: *880 - repository: *855 + organization: *855 + repositories: *881 + repository: *856 requester: type: - 'null' @@ -150628,10 +153645,10 @@ webhooks: type: string enum: - added - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories_added: &881 + organization: *855 + repositories_added: &882 description: An array of repository objects, which were added to the installation. type: array @@ -150677,15 +153694,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *855 - repository_selection: &882 + repository: *856 + repository_selection: &883 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *879 + requester: *880 sender: *4 required: - action @@ -150764,10 +153781,10 @@ webhooks: type: string enum: - removed - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories_added: *881 + organization: *855 + repositories_added: *882 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -150794,9 +153811,9 @@ webhooks: - name - full_name - private - repository: *855 - repository_selection: *882 - requester: *879 + repository: *856 + repository_selection: *883 + requester: *880 sender: *4 required: - action @@ -150875,11 +153892,11 @@ webhooks: type: string enum: - suspend - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories: *880 - repository: *855 + organization: *855 + repositories: *881 + repository: *856 requester: type: - 'null' @@ -151062,10 +154079,10 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 target_type: type: string @@ -151144,11 +154161,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories: *880 - repository: *855 + organization: *855 + repositories: *881 + repository: *856 requester: type: - 'null' @@ -151314,7 +154331,7 @@ webhooks: pin: anyOf: - type: 'null' - - *678 + - *679 user: title: User type: @@ -151400,8 +154417,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -152213,8 +155230,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152575,8 +155592,8 @@ webhooks: - state - locked - assignee - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -152656,7 +155673,7 @@ webhooks: type: string enum: - deleted - comment: &883 + comment: &884 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself. @@ -152813,7 +155830,7 @@ webhooks: pin: anyOf: - type: 'null' - - *678 + - *679 required: - url - html_url @@ -152827,8 +155844,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -153636,8 +156653,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154000,8 +157017,8 @@ webhooks: - state - locked - assignee - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -154081,7 +157098,7 @@ webhooks: type: string enum: - edited - changes: &907 + changes: &908 description: The changes to the comment. type: object properties: @@ -154093,9 +157110,9 @@ webhooks: type: string required: - from - comment: *883 - enterprise: *852 - installation: *853 + comment: *884 + enterprise: *853 + installation: *854 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -154906,8 +157923,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155268,8 +158285,8 @@ webhooks: - state - locked - assignee - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -155350,9 +158367,9 @@ webhooks: type: string enum: - pinned - comment: *883 - enterprise: *852 - installation: *853 + comment: *884 + enterprise: *853 + installation: *854 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -156165,8 +159182,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156529,8 +159546,8 @@ webhooks: - state - locked - assignee - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -156610,9 +159627,9 @@ webhooks: type: string enum: - unpinned - comment: *883 - enterprise: *852 - installation: *853 + comment: *884 + enterprise: *853 + installation: *854 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -157425,8 +160442,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157789,8 +160806,8 @@ webhooks: - state - locked - assignee - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -157879,9 +160896,9 @@ webhooks: type: number blocking_issue: *219 blocking_issue_repo: *78 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -157970,9 +160987,9 @@ webhooks: type: number blocking_issue: *219 blocking_issue_repo: *78 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -158060,9 +161077,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *219 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -158151,9 +161168,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *219 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -158233,10 +161250,10 @@ webhooks: type: string enum: - assigned - assignee: *879 - enterprise: *852 - installation: *853 - issue: &884 + assignee: *880 + enterprise: *853 + installation: *854 + issue: &885 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. @@ -159047,11 +162064,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159171,8 +162188,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -159252,8 +162269,8 @@ webhooks: type: string enum: - closed - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. @@ -160069,11 +163086,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160336,8 +163353,8 @@ webhooks: required: - state - closed_at - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -160416,8 +163433,8 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -161224,11 +164241,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -161347,8 +164364,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -161427,8 +164444,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -162258,11 +165275,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -162360,7 +165377,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &885 + milestone: &886 title: Milestone description: A collection of related issues and pull requests. type: object @@ -162503,8 +165520,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -162603,8 +165620,8 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -163415,11 +166432,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -163539,9 +166556,9 @@ webhooks: - active_lock_reason - body - reactions - label: *873 - organization: *854 - repository: *855 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -163621,9 +166638,9 @@ webhooks: type: string enum: - field_added - enterprise: *852 - installation: *853 - issue: *884 + enterprise: *853 + installation: *854 + issue: *885 issue_field: type: object description: The issue field whose value was set or updated on the @@ -163742,8 +166759,8 @@ webhooks: - id required: - from - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -163823,9 +166840,9 @@ webhooks: type: string enum: - field_removed - enterprise: *852 - installation: *853 - issue: *884 + enterprise: *853 + installation: *854 + issue: *885 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -163888,8 +166905,8 @@ webhooks: - 'null' required: - id - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -163969,8 +166986,8 @@ webhooks: type: string enum: - labeled - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -164780,11 +167797,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -164904,9 +167921,9 @@ webhooks: - active_lock_reason - body - reactions - label: *873 - organization: *854 - repository: *855 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -164986,8 +168003,8 @@ webhooks: type: string enum: - locked - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -165822,11 +168839,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -165923,8 +168940,8 @@ webhooks: format: uri user_view_type: type: string - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -166003,8 +169020,8 @@ webhooks: type: string enum: - milestoned - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -166833,11 +169850,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -166934,9 +169951,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *885 - organization: *854 - repository: *855 + milestone: *886 + organization: *855 + repository: *856 sender: *4 required: - action @@ -167823,11 +170840,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -168419,8 +171436,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -169227,11 +172244,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -169354,8 +172371,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -169435,9 +172452,9 @@ webhooks: type: string enum: - pinned - enterprise: *852 - installation: *853 - issue: &886 + enterprise: *853 + installation: *854 + issue: &887 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. @@ -170242,11 +173259,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -170365,8 +173382,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -170445,8 +173462,8 @@ webhooks: type: string enum: - reopened - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -171279,11 +174296,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -171381,8 +174398,8 @@ webhooks: user_view_type: type: string type: *380 - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -172270,11 +175287,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -172884,11 +175901,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *852 - installation: *853 - issue: *886 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + issue: *887 + organization: *855 + repository: *856 sender: *4 required: - action @@ -172968,12 +175985,12 @@ webhooks: type: string enum: - typed - enterprise: *852 - installation: *853 - issue: *884 + enterprise: *853 + installation: *854 + issue: *885 type: *380 - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -173054,7 +176071,7 @@ webhooks: type: string enum: - unassigned - assignee: &910 + assignee: &911 title: User type: - object @@ -173126,11 +176143,11 @@ webhooks: required: - login - id - enterprise: *852 - installation: *853 - issue: *884 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + issue: *885 + organization: *855 + repository: *856 sender: *4 required: - action @@ -173209,12 +176226,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *852 - installation: *853 - issue: *884 - label: *873 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + issue: *885 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -173294,8 +176311,8 @@ webhooks: type: string enum: - unlocked - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -174128,11 +177145,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -174229,8 +177246,8 @@ webhooks: format: uri user_view_type: type: string - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -174310,11 +177327,11 @@ webhooks: type: string enum: - unpinned - enterprise: *852 - installation: *853 - issue: *886 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + issue: *887 + organization: *855 + repository: *856 sender: *4 required: - action @@ -174393,12 +177410,12 @@ webhooks: type: string enum: - untyped - enterprise: *852 - installation: *853 - issue: *884 + enterprise: *853 + installation: *854 + issue: *885 type: *380 - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -174478,11 +177495,11 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - label: *873 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -174560,11 +177577,11 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - label: *873 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -174674,11 +177691,11 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - label: *873 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -174760,9 +177777,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *852 - installation: *853 - marketplace_purchase: &887 + enterprise: *853 + installation: *854 + marketplace_purchase: &888 title: Marketplace Purchase type: object required: @@ -174850,8 +177867,8 @@ webhooks: type: integer unit_count: type: integer - organization: *854 - previous_marketplace_purchase: &888 + organization: *855 + previous_marketplace_purchase: &889 title: Marketplace Purchase type: object properties: @@ -174935,7 +177952,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *855 + repository: *856 sender: *4 required: - action @@ -175015,10 +178032,10 @@ webhooks: - changed effective_date: type: string - enterprise: *852 - installation: *853 - marketplace_purchase: *887 - organization: *854 + enterprise: *853 + installation: *854 + marketplace_purchase: *888 + organization: *855 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -175106,7 +178123,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *855 + repository: *856 sender: *4 required: - action @@ -175188,10 +178205,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *852 - installation: *853 - marketplace_purchase: *887 - organization: *854 + enterprise: *853 + installation: *854 + marketplace_purchase: *888 + organization: *855 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -175277,7 +178294,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *855 + repository: *856 sender: *4 required: - action @@ -175358,8 +178375,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 marketplace_purchase: title: Marketplace Purchase type: object @@ -175445,9 +178462,9 @@ webhooks: type: integer unit_count: type: integer - organization: *854 - previous_marketplace_purchase: *888 - repository: *855 + organization: *855 + previous_marketplace_purchase: *889 + repository: *856 sender: *4 required: - action @@ -175527,12 +178544,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *852 - installation: *853 - marketplace_purchase: *887 - organization: *854 - previous_marketplace_purchase: *888 - repository: *855 + enterprise: *853 + installation: *854 + marketplace_purchase: *888 + organization: *855 + previous_marketplace_purchase: *889 + repository: *856 sender: *4 required: - action @@ -175634,11 +178651,11 @@ webhooks: type: string required: - to - enterprise: *852 - installation: *853 - member: *879 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + member: *880 + organization: *855 + repository: *856 sender: *4 required: - action @@ -175740,11 +178757,11 @@ webhooks: type: - string - 'null' - enterprise: *852 - installation: *853 - member: *879 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + member: *880 + organization: *855 + repository: *856 sender: *4 required: - action @@ -175823,11 +178840,11 @@ webhooks: type: string enum: - removed - enterprise: *852 - installation: *853 - member: *879 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + member: *880 + organization: *855 + repository: *856 sender: *4 required: - action @@ -175905,11 +178922,11 @@ webhooks: type: string enum: - added - enterprise: *852 - installation: *853 - member: *879 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + member: *880 + organization: *855 + repository: *856 scope: description: The scope of the membership. Currently, can only be `team`. @@ -175987,7 +179004,7 @@ webhooks: required: - login - id - team: &889 + team: &890 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -176217,11 +179234,11 @@ webhooks: type: string enum: - removed - enterprise: *852 - installation: *853 - member: *879 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + member: *880 + organization: *855 + repository: *856 scope: description: The scope of the membership. Currently, can only be `team`. @@ -176300,7 +179317,7 @@ webhooks: required: - login - id - team: *889 + team: *890 required: - action - scope @@ -176382,8 +179399,8 @@ webhooks: type: string enum: - checks_requested - installation: *853 - merge_group: &890 + installation: *854 + merge_group: &891 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -176402,15 +179419,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *532 + head_commit: *533 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -176496,10 +179513,10 @@ webhooks: - merged - invalidated - dequeued - installation: *853 - merge_group: *890 - organization: *854 - repository: *855 + installation: *854 + merge_group: *891 + organization: *855 + repository: *856 sender: *4 required: - action @@ -176572,7 +179589,7 @@ webhooks: type: string enum: - deleted - enterprise: *852 + enterprise: *853 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -176681,12 +179698,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *853 - organization: *854 + installation: *854 + organization: *855 repository: anyOf: - type: 'null' - - *855 + - *856 sender: *4 required: - action @@ -176766,11 +179783,11 @@ webhooks: type: string enum: - closed - enterprise: *852 - installation: *853 - milestone: *885 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + milestone: *886 + organization: *855 + repository: *856 sender: *4 required: - action @@ -176849,9 +179866,9 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - milestone: &891 + enterprise: *853 + installation: *854 + milestone: &892 title: Milestone description: A collection of related issues and pull requests. type: object @@ -176993,8 +180010,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177073,11 +180090,11 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - milestone: *885 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + milestone: *886 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177187,11 +180204,11 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - milestone: *885 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + milestone: *886 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177271,11 +180288,11 @@ webhooks: type: string enum: - opened - enterprise: *852 - installation: *853 - milestone: *891 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + milestone: *892 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177354,11 +180371,11 @@ webhooks: type: string enum: - blocked - blocked_user: *879 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + blocked_user: *880 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177437,11 +180454,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *879 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + blocked_user: *880 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177517,7 +180534,7 @@ webhooks: enum: - created definition: *148 - enterprise: *852 + enterprise: *853 sender: *4 required: - action @@ -177597,8 +180614,8 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 sender: *4 required: - action @@ -177671,8 +180688,8 @@ webhooks: enum: - updated definition: *148 - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 sender: *4 required: - action @@ -177744,9 +180761,9 @@ webhooks: type: string enum: - updated - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 sender: *4 new_property_values: type: array @@ -177834,9 +180851,9 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - membership: &892 + enterprise: *853 + installation: *854 + membership: &893 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -177946,8 +180963,8 @@ webhooks: - role - organization_url - user - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -178025,11 +181042,11 @@ webhooks: type: string enum: - member_added - enterprise: *852 - installation: *853 - membership: *892 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + membership: *893 + organization: *855 + repository: *856 sender: *4 required: - action @@ -178108,8 +181125,8 @@ webhooks: type: string enum: - member_invited - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -178231,10 +181248,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 - user: *879 + user: *880 required: - action - invitation @@ -178312,11 +181329,11 @@ webhooks: type: string enum: - member_removed - enterprise: *852 - installation: *853 - membership: *892 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + membership: *893 + organization: *855 + repository: *856 sender: *4 required: - action @@ -178403,11 +181420,11 @@ webhooks: properties: from: type: string - enterprise: *852 - installation: *853 - membership: *892 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + membership: *893 + organization: *855 + repository: *856 sender: *4 required: - action @@ -178485,9 +181502,9 @@ webhooks: type: string enum: - published - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 package: description: Information about the package. type: object @@ -179010,7 +182027,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &893 + items: &894 title: Ruby Gems metadata type: object properties: @@ -179107,7 +182124,7 @@ webhooks: - owner - package_version - registry - repository: *855 + repository: *856 sender: *4 required: - action @@ -179184,9 +182201,9 @@ webhooks: type: string enum: - updated - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 package: description: Information about the package. type: object @@ -179548,7 +182565,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *893 + items: *894 source_url: type: string format: uri @@ -179619,7 +182636,7 @@ webhooks: - owner - package_version - registry - repository: *855 + repository: *856 sender: *4 required: - action @@ -179799,12 +182816,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *852 + enterprise: *853 id: type: integer - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - id @@ -179881,7 +182898,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &894 + personal_access_token_request: &895 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -180031,10 +183048,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *852 - organization: *854 + enterprise: *853 + organization: *855 sender: *4 - installation: *853 + installation: *854 required: - action - personal_access_token_request @@ -180111,11 +183128,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *894 - enterprise: *852 - organization: *854 + personal_access_token_request: *895 + enterprise: *853 + organization: *855 sender: *4 - installation: *853 + installation: *854 required: - action - personal_access_token_request @@ -180191,11 +183208,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *894 - enterprise: *852 - organization: *854 + personal_access_token_request: *895 + enterprise: *853 + organization: *855 sender: *4 - installation: *853 + installation: *854 required: - action - personal_access_token_request @@ -180270,11 +183287,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *894 - organization: *854 - enterprise: *852 + personal_access_token_request: *895 + organization: *855 + enterprise: *853 sender: *4 - installation: *853 + installation: *854 required: - action - personal_access_token_request @@ -180379,7 +183396,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *895 + last_response: *896 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -180411,8 +183428,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 zen: description: Random string of GitHub zen. @@ -180657,10 +183674,10 @@ webhooks: - from required: - note - enterprise: *852 - installation: *853 - organization: *854 - project_card: &896 + enterprise: *853 + installation: *854 + organization: *855 + project_card: &897 title: Project Card type: object properties: @@ -180783,7 +183800,7 @@ webhooks: - creator - created_at - updated_at - repository: *855 + repository: *856 sender: *4 required: - action @@ -180864,11 +183881,11 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - project_card: *896 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project_card: *897 + repository: *856 sender: *4 required: - action @@ -180948,9 +183965,9 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 project_card: title: Project Card type: object @@ -181080,7 +184097,7 @@ webhooks: repository: anyOf: - type: 'null' - - *855 + - *856 sender: *4 required: - action @@ -181174,11 +184191,11 @@ webhooks: - from required: - note - enterprise: *852 - installation: *853 - organization: *854 - project_card: *896 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project_card: *897 + repository: *856 sender: *4 required: - action @@ -181272,9 +184289,9 @@ webhooks: - from required: - column_id - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 project_card: allOf: - title: Project Card @@ -181471,7 +184488,7 @@ webhooks: type: string required: - after_id - repository: *855 + repository: *856 sender: *4 required: - action @@ -181551,10 +184568,10 @@ webhooks: type: string enum: - closed - enterprise: *852 - installation: *853 - organization: *854 - project: &898 + enterprise: *853 + installation: *854 + organization: *855 + project: &899 title: Project type: object properties: @@ -181681,7 +184698,7 @@ webhooks: - creator - created_at - updated_at - repository: *855 + repository: *856 sender: *4 required: - action @@ -181761,10 +184778,10 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - project_column: &897 + enterprise: *853 + installation: *854 + organization: *855 + project_column: &898 title: Project Column type: object properties: @@ -181804,7 +184821,7 @@ webhooks: - name - created_at - updated_at - repository: *855 + repository: *856 sender: *4 required: - action @@ -181883,14 +184900,14 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - project_column: *897 + enterprise: *853 + installation: *854 + organization: *855 + project_column: *898 repository: anyOf: - type: 'null' - - *855 + - *856 sender: *4 required: - action @@ -181979,11 +184996,11 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - organization: *854 - project_column: *897 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project_column: *898 + repository: *856 sender: *4 required: - action @@ -182063,11 +185080,11 @@ webhooks: type: string enum: - moved - enterprise: *852 - installation: *853 - organization: *854 - project_column: *897 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project_column: *898 + repository: *856 sender: *4 required: - action @@ -182147,11 +185164,11 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - project: *898 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project: *899 + repository: *856 sender: *4 required: - action @@ -182231,14 +185248,14 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - project: *898 + enterprise: *853 + installation: *854 + organization: *855 + project: *899 repository: anyOf: - type: 'null' - - *855 + - *856 sender: *4 required: - action @@ -182339,11 +185356,11 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - organization: *854 - project: *898 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project: *899 + repository: *856 sender: *4 required: - action @@ -182422,11 +185439,11 @@ webhooks: type: string enum: - reopened - enterprise: *852 - installation: *853 - organization: *854 - project: *898 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project: *899 + repository: *856 sender: *4 required: - action @@ -182507,8 +185524,8 @@ webhooks: type: string enum: - closed - installation: *853 - organization: *854 + installation: *854 + organization: *855 projects_v2: *411 sender: *4 required: @@ -182590,8 +185607,8 @@ webhooks: type: string enum: - created - installation: *853 - organization: *854 + installation: *854 + organization: *855 projects_v2: *411 sender: *4 required: @@ -182673,8 +185690,8 @@ webhooks: type: string enum: - deleted - installation: *853 - organization: *854 + installation: *854 + organization: *855 projects_v2: *411 sender: *4 required: @@ -182796,8 +185813,8 @@ webhooks: type: string to: type: string - installation: *853 - organization: *854 + installation: *854 + organization: *855 projects_v2: *411 sender: *4 required: @@ -182881,7 +185898,7 @@ webhooks: type: string enum: - archived - changes: &902 + changes: &903 type: object properties: archived_at: @@ -182897,9 +185914,9 @@ webhooks: - string - 'null' format: date-time - installation: *853 - organization: *854 - projects_v2_item: &899 + installation: *854 + organization: *855 + projects_v2_item: &900 title: Projects v2 Item description: An item belonging to a project type: object @@ -183039,9 +186056,9 @@ webhooks: - 'null' to: type: string - installation: *853 - organization: *854 - projects_v2_item: *899 + installation: *854 + organization: *855 + projects_v2_item: *900 sender: *4 required: - action @@ -183123,9 +186140,9 @@ webhooks: type: string enum: - created - installation: *853 - organization: *854 - projects_v2_item: *899 + installation: *854 + organization: *855 + projects_v2_item: *900 sender: *4 required: - action @@ -183206,9 +186223,9 @@ webhooks: type: string enum: - deleted - installation: *853 - organization: *854 - projects_v2_item: *899 + installation: *854 + organization: *855 + projects_v2_item: *900 sender: *4 required: - action @@ -183313,7 +186330,7 @@ webhooks: oneOf: - type: string - type: integer - - &900 + - &901 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -183337,7 +186354,7 @@ webhooks: required: - id - name - - &901 + - &902 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -183377,8 +186394,8 @@ webhooks: oneOf: - type: string - type: integer - - *900 - *901 + - *902 type: - 'null' - string @@ -183401,9 +186418,9 @@ webhooks: - 'null' required: - body - installation: *853 - organization: *854 - projects_v2_item: *899 + installation: *854 + organization: *855 + projects_v2_item: *900 sender: *4 required: - action @@ -183500,9 +186517,9 @@ webhooks: type: - string - 'null' - installation: *853 - organization: *854 - projects_v2_item: *899 + installation: *854 + organization: *855 + projects_v2_item: *900 sender: *4 required: - action @@ -183585,10 +186602,10 @@ webhooks: type: string enum: - restored - changes: *902 - installation: *853 - organization: *854 - projects_v2_item: *899 + changes: *903 + installation: *854 + organization: *855 + projects_v2_item: *900 sender: *4 required: - action @@ -183670,8 +186687,8 @@ webhooks: type: string enum: - reopened - installation: *853 - organization: *854 + installation: *854 + organization: *855 projects_v2: *411 sender: *4 required: @@ -183753,9 +186770,9 @@ webhooks: type: string enum: - created - installation: *853 - organization: *854 - projects_v2_status_update: *903 + installation: *854 + organization: *855 + projects_v2_status_update: *904 sender: *4 required: - action @@ -183836,9 +186853,9 @@ webhooks: type: string enum: - deleted - installation: *853 - organization: *854 - projects_v2_status_update: *903 + installation: *854 + organization: *855 + projects_v2_status_update: *904 sender: *4 required: - action @@ -183984,9 +187001,9 @@ webhooks: - string - 'null' format: date - installation: *853 - organization: *854 - projects_v2_status_update: *903 + installation: *854 + organization: *855 + projects_v2_status_update: *904 sender: *4 required: - action @@ -184057,10 +187074,10 @@ webhooks: title: public event type: object properties: - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - repository @@ -184137,13 +187154,13 @@ webhooks: type: string enum: - assigned - assignee: *879 - enterprise: *852 - installation: *853 - number: &904 + assignee: *880 + enterprise: *853 + installation: *854 + number: &905 description: The pull request number. type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -186495,7 +189512,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -186577,11 +189594,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -188926,7 +191943,7 @@ webhooks: - draft reason: type: string - repository: *855 + repository: *856 sender: *4 required: - action @@ -189008,11 +192025,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -191357,7 +194374,7 @@ webhooks: - draft reason: type: string - repository: *855 + repository: *856 sender: *4 required: - action @@ -191439,13 +194456,13 @@ webhooks: type: string enum: - closed - enterprise: *852 - installation: *853 - number: *904 - organization: *854 - pull_request: &905 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 + pull_request: &906 allOf: - - *701 + - *702 - type: object properties: allow_auto_merge: @@ -191507,7 +194524,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *855 + repository: *856 sender: *4 required: - action @@ -191588,12 +194605,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *852 - installation: *853 - number: *904 - organization: *854 - pull_request: *905 - repository: *855 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 + pull_request: *906 + repository: *856 sender: *4 required: - action @@ -191673,11 +194690,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *852 + enterprise: *853 milestone: *414 - number: *904 - organization: *854 - pull_request: &906 + number: *905 + organization: *855 + pull_request: &907 title: Pull Request type: object properties: @@ -194021,7 +197038,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -194100,11 +197117,11 @@ webhooks: type: string enum: - dequeued - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -196467,7 +199484,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *855 + repository: *856 sender: *4 required: - action @@ -196591,12 +199608,12 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - number: *904 - organization: *854 - pull_request: *905 - repository: *855 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 + pull_request: *906 + repository: *856 sender: *4 required: - action @@ -196676,11 +199693,11 @@ webhooks: type: string enum: - enqueued - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -199028,7 +202045,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -199108,11 +202125,11 @@ webhooks: type: string enum: - labeled - enterprise: *852 - installation: *853 - label: *873 - number: *904 - organization: *854 + enterprise: *853 + installation: *854 + label: *874 + number: *905 + organization: *855 pull_request: title: Pull Request type: object @@ -201463,7 +204480,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -201544,10 +204561,10 @@ webhooks: type: string enum: - locked - enterprise: *852 - installation: *853 - number: *904 - organization: *854 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 pull_request: title: Pull Request type: object @@ -203896,7 +206913,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -203976,12 +206993,12 @@ webhooks: type: string enum: - milestoned - enterprise: *852 + enterprise: *853 milestone: *414 - number: *904 - organization: *854 - pull_request: *906 - repository: *855 + number: *905 + organization: *855 + pull_request: *907 + repository: *856 sender: *4 required: - action @@ -204060,12 +207077,12 @@ webhooks: type: string enum: - opened - enterprise: *852 - installation: *853 - number: *904 - organization: *854 - pull_request: *905 - repository: *855 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 + pull_request: *906 + repository: *856 sender: *4 required: - action @@ -204146,12 +207163,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *852 - installation: *853 - number: *904 - organization: *854 - pull_request: *905 - repository: *855 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 + pull_request: *906 + repository: *856 sender: *4 required: - action @@ -204231,12 +207248,12 @@ webhooks: type: string enum: - reopened - enterprise: *852 - installation: *853 - number: *904 - organization: *854 - pull_request: *905 - repository: *855 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 + pull_request: *906 + repository: *856 sender: *4 required: - action @@ -204611,9 +207628,9 @@ webhooks: - start_side - side - reactions - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: type: object properties: @@ -206846,7 +209863,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *855 + repository: *856 sender: *4 required: - action @@ -206926,7 +209943,7 @@ webhooks: type: string enum: - deleted - comment: &908 + comment: &909 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -207219,9 +210236,9 @@ webhooks: - start_side - side - reactions - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: type: object properties: @@ -209442,7 +212459,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *855 + repository: *856 sender: *4 required: - action @@ -209522,11 +212539,11 @@ webhooks: type: string enum: - edited - changes: *907 - comment: *908 - enterprise: *852 - installation: *853 - organization: *854 + changes: *908 + comment: *909 + enterprise: *853 + installation: *854 + organization: *855 pull_request: type: object properties: @@ -211750,7 +214767,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *855 + repository: *856 sender: *4 required: - action @@ -211831,9 +214848,9 @@ webhooks: type: string enum: - dismissed - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: title: Simple Pull Request type: object @@ -214069,7 +217086,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *855 + repository: *856 review: description: The review that was affected. type: object @@ -214320,9 +217337,9 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: title: Simple Pull Request type: object @@ -216431,8 +219448,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *855 - review: &909 + repository: *856 + review: &910 description: The review that was affected. type: object properties: @@ -216670,12 +219687,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: description: The pull request number. type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -219025,7 +222042,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 requested_reviewer: title: User type: @@ -219111,12 +222128,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: description: The pull request number. type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -221473,7 +224490,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 requested_team: title: Team description: Groups of organization members that gives permissions @@ -221668,12 +224685,12 @@ webhooks: type: string enum: - review_requested - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: description: The pull request number. type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -224025,7 +227042,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 requested_reviewer: title: User type: @@ -224112,12 +227129,12 @@ webhooks: type: string enum: - review_requested - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: description: The pull request number. type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -226460,7 +229477,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 requested_team: title: Team description: Groups of organization members that gives permissions @@ -226644,9 +229661,9 @@ webhooks: type: string enum: - submitted - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: title: Simple Pull Request type: object @@ -228885,8 +231902,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *855 - review: *909 + repository: *856 + review: *910 sender: *4 required: - action @@ -228966,9 +231983,9 @@ webhooks: type: string enum: - resolved - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: title: Simple Pull Request type: object @@ -231116,7 +234133,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *855 + repository: *856 sender: *4 thread: type: object @@ -231513,9 +234530,9 @@ webhooks: type: string enum: - unresolved - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: title: Simple Pull Request type: object @@ -233646,7 +236663,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *855 + repository: *856 sender: *4 thread: type: object @@ -234045,10 +237062,10 @@ webhooks: type: string before: type: string - enterprise: *852 - installation: *853 - number: *904 - organization: *854 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 pull_request: title: Pull Request type: object @@ -236386,7 +239403,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -236468,11 +239485,11 @@ webhooks: type: string enum: - unassigned - assignee: *910 - enterprise: *852 - installation: *853 - number: *904 - organization: *854 + assignee: *911 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 pull_request: title: Pull Request type: object @@ -238825,7 +241842,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -238904,11 +241921,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *852 - installation: *853 - label: *873 - number: *904 - organization: *854 + enterprise: *853 + installation: *854 + label: *874 + number: *905 + organization: *855 pull_request: title: Pull Request type: object @@ -241250,7 +244267,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -241331,10 +244348,10 @@ webhooks: type: string enum: - unlocked - enterprise: *852 - installation: *853 - number: *904 - organization: *854 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 pull_request: title: Pull Request type: object @@ -243666,7 +246683,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -243869,7 +246886,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *852 + enterprise: *853 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -243964,8 +246981,8 @@ webhooks: - url - author - committer - installation: *853 - organization: *854 + installation: *854 + organization: *855 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -244564,9 +247581,9 @@ webhooks: type: string enum: - published - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 registry_package: type: object properties: @@ -245043,7 +248060,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *893 + items: *894 summary: type: string tag_name: @@ -245099,7 +248116,7 @@ webhooks: - owner - package_version - registry - repository: *855 + repository: *856 sender: *4 required: - action @@ -245177,9 +248194,9 @@ webhooks: type: string enum: - updated - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 registry_package: type: object properties: @@ -245491,7 +248508,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *893 + items: *894 summary: type: string tag_name: @@ -245541,7 +248558,7 @@ webhooks: - owner - package_version - registry - repository: *855 + repository: *856 sender: *4 required: - action @@ -245618,10 +248635,10 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - release: &911 + enterprise: *853 + installation: *854 + organization: *855 + release: &912 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object. @@ -245952,7 +248969,7 @@ webhooks: - updated_at - zipball_url - body - repository: *855 + repository: *856 sender: *4 required: - action @@ -246029,11 +249046,11 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - release: *911 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + release: *912 + repository: *856 sender: *4 required: - action @@ -246150,11 +249167,11 @@ webhooks: type: boolean required: - to - enterprise: *852 - installation: *853 - organization: *854 - release: *911 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + release: *912 + repository: *856 sender: *4 required: - action @@ -246232,9 +249249,9 @@ webhooks: type: string enum: - prereleased - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) @@ -246570,7 +249587,7 @@ webhooks: - string - 'null' format: uri - repository: *855 + repository: *856 sender: *4 required: - action @@ -246646,10 +249663,10 @@ webhooks: type: string enum: - published - enterprise: *852 - installation: *853 - organization: *854 - release: &912 + enterprise: *853 + installation: *854 + organization: *855 + release: &913 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object. @@ -246982,7 +249999,7 @@ webhooks: - string - 'null' format: uri - repository: *855 + repository: *856 sender: *4 required: - action @@ -247058,11 +250075,11 @@ webhooks: type: string enum: - released - enterprise: *852 - installation: *853 - organization: *854 - release: *911 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + release: *912 + repository: *856 sender: *4 required: - action @@ -247138,11 +250155,11 @@ webhooks: type: string enum: - unpublished - enterprise: *852 - installation: *853 - organization: *854 - release: *912 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + release: *913 + repository: *856 sender: *4 required: - action @@ -247218,11 +250235,11 @@ webhooks: type: string enum: - published - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - repository_advisory: *753 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + repository_advisory: *754 sender: *4 required: - action @@ -247298,11 +250315,11 @@ webhooks: type: string enum: - reported - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - repository_advisory: *753 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + repository_advisory: *754 sender: *4 required: - action @@ -247378,10 +250395,10 @@ webhooks: type: string enum: - archived - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -247458,10 +250475,10 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -247539,10 +250556,10 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -247627,10 +250644,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -247745,10 +250762,10 @@ webhooks: - 'null' items: type: string - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -247820,10 +250837,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 status: type: string @@ -247904,10 +250921,10 @@ webhooks: type: string enum: - privatized - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -247984,10 +251001,10 @@ webhooks: type: string enum: - publicized - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -248081,10 +251098,10 @@ webhooks: - name required: - repository - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -248164,10 +251181,10 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 repository_ruleset: *187 sender: *4 required: @@ -248246,10 +251263,10 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 repository_ruleset: *187 sender: *4 required: @@ -248328,10 +251345,10 @@ webhooks: type: string enum: - edited - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 repository_ruleset: *187 changes: type: object @@ -248393,16 +251410,16 @@ webhooks: properties: added: type: array - items: *721 + items: *722 deleted: type: array - items: *721 + items: *722 updated: type: array items: type: object properties: - rule: *721 + rule: *722 changes: type: object properties: @@ -248639,10 +251656,10 @@ webhooks: - from required: - owner - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -248720,10 +251737,10 @@ webhooks: type: string enum: - unarchived - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -248801,7 +251818,7 @@ webhooks: type: string enum: - create - alert: &913 + alert: &914 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -248926,10 +251943,10 @@ webhooks: enum: - auto_dismissed - open - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -249139,10 +252156,10 @@ webhooks: type: string enum: - dismissed - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -249220,11 +252237,11 @@ webhooks: type: string enum: - reopen - alert: *913 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + alert: *914 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -249426,10 +252443,10 @@ webhooks: enum: - fixed - open - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -249507,7 +252524,7 @@ webhooks: type: string enum: - assigned - alert: &914 + alert: &915 type: object properties: number: *127 @@ -249647,10 +252664,10 @@ webhooks: - type: 'null' - *4 assignee: *4 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -249728,11 +252745,11 @@ webhooks: type: string enum: - created - alert: *914 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + alert: *915 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -249813,11 +252830,11 @@ webhooks: type: string enum: - created - alert: *914 - installation: *853 - location: *915 - organization: *854 - repository: *855 + alert: *915 + installation: *854 + location: *916 + organization: *855 + repository: *856 sender: *4 required: - location @@ -250055,11 +253072,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *914 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + alert: *915 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -250137,11 +253154,11 @@ webhooks: type: string enum: - reopened - alert: *914 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + alert: *915 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -250219,11 +253236,11 @@ webhooks: type: string enum: - resolved - alert: *914 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + alert: *915 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -250301,12 +253318,12 @@ webhooks: type: string enum: - unassigned - alert: *914 + alert: *915 assignee: *4 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -250384,11 +253401,11 @@ webhooks: type: string enum: - validated - alert: *914 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + alert: *915 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -250518,10 +253535,10 @@ webhooks: - organization - enterprise - - repository: *855 - enterprise: *852 - installation: *853 - organization: *854 + repository: *856 + enterprise: *853 + installation: *854 + organization: *855 sender: *4 required: - action @@ -250599,11 +253616,11 @@ webhooks: type: string enum: - published - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - security_advisory: &916 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + security_advisory: &917 description: The details of the security advisory, including summary, description, and severity. type: object @@ -250776,11 +253793,11 @@ webhooks: type: string enum: - updated - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - security_advisory: *916 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + security_advisory: *917 sender: *4 required: - action @@ -250853,10 +253870,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -251030,10 +254047,10 @@ webhooks: type: object properties: security_and_analysis: *425 - enterprise: *852 - installation: *853 - organization: *854 - repository: *470 + enterprise: *853 + installation: *854 + organization: *855 + repository: *471 sender: *4 required: - changes @@ -251111,12 +254128,12 @@ webhooks: type: string enum: - cancelled - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - sponsorship: &917 + sponsorship: &918 type: object properties: created_at: @@ -251421,12 +254438,12 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - sponsorship: *917 + sponsorship: *918 required: - action - sponsorship @@ -251514,12 +254531,12 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - sponsorship: *917 + sponsorship: *918 required: - action - changes @@ -251596,17 +254613,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &918 + effective_date: &919 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - sponsorship: *917 + sponsorship: *918 required: - action - sponsorship @@ -251680,7 +254697,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &919 + changes: &920 type: object properties: tier: @@ -251724,13 +254741,13 @@ webhooks: - from required: - tier - effective_date: *918 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + effective_date: *919 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - sponsorship: *917 + sponsorship: *918 required: - action - changes @@ -251807,13 +254824,13 @@ webhooks: type: string enum: - tier_changed - changes: *919 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + changes: *920 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - sponsorship: *917 + sponsorship: *918 required: - action - changes @@ -251887,10 +254904,10 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -251974,10 +254991,10 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -252411,15 +255428,15 @@ webhooks: type: - string - 'null' - enterprise: *852 + enterprise: *853 id: description: The unique identifier of the status. type: integer - installation: *853 + installation: *854 name: type: string - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 sha: description: The Commit SHA. @@ -252535,9 +255552,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *219 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -252627,9 +255644,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *219 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -252719,9 +255736,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *219 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -252811,9 +255828,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *219 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -252890,12 +255907,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - team: &920 + team: &921 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -253125,9 +256142,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 repository: title: Repository description: A git repository @@ -253597,7 +256614,7 @@ webhooks: - topics - visibility sender: *4 - team: *920 + team: *921 required: - action - team @@ -253673,9 +256690,9 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 repository: title: Repository description: A git repository @@ -254145,7 +257162,7 @@ webhooks: - topics - visibility sender: *4 - team: *920 + team: *921 required: - action - team @@ -254222,9 +257239,9 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 repository: title: Repository description: A git repository @@ -254694,7 +257711,7 @@ webhooks: - topics - visibility sender: *4 - team: *920 + team: *921 required: - action - team @@ -254838,9 +257855,9 @@ webhooks: - from required: - permissions - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 repository: title: Repository description: A git repository @@ -255310,7 +258327,7 @@ webhooks: - topics - visibility sender: *4 - team: *920 + team: *921 required: - action - changes @@ -255388,9 +258405,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 repository: title: Repository description: A git repository @@ -255860,7 +258877,7 @@ webhooks: - topics - visibility sender: *4 - team: *920 + team: *921 required: - action - team @@ -255936,10 +258953,10 @@ webhooks: type: string enum: - started - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -256012,17 +259029,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *852 + enterprise: *853 inputs: type: - object - 'null' additionalProperties: true - installation: *853 - organization: *854 + installation: *854 + organization: *855 ref: type: string - repository: *855 + repository: *856 sender: *4 workflow: type: string @@ -256104,10 +259121,10 @@ webhooks: type: string enum: - completed - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 workflow_job: allOf: @@ -256363,7 +259380,7 @@ webhooks: type: string required: - conclusion - deployment: *607 + deployment: *608 required: - action - repository @@ -256442,10 +259459,10 @@ webhooks: type: string enum: - in_progress - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 workflow_job: allOf: @@ -256727,7 +259744,7 @@ webhooks: required: - status - steps - deployment: *607 + deployment: *608 required: - action - repository @@ -256806,10 +259823,10 @@ webhooks: type: string enum: - queued - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 workflow_job: type: object @@ -256955,7 +259972,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *607 + deployment: *608 required: - action - repository @@ -257034,10 +260051,10 @@ webhooks: type: string enum: - waiting - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 workflow_job: type: object @@ -257184,7 +260201,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *607 + deployment: *608 required: - action - repository @@ -257264,12 +260281,12 @@ webhooks: type: string enum: - completed - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - workflow: *869 + workflow: *870 workflow_run: title: Workflow Run type: object @@ -258288,12 +261305,12 @@ webhooks: type: string enum: - in_progress - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - workflow: *869 + workflow: *870 workflow_run: title: Workflow Run type: object @@ -259297,12 +262314,12 @@ webhooks: type: string enum: - requested - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - workflow: *869 + workflow: *870 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 43ae0154d..4df45d399 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -2368,6 +2368,3174 @@ } } }, + "/agents/repos/{owner}/{repo}/tasks": { + "get": { + "summary": "List tasks for repository", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n\n**Fine-grained access tokens for \"List tasks for repository\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#list-tasks-for-repository" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Start a task", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nStarts a new Copilot cloud agent task for a repository.\n\nThis endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription.\n\n**Fine-grained access tokens for \"Start a task\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read and write)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/create-task-in-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#start-a-task" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + } + ], + "requestBody": { + "required": true, + "description": "The task creation parameters, including the user's prompt and optional agent settings.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "prompt" + ], + "properties": { + "prompt": { + "type": "string", + "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`" + }, + "create_pull_request": { + "type": "boolean", + "description": "Whether to create a PR.", + "default": false + }, + "base_ref": { + "type": "string", + "description": "Base ref for new branch/PR" + } + } + }, + "examples": { + "default": { + "value": { + "prompt": "Fix the login button on the homepage", + "base_ref": "main" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Task created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "queued", + "session_count": 1, + "artifacts": [], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "400": { + "description": "Problems parsing JSON", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/repos/{owner}/{repo}/tasks/{task_id}": { + "get": { + "summary": "Get a task by repo", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n\n**Fine-grained access tokens for \"Get a task by repo\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-repo-and-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#get-a-task-by-repo" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "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": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks": { + "get": { + "summary": "List tasks", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n\n**Fine-grained access tokens for \"List tasks\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#list-tasks" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks/{task_id}": { + "get": { + "summary": "Get a task by ID", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n\n**Fine-grained access tokens for \"Get a task by ID\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#get-a-task-by-id" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "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" + }, + "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", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "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": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, "/app": { "get": { "summary": "Get the authenticated app", @@ -71105,6 +74273,15 @@ "type": "boolean", "default": false } + }, + { + "name": "is_bypassed", + "in": "query", + "description": "A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -160318,7 +163495,7 @@ "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { "post": { "summary": "Set cluster deployment records", - "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.", + "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.\nNote: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments\narray resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use\nthe artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can\nonly have one name and version.", "tags": [ "orgs" ], @@ -160377,20 +163554,20 @@ "properties": { "name": { "type": "string", - "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", + "description": "The name of the artifact.", "minLength": 1, "maxLength": 256 }, "digest": { "type": "string", - "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", + "description": "The hex encoded digest of the artifact.", "minLength": 71, "maxLength": 71, "pattern": "^sha256:[a-f0-9]{64}$" }, "version": { "type": "string", - "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", + "description": "The artifact version.", "maxLength": 100, "x-multi-segment": true, "examples": [ @@ -259956,7 +263133,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -260041,6 +263219,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -260193,7 +263379,7 @@ }, "post": { "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -260284,7 +263470,7 @@ } }, "auth_type": { - "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith` for OIDC authentication.", + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication.", "type": "string", "enum": [ "token", @@ -260292,7 +263478,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -260328,7 +263515,7 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { @@ -260346,6 +263533,14 @@ "api_host": { "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", "type": "string" + }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). Required when `auth_type` is `oidc_gcp`.", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).", + "type": "string" } }, "required": [ @@ -260404,6 +263599,17 @@ "service_slug": "my-service-account", "audience": "https://github.com/my-org" } + }, + "org-private-registry-with-oidc-gcp": { + "summary": "Example of an OIDC private registry configuration using Google Cloud Artifact Registry", + "value": { + "registry_type": "docker_registry", + "url": "https://us-docker.pkg.dev/my-project/my-repo", + "auth_type": "oidc_gcp", + "visibility": "all", + "workload_identity_provider": "projects/123456789/locations/global/workloadIdentityPools/github-pool/providers/github-provider", + "service_account": "dependabot@my-project.iam.gserviceaccount.com" + } } } } @@ -260455,7 +263661,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -260544,6 +263751,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -260883,7 +264098,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -260968,6 +264184,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", + "type": "string" + }, "created_at": { "type": "string", "format": "date-time" @@ -261036,7 +264260,7 @@ }, "patch": { "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "private-registries" ], @@ -261144,7 +264368,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -261180,7 +264405,7 @@ "type": "string" }, "audience": { - "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and required for `oidc_cloudsmith` auth types.", + "description": "The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.", "type": "string" }, "identity_mapping_name": { @@ -261198,6 +264423,14 @@ "api_host": { "description": "The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.", "type": "string" + }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). Required when `auth_type` is `oidc_gcp`.", + "type": "string" + }, + "service_account": { + "description": "The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).", + "type": "string" } } }, @@ -311320,6 +314553,15 @@ "type": "boolean", "default": false } + }, + { + "name": "is_bypassed", + "in": "query", + "description": "A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -342445,25 +345687,547 @@ } }, { - "name": "cache_id", - "description": "The unique identifier of the GitHub Actions cache.", + "name": "cache_id", + "description": "The unique identifier of the GitHub Actions cache.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/concurrency_groups": { + "get": { + "summary": "List concurrency groups for a repository", + "description": "Lists the active concurrency groups for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-concurrency-groups-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Concurrency Group List", + "description": "A list of active concurrency groups for a repository.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "last_acquired_at" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "last_acquired_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "last_acquired_at": "2026-01-15T16:14:23Z" + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "last_acquired_at": "2026-01-15T16:13:55Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "concurrency-groups" + } + } + }, + "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}": { + "get": { + "summary": "Get a concurrency group for a repository", + "description": "Gets a specific concurrency group for a repository, including all instances in the group's queue.\nReturns 404 if the group is inactive or does not exist.\n\nOptionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items\nahead of the specified workflow run or job in the queue, plus the specified item itself\n(returned as the last element). This is useful for determining what is blocking a particular\nrun or job. Returns 422 if the specified run or job is not in this concurrency group.\n\nWhen using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow\nleases held on behalf of that run. Job-level leases within the run are not considered to\nblock the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow\nleases on the job's ancestor paths.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/get-concurrency-group-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "concurrency_group_name", + "description": "The name of the concurrency group.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "ahead_of_run", + "description": "Filter to items ahead of this workflow run ID in the queue, plus the run itself.\nMatches workflow-level concurrency and reusable-workflow leases held on behalf of\nthe run. Mutually exclusive with `ahead_of_job`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 + } + }, + { + "name": "ahead_of_job", + "description": "Filter to items ahead of this job ID in the queue, plus the job itself.\nMatches job-level concurrency and reusable-workflow leases on the job's\nancestor paths. Mutually exclusive with `ahead_of_run`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 } } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Concurrency Group", + "description": "A concurrency group with the workflow runs and jobs that are either currently holding\nor waiting for the concurrency group lease.", + "type": "object", + "required": [ + "group_name", + "group_url", + "total_count", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "total_count": { + "type": "integer" + }, + "group_members": { + "type": "array", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "job_id": { + "type": "integer", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "total_count": 3, + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress" + }, + { + "run_id": 30433643, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433643", + "status": "pending" + }, + { + "run_id": 30433644, + "run_name": "Deploy hotfix", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644", + "job_id": 798245260, + "job_name": "deploy", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260", + "status": "pending" + } + ] + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "concurrency-groups" } } }, @@ -360175,99 +363939,386 @@ } }, { - "name": "attempt_number", - "description": "The attempt number of the workflow run.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "302": { - "description": "Response", - "headers": { - "Location": { - "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "workflow-runs" - } - } - }, - "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { - "post": { - "summary": "Cancel a workflow run", - "description": "Cancels a workflow run using its `id`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/cancel-workflow-run", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#cancel-a-workflow-run" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "attempt_number", + "description": "The attempt number of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + "post": { + "summary": "Cancel a workflow run", + "description": "Cancels a workflow run using its `id`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/cancel-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#cancel-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The unique identifier of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups": { + "get": { + "summary": "List concurrency groups for a workflow run", + "description": "Lists all concurrency groups associated with a workflow run or its jobs.\n\nThe set of groups is derived from the run's configuration, so a group is\nincluded even when the run no longer has any items currently holding or\nwaiting in it. In that case the `group_members` array will be empty.\n`total_count` reflects the number of groups the run participates in by\nconfiguration, not the number with active items.\n\nThis differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`,\nwhich returns 404 when a group has no active items. That endpoint reports\nthe live state of a group repo-wide, while this endpoint reports the\ngroups associated with a specific run by configuration.\n\nResults are sorted by group name and support cursor-based pagination via\n`before` and `after`. The `after` cursor paginates forward only and does\nnot emit a `rel=\"prev\"` Link; use `before` to page backward from a\nforward page's `next` cursor.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-concurrency-groups-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The unique identifier of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 } }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, "schema": { "type": "string" } }, { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "path", - "required": true, + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, "schema": { - "type": "integer" + "type": "string" } } ], "responses": { - "202": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", + "title": "Concurrency Group Run List", + "description": "A list of concurrency groups associated with a workflow run.", "type": "object", - "properties": {}, - "additionalProperties": false + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer", + "description": "The total number of concurrency groups this workflow run participates in,\nderived from the run's configuration. This count is not filtered by\nwhether the run currently holds or is waiting in each group, so it can\ninclude groups whose `group_members` array is empty (for example, when\nthe run has already released its lease in that group)." + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group. May return 404 if the group\nhas no active items at the time it is requested, since the\nget-by-name endpoint reports the live repo-wide state of a group\nwhile this endpoint lists groups associated with a run by\nconfiguration." + }, + "group_members": { + "type": "array", + "description": "Items belonging to this workflow run that are either currently holding or\nwaiting for the concurrency group lease. May be empty if the run no\nlonger has any active or queued items in this group.", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status", + "position", + "position_url" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "position": { + "type": "integer", + "description": "Queue position. 0 means the item holds the concurrency lease (in_progress), 1 or higher means queued (pending)." + }, + "position_url": { + "type": "string", + "format": "uri", + "description": "API URL to get items ahead of this item in the concurrency group." + }, + "job_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": [ + "string", + "null" + ], + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } }, "examples": { "default": { - "value": null + "value": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress", + "position": 0, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642" + } + ] + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "pending", + "position": 2, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260", + "job_id": 798245260, + "job_name": "build", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260" + } + ] + } + ] + } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, - "409": { - "description": "Conflict", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -360291,13 +364342,88 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "workflow-runs" + "subcategory": "concurrency-groups" } } }, @@ -712639,6 +716765,15 @@ "type": "boolean", "default": false } + }, + { + "name": "is_bypassed", + "in": "query", + "description": "A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index 4f4ea74ed..a3828928a 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -944,7 +944,7 @@ paths: - subscriptions_url - type - url - type: &449 + type: &450 type: string description: The type of credit the user is receiving. enum: @@ -1137,7 +1137,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &755 + - &756 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1233,6 +1233,2530 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories + "/agents/repos/{owner}/{repo}/tasks": + get: + summary: List tasks for repository + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for a specific repository + + **Fine-grained access tokens for "List tasks for repository"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/list-tasks-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#list-tasks-for-repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, + `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived + tasks. When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + - name: creator_id + in: query + schema: + type: integer + description: Filter tasks by creator user ID + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="prev" (when current page > 1), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; + rel="next", ; + rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + post: + summary: Start a task + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Starts a new Copilot cloud agent task for a repository. + + This endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription. + + **Fine-grained access tokens for "Start a task"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read and write) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/create-task-in-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#start-a-task + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + requestBody: + required: true + description: The task creation parameters, including the user's prompt and + optional agent settings. + content: + application/json: + schema: + type: object + required: + - prompt + properties: + prompt: + type: string + 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`' + create_pull_request: + type: boolean + description: Whether to create a PR. + default: false + base_ref: + type: string + description: Base ref for new branch/PR + examples: + default: + value: + prompt: Fix the login button on the homepage + base_ref: main + responses: + '201': + description: Task created successfully + content: + application/json: + schema: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: queued + session_count: 1 + artifacts: [] + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '400': + description: Problems parsing JSON + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/repos/{owner}/{repo}/tasks/{task_id}": + get: + summary: Get a task by repo + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID scoped to an owner/repo path + + **Fine-grained access tokens for "Get a task by repo"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-repo-and-id + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#get-a-task-by-repo + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + allOf: + - type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + 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: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/tasks": + get: + summary: List tasks + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for the authenticated user + + **Fine-grained access tokens for "List tasks"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/list-tasks + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#list-tasks + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, + `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived + tasks. When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; rel="next", + ; rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + "/agents/tasks/{task_id}": + get: + summary: Get a task by ID + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID with its associated sessions + + **Fine-grained access tokens for "Get a task by ID"** + + This endpoint works with the following fine-grained token types: + + * [GitHub App user access tokens](https://docs.github.com/enterprise-cloud@latest/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app) + * [Fine-grained personal access tokens](https://docs.github.com/enterprise-cloud@latest/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) + + The fine-grained token must have the following permission set: + + * "Agent tasks" repository permissions (read) + + GitHub App installation access tokens are not supported for this endpoint. + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/agent-tasks/agent-tasks#get-a-task-by-id + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + allOf: + - type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + 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 + 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 + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + 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: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code + is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation "/app": get: summary: Get the authenticated app @@ -1885,7 +4409,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &764 + schema: &765 title: Scim Error description: Scim Error type: object @@ -9622,7 +12146,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &765 + '401': &766 description: Authorization failure '404': *6 x-github: @@ -13895,7 +16419,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &538 + instances_url: &539 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13931,7 +16455,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &539 + dismissed_reason: &540 type: - string - 'null' @@ -13942,14 +16466,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &540 + dismissed_comment: &541 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &541 + rule: &542 type: object properties: id: @@ -14010,7 +16534,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &542 + tool: &543 type: object properties: name: *111 @@ -14021,26 +16545,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *112 - most_recent_instance: &543 + most_recent_instance: &544 type: object properties: - ref: &536 + ref: &537 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &553 + analysis_key: &554 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - environment: &554 + environment: &555 type: string description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &555 + category: &556 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -14060,7 +16584,7 @@ paths: with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance. - location: &556 + location: &557 type: object description: Describe a region within a file for the alert. properties: @@ -14081,7 +16605,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &557 + items: &558 type: - string - 'null' @@ -18615,7 +21139,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &596 + - &597 name: has in: query description: |- @@ -18742,7 +21266,7 @@ paths: - transitive - inconclusive - - security_advisory: &597 + security_advisory: &598 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -19004,7 +21528,7 @@ paths: dismissal. maxLength: 280 fixed_at: *137 - auto_dismissed_at: &598 + auto_dismissed_at: &599 type: - string - 'null' @@ -19012,7 +21536,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &599 + dismissal_request: &600 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -20818,7 +23342,7 @@ paths: - name - created_on examples: - default: &453 + default: &454 value: total_count: 2 network_configurations: @@ -21069,7 +23593,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *39 - - &454 + - &455 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -21081,7 +23605,7 @@ paths: description: Response content: application/json: - schema: &455 + schema: &456 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -21120,7 +23644,7 @@ paths: - subnet_id - region examples: - default: &456 + default: &457 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -23226,7 +25750,7 @@ paths: - object rules: type: array - items: &721 + items: &722 title: Repository Rule type: object description: A repository rule. @@ -23235,7 +25759,7 @@ paths: - *167 - *168 - *169 - - &719 + - &720 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -23805,6 +26329,17 @@ paths: schema: type: boolean default: false + - &445 + name: is_bypassed + in: query + description: A boolean value (`true` or `false`) indicating whether to filter + alerts by their push protection bypass status. When set to `true`, only + alerts that were created because a push protection rule was bypassed will + be returned. When set to `false`, only alerts that were not caused by a + push protection bypass will be returned. + required: false + schema: + type: boolean responses: '200': description: Response @@ -23812,7 +26347,7 @@ paths: application/json: schema: type: array - items: &445 + items: &446 type: object properties: number: *127 @@ -23828,14 +26363,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &733 + state: &734 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &734 + resolution: &735 type: - string - 'null' @@ -23954,14 +26489,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &735 + - &736 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &737 + - &738 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -24025,7 +26560,7 @@ paths: - blob_url - commit_sha - commit_url - - &738 + - &739 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -24086,7 +26621,7 @@ paths: - page_url - commit_sha - commit_url - - &739 + - &740 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -24108,7 +26643,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &740 + - &741 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -24130,7 +26665,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &741 + - &742 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -24152,7 +26687,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &742 + - &743 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -24167,7 +26702,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &743 + - &744 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -24182,7 +26717,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &744 + - &745 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -24197,7 +26732,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &745 + - &746 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -24219,7 +26754,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &746 + - &747 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -24241,7 +26776,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &747 + - &748 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -24263,7 +26798,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &748 + - &749 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -24285,7 +26820,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &749 + - &750 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -24331,7 +26866,7 @@ paths: - type: 'null' - *4 examples: - default: &446 + default: &447 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -24540,7 +27075,7 @@ paths: description: Response content: application/json: - schema: &447 + schema: &448 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -24627,7 +27162,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *193 examples: - default: &448 + default: &449 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -24763,7 +27298,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *39 - - &450 + - &451 name: advanced_security_product in: query description: | @@ -24783,7 +27318,7 @@ paths: description: Success content: application/json: - schema: &451 + schema: &452 type: object properties: total_advanced_security_committers: @@ -24846,7 +27381,7 @@ paths: required: - repositories examples: - default: &452 + default: &453 value: total_advanced_security_committers: 2 total_count: 2 @@ -28006,7 +30541,7 @@ paths: properties: action: type: string - discussion: &870 + discussion: &871 title: Discussion description: A Discussion in a repository. type: object @@ -28790,7 +31325,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &792 + sub_issues_summary: &793 title: Sub-issues Summary type: object properties: @@ -28874,7 +31409,7 @@ paths: pin: anyOf: - type: 'null' - - &678 + - &679 title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. @@ -28901,7 +31436,7 @@ paths: - url - created_at - updated_at - issue_dependencies_summary: &793 + issue_dependencies_summary: &794 title: Issue Dependencies Summary type: object properties: @@ -28920,7 +31455,7 @@ paths: - total_blocking issue_field_values: type: array - items: &662 + items: &663 title: Issue Field Value description: A value assigned to an issue field type: object @@ -29744,7 +32279,7 @@ paths: type: string release: allOf: - - &712 + - &713 title: Release description: A release. type: object @@ -29826,7 +32361,7 @@ paths: author: *4 assets: type: array - items: &713 + items: &714 title: Release Asset description: Data related to a release. type: object @@ -30446,7 +32981,7 @@ paths: url: type: string format: uri - user: &799 + user: &800 title: Public User description: Public User type: object @@ -33813,14 +36348,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &465 + - &466 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &466 + - &467 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -33882,7 +36417,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &471 + '301': &472 description: Moved permanently content: application/json: @@ -33904,7 +36439,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &686 + - &687 name: all description: If `true`, show notifications marked as read. in: query @@ -33912,7 +36447,7 @@ paths: schema: type: boolean default: false - - &687 + - &688 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -33922,7 +36457,7 @@ paths: type: boolean default: false - *224 - - &688 + - &689 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -34529,7 +37064,7 @@ paths: - url - subscription_url examples: - default: &689 + default: &690 value: - id: '1' repository: @@ -35405,7 +37940,7 @@ paths: type: array items: *152 examples: - default: &695 + default: &696 value: - property_name: environment value: production @@ -35455,7 +37990,7 @@ paths: required: - properties examples: - default: &696 + default: &697 value: properties: - property_name: environment @@ -36374,7 +38909,7 @@ paths: type: integer repository_cache_usages: type: array - items: &478 + items: &479 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -39691,7 +42226,7 @@ paths: description: Response content: application/json: - schema: &498 + schema: &499 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -39726,7 +42261,7 @@ paths: - key_id - key examples: - default: &499 + default: &500 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -40139,7 +42674,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-organization-variables parameters: - *87 - - &483 + - &484 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -40914,6 +43449,10 @@ paths: If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. If no existing records match, new records will be created. + Note: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments + array resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use + the artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can + only have one name and version. tags: - orgs operationId: orgs/set-cluster-deployment-records @@ -40956,24 +43495,18 @@ paths: properties: name: type: string - description: | - The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name parameter must also be identical across all entries. + description: The name of the artifact. minLength: 1 maxLength: 256 digest: type: string - description: | - The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name and version parameters must also be identical across all entries. + description: The hex encoded digest of the artifact. minLength: 71 maxLength: 71 pattern: "^sha256:[a-f0-9]{64}$" version: type: string - description: | - The artifact version. Note that if multiple deployments have identical 'digest' parameter values, - the version parameter must also be identical across all entries. + description: The artifact version. maxLength: 100 x-multi-segment: true examples: @@ -41450,12 +43983,12 @@ paths: required: - subject_digests examples: - default: &830 + default: &831 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &831 + withPredicateType: &832 value: subject_digests: - sha256:abc123 @@ -41514,7 +44047,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &832 + default: &833 value: attestations_subject_digests: - sha256:abc: @@ -41880,7 +44413,7 @@ paths: initiator: type: string examples: - default: &512 + default: &513 value: attestations: - bundle: @@ -42816,7 +45349,7 @@ paths: be returned. in: query required: false - schema: &537 + schema: &538 type: string description: Severity of a code scanning alert. enum: @@ -43918,7 +46451,7 @@ paths: machine: anyOf: - type: 'null' - - &569 + - &570 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -44870,7 +47403,7 @@ paths: - updated_at - visibility examples: - default: &570 + default: &571 value: total_count: 2 secrets: @@ -44908,7 +47441,7 @@ paths: description: Response content: application/json: - schema: &571 + schema: &572 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -44943,7 +47476,7 @@ paths: - key_id - key examples: - default: &572 + default: &573 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -44975,7 +47508,7 @@ paths: application/json: schema: *321 examples: - default: &574 + default: &575 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -49056,7 +51589,7 @@ paths: description: Response content: application/json: - schema: &602 + schema: &603 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -49075,7 +51608,7 @@ paths: - key_id - key examples: - default: &603 + default: &604 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -49411,7 +51944,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *87 - - &612 + - &613 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -49419,7 +51952,7 @@ paths: required: false schema: type: string - - &613 + - &614 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -49427,7 +51960,7 @@ paths: required: false schema: type: string - - &614 + - &615 name: time_period description: |- The time period to filter by. @@ -49443,7 +51976,7 @@ paths: - week - month default: month - - &615 + - &616 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -49468,7 +52001,7 @@ paths: application/json: schema: type: array - items: &616 + items: &617 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -49631,7 +52164,7 @@ paths: examples: - https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &617 + default: &618 value: - id: 21 number: 42 @@ -49733,7 +52266,7 @@ paths: application/json: schema: type: array - items: &618 + items: &619 title: Dependabot alert dismissal request description: Alert dismissal request made by a user asking to dismiss a Dependabot alert. @@ -49856,7 +52389,7 @@ paths: examples: - https://github.com/octo-org/smile/security/dependabot/1 examples: - default: &619 + default: &620 value: - id: 21 number: 42 @@ -50244,7 +52777,7 @@ paths: description: Response content: application/json: - schema: &462 + schema: &463 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -50334,7 +52867,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &463 + default: &464 value: group_id: '123' group_name: Octocat admins @@ -50389,7 +52922,7 @@ paths: description: Response content: application/json: - schema: &459 + schema: &460 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -50429,7 +52962,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &460 + default: &461 value: groups: - group_id: '123' @@ -51941,7 +54474,7 @@ paths: required: true content: application/json: - schema: &650 + schema: &651 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -53283,7 +55816,7 @@ paths: application/json: schema: *385 examples: - default: &568 + default: &569 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -54562,7 +57095,7 @@ paths: parameters: - *87 - *391 - - &813 + - &814 name: repo_name description: repo_name parameter in: path @@ -55928,7 +58461,7 @@ paths: - nuget - container - *87 - - &814 + - &815 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -55969,7 +58502,7 @@ paths: default: *396 '403': *27 '401': *23 - '400': &816 + '400': &817 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -57195,6 +59728,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -57265,6 +59799,15 @@ paths: api_host: description: The Cloudsmith API host. type: string + workload_identity_provider: + description: The full resource name of the GCP Workload + Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + type: string + service_account: + description: The GCP service account email to impersonate. + If omitted, the federated token is used directly (direct + WIF). + type: string created_at: type: string format: date-time @@ -57302,7 +59845,7 @@ paths: description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -57396,7 +59939,477 @@ paths: auth_type: description: The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, - or `oidc_cloudsmith` for OIDC authentication. + `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication. + type: string + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + - oidc_cloudsmith + - oidc_gcp + tenant_id: + description: The tenant ID of the Azure AD application. Required + when `auth_type` is `oidc_azure`. + type: string + client_id: + description: The client ID of the Azure AD application. Required + when `auth_type` is `oidc_azure`. + type: string + aws_region: + description: The AWS region. Required when `auth_type` is `oidc_aws`. + type: string + account_id: + description: The AWS account ID. Required when `auth_type` is `oidc_aws`. + type: string + role_name: + description: The AWS IAM role name. Required when `auth_type` is + `oidc_aws`. + type: string + domain: + description: The CodeArtifact domain. Required when `auth_type` + is `oidc_aws`. + type: string + domain_owner: + description: The CodeArtifact domain owner (AWS account ID). Required + when `auth_type` is `oidc_aws`. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. Required when `auth_type` + is `oidc_jfrog`. + type: string + audience: + description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, + and `oidc_gcp`, and required for `oidc_cloudsmith` auth types. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. Optional for `oidc_jfrog` + auth type. + type: string + namespace: + description: The Cloudsmith organization namespace. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + service_slug: + description: The Cloudsmith service account slug. Required when + `auth_type` is `oidc_cloudsmith`. + type: string + api_host: + description: The Cloudsmith API host. Optional for `oidc_cloudsmith` + auth type. If omitted, `api.cloudsmith.io` is used by default. + type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + Required when `auth_type` is `oidc_gcp`. + type: string + service_account: + description: The GCP service account email to impersonate. Optional + for `oidc_gcp` auth type. If omitted, the federated token is used + directly (direct WIF). + type: string + required: + - registry_type + - url + - visibility + examples: + org-private-registry-with-private-visibility: + summary: Example of a private registry configuration with private + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + replaces_base: true + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: private + org-private-registry-with-selected-visibility: + summary: Example of a private registry configuration with selected + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + org-private-registry-with-oidc-azure: + summary: Example of an OIDC private registry configuration using Azure + value: + registry_type: docker_registry + url: https://myregistry.azurecr.io + auth_type: oidc_azure + visibility: all + tenant_id: 12345678-1234-1234-1234-123456789012 + client_id: abcdef01-2345-6789-abcd-ef0123456789 + org-private-registry-with-oidc-cloudsmith: + summary: Example of an OIDC private registry configuration using Cloudsmith + value: + registry_type: npm_registry + url: https://npm.cloudsmith.io/my-org/my-repo/ + auth_type: oidc_cloudsmith + visibility: all + namespace: my-org + service_slug: my-service-account + audience: https://github.com/my-org + org-private-registry-with-oidc-gcp: + summary: Example of an OIDC private registry configuration using Google + Cloud Artifact Registry + value: + registry_type: docker_registry + url: https://us-docker.pkg.dev/my-project/my-repo + auth_type: oidc_gcp + visibility: all + workload_identity_provider: projects/123456789/locations/global/workloadIdentityPools/github-pool/providers/github-provider + service_account: dependabot@my-project.iam.gserviceaccount.com + responses: + '201': + description: The organization private registry configuration + content: + application/json: + schema: + title: Organization private registry + description: Private registry configuration for an organization + type: object + properties: + name: + description: The name of the private registry configuration. + type: string + examples: + - MAVEN_REPOSITORY_SECRET + registry_type: + description: The registry type. + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + type: string + auth_type: + description: The authentication type for the private registry. + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + - oidc_cloudsmith + - oidc_gcp + type: string + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the + private registry. + type: string + examples: + - monalisa + replaces_base: + description: Whether this private registry replaces the base registry + (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, + Dependabot will only use this registry and will not fall back + to the public registry. When `false` (default), Dependabot will + use this registry for scoped packages but may fall back to the + public registry for other packages. + type: boolean + default: false + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + enum: + - all + - private + - selected + type: string + selected_repository_ids: + type: array + description: An array of repository IDs that can access the organization + private registry when `visibility` is set to `selected`. + items: + type: integer + tenant_id: + description: The tenant ID of the Azure AD application. + type: string + client_id: + description: The client ID of the Azure AD application. + type: string + aws_region: + description: The AWS region. + type: string + account_id: + description: The AWS account ID. + type: string + role_name: + description: The AWS IAM role name. + type: string + domain: + description: The CodeArtifact domain. + type: string + domain_owner: + description: The CodeArtifact domain owner. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. + type: string + audience: + description: The OIDC audience. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. + type: string + namespace: + description: The Cloudsmith organization namespace. + type: string + service_slug: + description: The Cloudsmith service account slug. + type: string + api_host: + description: The Cloudsmith API host. + type: string + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + type: string + service_account: + description: The GCP service account email to impersonate. If + omitted, the federated token is used directly (direct WIF). + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - registry_type + - visibility + - created_at + - updated_at + examples: + org-private-registry-with-selected-visibility: &410 + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: private + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + org-private-registry-with-private-visibility: + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/public-key": + get: + summary: Get private registries public key for an organization + description: |2- + + Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization + parameters: + - *87 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - key_id + - key + properties: + key_id: + description: The identifier for the key. + type: string + examples: + - '012345678912345678' + key: + description: The Base64 encoded public key. + type: string + examples: + - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + examples: + default: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + headers: + Link: *45 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/{secret_name}": + get: + summary: Get a private registry for an organization + description: |2- + + Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization + parameters: + - *87 + - *288 + responses: + '200': + description: The specified private registry configuration for the organization + content: + application/json: + schema: *409 + examples: + default: *410 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + patch: + summary: Update a private registry for an organization + description: |2- + + Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." + For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/update-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization + parameters: + - *87 + - *288 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + registry_type: + description: The registry type. + type: string + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the private + registry. This field should be omitted if the private registry + does not require a username for authentication. + type: + - string + - 'null' + replaces_base: + description: Whether this private registry should replace the base + registry (e.g., npmjs.org for npm, rubygems.org for rubygems). + When set to `true`, Dependabot will only use this registry and + will not fall back to the public registry. When set to `false` + (default), Dependabot will use this registry for scoped packages + but may fall back to the public registry for other packages. + type: boolean + default: false + encrypted_value: + description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get private registries + public key for an organization](https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + endpoint. + type: string + pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + key_id: + description: The ID of the key you used to encrypt the secret. + type: string + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + type: string + enum: + - all + - private + - selected + selected_repository_ids: + description: An array of repository IDs that can access the organization + private registry. You can only provide a list of repository IDs + when `visibility` is set to `selected`. This field should be omitted + if `visibility` is set to `all` or `private`. + type: array + items: + type: integer + auth_type: + description: The authentication type for the private registry. This + field cannot be changed after creation. If provided, it must match + the existing `auth_type` of the configuration. To change the authentication + type, delete and recreate the configuration. type: string enum: - token @@ -57405,6 +60418,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp tenant_id: description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. @@ -57437,7 +60451,7 @@ paths: type: string audience: description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, - and required for `oidc_cloudsmith` auth types. + and `oidc_gcp`, and required for `oidc_cloudsmith` auth types. type: string identity_mapping_name: description: The JFrog identity mapping name. Optional for `oidc_jfrog` @@ -57455,445 +60469,15 @@ paths: description: The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default. type: string - required: - - registry_type - - url - - visibility - examples: - org-private-registry-with-private-visibility: - summary: Example of a private registry configuration with private - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - replaces_base: true - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: private - org-private-registry-with-selected-visibility: - summary: Example of a private registry configuration with selected - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - org-private-registry-with-oidc-azure: - summary: Example of an OIDC private registry configuration using Azure - value: - registry_type: docker_registry - url: https://myregistry.azurecr.io - auth_type: oidc_azure - visibility: all - tenant_id: 12345678-1234-1234-1234-123456789012 - client_id: abcdef01-2345-6789-abcd-ef0123456789 - org-private-registry-with-oidc-cloudsmith: - summary: Example of an OIDC private registry configuration using Cloudsmith - value: - registry_type: npm_registry - url: https://npm.cloudsmith.io/my-org/my-repo/ - auth_type: oidc_cloudsmith - visibility: all - namespace: my-org - service_slug: my-service-account - audience: https://github.com/my-org - responses: - '201': - description: The organization private registry configuration - content: - application/json: - schema: - title: Organization private registry - description: Private registry configuration for an organization - type: object - properties: - name: - description: The name of the private registry configuration. - type: string - examples: - - MAVEN_REPOSITORY_SECRET - registry_type: - description: The registry type. - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - type: string - auth_type: - description: The authentication type for the private registry. - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - - oidc_cloudsmith - type: string - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with the - private registry. - type: string - examples: - - monalisa - replaces_base: - description: Whether this private registry replaces the base registry - (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, - Dependabot will only use this registry and will not fall back - to the public registry. When `false` (default), Dependabot will - use this registry for scoped packages but may fall back to the - public registry for other packages. - type: boolean - default: false - visibility: - description: Which type of organization repositories have access - to the private registry. `selected` means only the repositories - specified by `selected_repository_ids` can access the private - registry. - enum: - - all - - private - - selected - type: string - selected_repository_ids: - type: array - description: An array of repository IDs that can access the organization - private registry when `visibility` is set to `selected`. - items: - type: integer - tenant_id: - description: The tenant ID of the Azure AD application. - type: string - client_id: - description: The client ID of the Azure AD application. - type: string - aws_region: - description: The AWS region. - type: string - account_id: - description: The AWS account ID. - type: string - role_name: - description: The AWS IAM role name. - type: string - domain: - description: The CodeArtifact domain. - type: string - domain_owner: - description: The CodeArtifact domain owner. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. - type: string - audience: - description: The OIDC audience. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. - type: string - namespace: - description: The Cloudsmith organization namespace. - type: string - service_slug: - description: The Cloudsmith service account slug. - type: string - api_host: - description: The Cloudsmith API host. - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - name - - registry_type - - visibility - - created_at - - updated_at - examples: - org-private-registry-with-selected-visibility: &410 - value: - name: MAVEN_REPOSITORY_SECRET - registry_type: maven_repository - username: monalisa - visibility: private - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - org-private-registry-with-private-visibility: - value: - name: MAVEN_REPOSITORY_SECRET - registry_type: maven_repository - username: monalisa - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/public-key": - get: - summary: Get private registries public key for an organization - description: |2- - - Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization - parameters: - - *87 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - key_id - - key - properties: - key_id: - description: The identifier for the key. - type: string - examples: - - '012345678912345678' - key: - description: The Base64 encoded public key. - type: string - examples: - - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - examples: - default: - value: - key_id: '012345678912345678' - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - headers: - Link: *45 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/{secret_name}": - get: - summary: Get a private registry for an organization - description: |2- - - Get the configuration of a single private registry defined for an organization, omitting its encrypted value. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization - parameters: - - *87 - - *288 - responses: - '200': - description: The specified private registry configuration for the organization - content: - application/json: - schema: *409 - examples: - default: *410 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - patch: - summary: Update a private registry for an organization - description: |2- - - Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, or `oidc_cloudsmith`), the `encrypted_value` and `key_id` fields should be omitted. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/update-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization - parameters: - - *87 - - *288 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - registry_type: - description: The registry type. - type: string - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with the private - registry. This field should be omitted if the private registry - does not require a username for authentication. - type: - - string - - 'null' - replaces_base: - description: Whether this private registry should replace the base - registry (e.g., npmjs.org for npm, rubygems.org for rubygems). - When set to `true`, Dependabot will only use this registry and - will not fall back to the public registry. When set to `false` - (default), Dependabot will use this registry for scoped packages - but may fall back to the public registry for other packages. - type: boolean - default: false - encrypted_value: - description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get private registries - public key for an organization](https://docs.github.com/enterprise-cloud@latest/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) - endpoint. + workload_identity_provider: + description: The full resource name of the GCP Workload Identity + Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`). + Required when `auth_type` is `oidc_gcp`. type: string - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - description: The ID of the key you used to encrypt the secret. - type: string - visibility: - description: Which type of organization repositories have access - to the private registry. `selected` means only the repositories - specified by `selected_repository_ids` can access the private - registry. - type: string - enum: - - all - - private - - selected - selected_repository_ids: - description: An array of repository IDs that can access the organization - private registry. You can only provide a list of repository IDs - when `visibility` is set to `selected`. This field should be omitted - if `visibility` is set to `all` or `private`. - type: array - items: - type: integer - auth_type: - description: The authentication type for the private registry. This - field cannot be changed after creation. If provided, it must match - the existing `auth_type` of the configuration. To change the authentication - type, delete and recreate the configuration. - type: string - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - - oidc_cloudsmith - tenant_id: - description: The tenant ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - client_id: - description: The client ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - aws_region: - description: The AWS region. Required when `auth_type` is `oidc_aws`. - type: string - account_id: - description: The AWS account ID. Required when `auth_type` is `oidc_aws`. - type: string - role_name: - description: The AWS IAM role name. Required when `auth_type` is - `oidc_aws`. - type: string - domain: - description: The CodeArtifact domain. Required when `auth_type` - is `oidc_aws`. - type: string - domain_owner: - description: The CodeArtifact domain owner (AWS account ID). Required - when `auth_type` is `oidc_aws`. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. Required when `auth_type` - is `oidc_jfrog`. - type: string - audience: - description: The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, - and required for `oidc_cloudsmith` auth types. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. Optional for `oidc_jfrog` - auth type. - type: string - namespace: - description: The Cloudsmith organization namespace. Required when - `auth_type` is `oidc_cloudsmith`. - type: string - service_slug: - description: The Cloudsmith service account slug. Required when - `auth_type` is `oidc_cloudsmith`. - type: string - api_host: - description: The Cloudsmith API host. Optional for `oidc_cloudsmith` - auth type. If omitted, `api.cloudsmith.io` is used by default. + service_account: + description: The GCP service account email to impersonate. Optional + for `oidc_gcp` auth type. If omitted, the federated token is used + directly (direct WIF). type: string examples: secret-based-update: @@ -58049,7 +60633,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &903 + - &904 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -58323,7 +60907,7 @@ paths: content: oneOf: - *219 - - &583 + - &584 title: Pull Request Simple description: Pull Request Simple type: object @@ -58562,7 +61146,7 @@ paths: - review_comment - self author_association: *216 - auto_merge: &698 + auto_merge: &699 title: Auto merge description: The status of auto merging a pull request. type: @@ -59019,7 +61603,7 @@ paths: - updated_at - project_url examples: - default: &836 + default: &837 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -59196,7 +61780,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &837 + items: &838 type: object properties: name: @@ -59233,7 +61817,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &838 + iteration_configuration: &839 type: object description: The configuration for iteration fields. properties: @@ -59283,7 +61867,7 @@ paths: value: name: Due date data_type: date - single_select_field: &839 + single_select_field: &840 summary: Create a single select field value: name: Priority @@ -59310,7 +61894,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &840 + iteration_field: &841 summary: Create an iteration field value: name: Sprint @@ -59336,7 +61920,7 @@ paths: application/json: schema: *416 examples: - text_field: &841 + text_field: &842 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -59345,7 +61929,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &842 + number_field: &843 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -59354,7 +61938,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &843 + date_field: &844 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -59363,7 +61947,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &844 + single_select_field: &845 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -59397,7 +61981,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &845 + iteration_field: &846 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -59443,7 +62027,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-organization parameters: - *413 - - &846 + - &847 name: field_id description: The unique identifier of the field. in: path @@ -59458,7 +62042,7 @@ paths: application/json: schema: *416 examples: - default: &847 + default: &848 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -60669,7 +63253,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &827 + schema: &828 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -60852,7 +63436,7 @@ paths: parameters: - *413 - *87 - - &848 + - &849 name: view_number description: The number that identifies the project view. in: path @@ -61622,7 +64206,7 @@ paths: description: Response content: application/json: - schema: &470 + schema: &471 title: Full Repository description: Full Repository type: object @@ -62100,7 +64684,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &588 + code_of_conduct: &589 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -62225,7 +64809,7 @@ paths: has_downloads: version: '2026-03-10' examples: - default: &472 + default: &473 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -62790,7 +65374,7 @@ paths: - *87 - *17 - *19 - - &720 + - &721 name: targets description: | A comma-separated list of rule targets to filter by. @@ -63007,7 +65591,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *87 - - &722 + - &723 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -63019,14 +65603,14 @@ paths: x-multi-segment: true - *304 - *105 - - &723 + - &724 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &724 + - &725 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -63046,7 +65630,7 @@ paths: description: Response content: application/json: - schema: &725 + schema: &726 title: Rule Suites description: Response type: array @@ -63102,7 +65686,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &726 + default: &727 value: - id: 21 actor_id: 12 @@ -63146,7 +65730,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *87 - - &727 + - &728 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -63162,7 +65746,7 @@ paths: description: Response content: application/json: - schema: &728 + schema: &729 title: Rule Suite description: Response type: object @@ -63269,7 +65853,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &729 + default: &730 value: id: 21 actor_id: 12 @@ -63605,7 +66189,7 @@ paths: - *110 - *19 - *17 - - &731 + - &732 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -63615,7 +66199,7 @@ paths: required: false schema: type: string - - &732 + - &733 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -63629,6 +66213,7 @@ paths: - *442 - *443 - *444 + - *445 responses: '200': description: Response @@ -63636,9 +66221,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *446 + default: *447 headers: Link: *45 '404': *6 @@ -63673,9 +66258,9 @@ paths: description: Response content: application/json: - schema: *447 + schema: *448 examples: - default: *448 + default: *449 '403': *27 '404': *6 patch: @@ -63828,7 +66413,7 @@ paths: application/json: schema: type: array - items: &753 + items: &754 description: A repository security advisory. type: object properties: @@ -64072,7 +66657,7 @@ paths: login: type: string description: The username of the user credited. - type: *449 + type: *450 credits_detailed: type: - array @@ -64083,7 +66668,7 @@ paths: type: object properties: user: *4 - type: *449 + type: *450 state: type: string description: The state of the user's acceptance of the @@ -64179,7 +66764,7 @@ paths: - private_fork version: '2026-03-10' examples: - default: &754 + default: &755 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -64665,7 +67250,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *87 - - *450 + - *451 - *17 - *19 responses: @@ -64673,9 +67258,9 @@ paths: description: Success content: application/json: - schema: *451 + schema: *452 examples: - default: *452 + default: *453 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -64958,7 +67543,7 @@ paths: type: array items: *145 examples: - default: *453 + default: *454 headers: Link: *45 x-github: @@ -65187,15 +67772,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - *87 - - *454 + - *455 responses: '200': description: Response content: application/json: - schema: *455 + schema: *456 examples: - default: *456 + default: *457 headers: Link: *45 x-github: @@ -65233,7 +67818,7 @@ paths: description: Response content: application/json: - schema: &467 + schema: &468 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -65285,7 +67870,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &468 + default: &469 value: groups: - group_id: '123' @@ -65505,7 +68090,7 @@ paths: description: Response content: application/json: - schema: &457 + schema: &458 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -65904,7 +68489,7 @@ paths: - repos_count - organization examples: - default: &458 + default: &459 value: id: 1 node_id: MDQ6VGVhbTE= @@ -65992,9 +68577,9 @@ paths: description: Response content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 '404': *6 x-github: githubCloudOnly: false @@ -66079,16 +68664,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 '201': description: Response content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 '404': *6 '422': *15 '403': *27 @@ -66118,7 +68703,7 @@ paths: responses: '204': description: Response - '422': &461 + '422': &462 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -66147,10 +68732,10 @@ paths: description: Response content: application/json: - schema: *459 + schema: *460 examples: - default: *460 - '422': *461 + default: *461 + '422': *462 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -66194,10 +68779,10 @@ paths: description: Response content: application/json: - schema: *462 + schema: *463 examples: - default: *463 - '422': *461 + default: *464 + '422': *462 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -66221,7 +68806,7 @@ paths: responses: '204': description: Response - '422': *461 + '422': *462 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -66258,7 +68843,7 @@ paths: default: *375 headers: Link: *45 - '422': *461 + '422': *462 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66340,7 +68925,7 @@ paths: description: Response content: application/json: - schema: &464 + schema: &465 title: Team Membership description: Team Membership type: object @@ -66368,7 +68953,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &795 + response-if-user-is-a-team-maintainer: &796 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -66431,9 +69016,9 @@ paths: description: Response content: application/json: - schema: *464 + schema: *465 examples: - response-if-users-membership-with-team-is-now-pending: &796 + response-if-users-membership-with-team-is-now-pending: &797 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -66540,14 +69125,14 @@ paths: parameters: - *87 - *214 - - *465 - *466 + - *467 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &797 + schema: &798 title: Team Repository description: A team's access to a repository. type: object @@ -67275,8 +69860,8 @@ paths: parameters: - *87 - *214 - - *465 - *466 + - *467 requestBody: required: false content: @@ -67323,8 +69908,8 @@ paths: parameters: - *87 - *214 - - *465 - *466 + - *467 responses: '204': description: Response @@ -67357,10 +69942,10 @@ paths: description: Response content: application/json: - schema: *467 + schema: *468 examples: - default: *468 - '422': *461 + default: *469 + '422': *462 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -67426,7 +70011,7 @@ paths: description: Response content: application/json: - schema: *467 + schema: *468 examples: default: value: @@ -67438,7 +70023,7 @@ paths: group_name: Octocat docs members group_description: The people who make your octoworld come to life. - '422': *461 + '422': *462 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -67472,7 +70057,7 @@ paths: type: array items: *307 examples: - response-if-child-teams-exist: &798 + response-if-child-teams-exist: &799 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -67626,7 +70211,7 @@ paths: resources: type: object properties: - core: &469 + core: &470 title: Rate Limit type: object properties: @@ -67643,21 +70228,21 @@ paths: - remaining - reset - used - graphql: *469 - search: *469 - code_search: *469 - source_import: *469 - integration_manifest: *469 - code_scanning_upload: *469 - actions_runner_registration: *469 - scim: *469 - dependency_snapshots: *469 - dependency_sbom: *469 - code_scanning_autofix: *469 + graphql: *470 + search: *470 + code_search: *470 + source_import: *470 + integration_manifest: *470 + code_scanning_upload: *470 + actions_runner_registration: *470 + scim: *470 + dependency_snapshots: *470 + dependency_sbom: *470 + code_scanning_autofix: *470 required: - core - search - rate: *469 + rate: *470 required: - rate - resources @@ -67776,14 +70361,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *470 + schema: *471 examples: default-response: summary: Default response @@ -68298,7 +70883,7 @@ paths: version: '2026-03-10' '403': *27 '404': *6 - '301': *471 + '301': *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68316,8 +70901,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#update-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: false content: @@ -68626,10 +71211,10 @@ paths: description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: *472 - '307': &473 + default: *473 + '307': &474 description: Temporary Redirect content: application/json: @@ -68658,8 +71243,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -68681,7 +71266,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository - '307': *473 + '307': *474 '404': *6 '409': *119 x-github: @@ -68705,11 +71290,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *465 - *466 + - *467 - *17 - *19 - - &490 + - &491 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -68732,7 +71317,7 @@ paths: type: integer artifacts: type: array - items: &474 + items: &475 title: Artifact description: An artifact type: object @@ -68827,7 +71412,7 @@ paths: - expires_at - updated_at examples: - default: &491 + default: &492 value: total_count: 2 artifacts: @@ -68888,9 +71473,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#get-an-artifact parameters: - - *465 - *466 - - &475 + - *467 + - &476 name: artifact_id description: The unique identifier of the artifact. in: path @@ -68902,7 +71487,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *475 examples: default: value: @@ -68940,9 +71525,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#delete-an-artifact parameters: - - *465 - *466 - - *475 + - *467 + - *476 responses: '204': description: Response @@ -68966,9 +71551,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#download-an-artifact parameters: - - *465 - *466 - - *475 + - *467 + - *476 - name: archive_format in: path required: true @@ -68978,11 +71563,11 @@ paths: '302': description: Response headers: - Location: &605 + Location: &606 example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &653 + '410': &654 description: Gone content: application/json: @@ -69007,14 +71592,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: &476 + schema: &477 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -69048,13 +71633,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: application/json: - schema: *476 + schema: *477 examples: selected_actions: *42 responses: @@ -69083,14 +71668,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: &477 + schema: &478 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -69124,13 +71709,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: application/json: - schema: *477 + schema: *478 examples: selected_actions: *44 responses: @@ -69161,14 +71746,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *478 + schema: *479 examples: default: value: @@ -69194,11 +71779,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *465 - *466 + - *467 - *17 - *19 - - &479 + - &480 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -69232,7 +71817,7 @@ paths: description: Response content: application/json: - schema: &480 + schema: &481 title: Repository actions caches description: Repository actions caches type: object @@ -69282,7 +71867,7 @@ paths: - total_count - actions_caches examples: - default: &481 + default: &482 value: total_count: 1 actions_caches: @@ -69314,23 +71899,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *465 - *466 + - *467 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *479 + - *480 responses: '200': description: Response content: application/json: - schema: *480 + schema: *481 examples: - default: *481 + default: *482 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69350,8 +71935,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *465 - *466 + - *467 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -69366,6 +71951,245 @@ paths: enabledForGitHubApps: true category: actions subcategory: cache + "/repos/{owner}/{repo}/actions/concurrency_groups": + get: + summary: List concurrency groups for a repository + description: |- + Lists the active concurrency groups for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-concurrency-groups-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository + parameters: + - *466 + - *467 + - *17 + - *109 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Concurrency Group List + description: A list of active concurrency groups for a repository. + type: object + required: + - total_count + - concurrency_groups + properties: + total_count: + type: integer + concurrency_groups: + type: array + items: + type: object + required: + - group_name + - group_url + - last_acquired_at + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: API URL for this concurrency group. + last_acquired_at: + type: + - string + - 'null' + format: date-time + examples: + default: + value: + total_count: 2 + concurrency_groups: + - group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + last_acquired_at: '2026-01-15T16:14:23Z' + - group_name: ci-build + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build + last_acquired_at: '2026-01-15T16:13:55Z' + headers: + Link: *45 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups + "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}": + get: + summary: Get a concurrency group for a repository + description: |- + Gets a specific concurrency group for a repository, including all instances in the group's queue. + Returns 404 if the group is inactive or does not exist. + + Optionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items + ahead of the specified workflow run or job in the queue, plus the specified item itself + (returned as the last element). This is useful for determining what is blocking a particular + run or job. Returns 422 if the specified run or job is not in this concurrency group. + + When using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow + leases held on behalf of that run. Job-level leases within the run are not considered to + block the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow + leases on the job's ancestor paths. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-concurrency-group-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository + parameters: + - *466 + - *467 + - name: concurrency_group_name + description: The name of the concurrency group. + in: path + required: true + schema: + type: string + - name: ahead_of_run + description: |- + Filter to items ahead of this workflow run ID in the queue, plus the run itself. + Matches workflow-level concurrency and reusable-workflow leases held on behalf of + the run. Mutually exclusive with `ahead_of_job`. + in: query + required: false + schema: + type: integer + minimum: 1 + - name: ahead_of_job + description: |- + Filter to items ahead of this job ID in the queue, plus the job itself. + Matches job-level concurrency and reusable-workflow leases on the job's + ancestor paths. Mutually exclusive with `ahead_of_run`. + in: query + required: false + schema: + type: integer + minimum: 1 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Concurrency Group + description: |- + A concurrency group with the workflow runs and jobs that are either currently holding + or waiting for the concurrency group lease. + type: object + required: + - group_name + - group_url + - total_count + - group_members + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: API URL for this concurrency group. + total_count: + type: integer + group_members: + type: array + items: + type: object + required: + - run_id + - run_name + - run_url + - run_html_url + - status + properties: + run_id: + type: integer + description: The ID of the workflow run. + run_name: + type: string + description: The name of the workflow run. + run_url: + type: + - string + - 'null' + format: uri + description: API URL for the workflow run. + run_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the workflow run. + job_id: + type: integer + description: The ID of the job, when the item represents + a job-level or reusable-workflow-level lease. + job_name: + type: string + description: The display name of the job, when the item + represents a job-level or reusable-workflow-level lease. + job_url: + type: + - string + - 'null' + format: uri + description: API URL for the job. + job_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the job. + status: + type: string + enum: + - in_progress + - pending + examples: + default: + value: + group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + total_count: 3 + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: in_progress + - run_id: 30433643 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433643 + status: pending + - run_id: 30433644 + run_name: Deploy hotfix + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433644 + job_id: 798245260 + job_name: deploy + job_url: https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260 + job_html_url: https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260 + status: pending + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups "/repos/{owner}/{repo}/actions/jobs/{job_id}": get: summary: Get a job for a workflow run @@ -69382,9 +72206,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *465 - *466 - - &482 + - *467 + - &483 name: job_id description: The unique identifier of the job. in: path @@ -69396,7 +72220,7 @@ paths: description: Response content: application/json: - schema: &494 + schema: &495 title: Job description: Information of a job execution in a workflow run type: object @@ -69743,9 +72567,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *465 - *466 - - *482 + - *467 + - *483 responses: '302': description: Response @@ -69773,9 +72597,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *465 - *466 - - *482 + - *467 + - *483 requestBody: required: false content: @@ -69821,8 +72645,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Status response @@ -69881,8 +72705,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -69950,8 +72774,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-organization-secrets parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -69969,7 +72793,7 @@ paths: type: integer secrets: type: array - items: &496 + items: &497 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -69990,7 +72814,7 @@ paths: - created_at - updated_at examples: - default: &497 + default: &498 value: total_count: 2 secrets: @@ -70023,9 +72847,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-organization-variables parameters: - - *465 - *466 - - *483 + - *467 + - *484 - *19 responses: '200': @@ -70042,7 +72866,7 @@ paths: type: integer variables: type: array - items: &500 + items: &501 title: Actions Variable type: object properties: @@ -70076,7 +72900,7 @@ paths: - created_at - updated_at examples: - default: &501 + default: &502 value: total_count: 2 variables: @@ -70109,8 +72933,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -70119,7 +72943,7 @@ paths: schema: type: object properties: - enabled: &484 + enabled: &485 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *60 @@ -70154,8 +72978,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -70166,7 +72990,7 @@ paths: schema: type: object properties: - enabled: *484 + enabled: *485 allowed_actions: *60 sha_pinning_required: *61 required: @@ -70199,14 +73023,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: &485 + schema: &486 type: object properties: access_level: @@ -70224,7 +73048,7 @@ paths: required: - access_level examples: - default: &486 + default: &487 value: access_level: organization x-github: @@ -70249,15 +73073,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: application/json: - schema: *485 + schema: *486 examples: - default: *486 + default: *487 responses: '204': description: Response @@ -70281,8 +73105,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -70312,8 +73136,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Empty response for successful settings update @@ -70347,8 +73171,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -70375,8 +73199,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -70410,8 +73234,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -70439,8 +73263,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -70471,8 +73295,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -70503,8 +73327,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -70536,8 +73360,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -70566,8 +73390,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Success response @@ -70607,8 +73431,8 @@ paths: in: query schema: type: string - - *465 - *466 + - *467 - *17 - *19 responses: @@ -70652,8 +73476,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -70685,8 +73509,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -70760,8 +73584,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *465 - *466 + - *467 responses: '201': description: Response @@ -70797,8 +73621,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *465 - *466 + - *467 responses: '201': description: Response @@ -70828,8 +73652,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *465 - *466 + - *467 - *75 responses: '200': @@ -70859,8 +73683,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *465 - *466 + - *467 - *75 responses: '204': @@ -70887,8 +73711,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *465 - *466 + - *467 - *75 responses: '200': *81 @@ -70913,8 +73737,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *465 - *466 + - *467 - *75 requestBody: required: true @@ -70963,8 +73787,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *465 - *466 + - *467 - *75 requestBody: required: true @@ -71014,8 +73838,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *465 - *466 + - *467 - *75 responses: '200': *285 @@ -71045,8 +73869,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *465 - *466 + - *467 - *75 - *286 responses: @@ -71076,9 +73900,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *465 - *466 - - &504 + - *467 + - &505 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -71086,7 +73910,7 @@ paths: required: false schema: type: string - - &505 + - &506 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -71094,7 +73918,7 @@ paths: required: false schema: type: string - - &506 + - &507 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -71103,7 +73927,7 @@ paths: required: false schema: type: string - - &507 + - &508 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -71130,7 +73954,7 @@ paths: - pending - *17 - *19 - - &508 + - &509 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -71139,7 +73963,7 @@ paths: schema: type: string format: date-time - - &487 + - &488 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -71148,13 +73972,13 @@ paths: schema: type: boolean default: false - - &509 + - &510 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &510 + - &511 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -71177,7 +74001,7 @@ paths: type: integer workflow_runs: type: array - items: &488 + items: &489 title: Workflow Run description: An invocation of a workflow type: object @@ -71355,7 +74179,7 @@ paths: head_commit: anyOf: - type: 'null' - - &532 + - &533 title: Simple Commit description: A commit. type: object @@ -71470,7 +74294,7 @@ paths: - workflow_url - pull_requests examples: - default: &511 + default: &512 value: total_count: 1 workflow_runs: @@ -71706,24 +74530,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *465 - *466 - - &489 + - *467 + - &490 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *487 + - *488 responses: '200': description: Response content: application/json: - schema: *488 + schema: *489 examples: - default: &492 + default: &493 value: id: 30433642 name: Build @@ -71964,9 +74788,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '204': description: Response @@ -71989,9 +74813,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '200': description: Response @@ -72119,9 +74943,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '201': description: Response @@ -72154,12 +74978,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *465 - *466 - - *489 + - *467 + - *490 - *17 - *19 - - *490 + - *491 - *110 responses: '200': @@ -72176,9 +75000,9 @@ paths: type: integer artifacts: type: array - items: *474 + items: *475 examples: - default: *491 + default: *492 headers: Link: *45 x-github: @@ -72202,25 +75026,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *465 - *466 - - *489 - - &493 + - *467 + - *490 + - &494 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *487 + - *488 responses: '200': description: Response content: application/json: - schema: *488 + schema: *489 examples: - default: *492 + default: *493 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72243,10 +75067,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *465 - *466 - - *489 - - *493 + - *467 + - *490 + - *494 - *17 - *19 responses: @@ -72264,9 +75088,9 @@ paths: type: integer jobs: type: array - items: *494 + items: *495 examples: - default: &495 + default: &496 value: total_count: 1 jobs: @@ -72379,10 +75203,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *465 - *466 - - *489 - - *493 + - *467 + - *490 + - *494 responses: '302': description: Response @@ -72410,9 +75234,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '202': description: Response @@ -72428,6 +75252,198 @@ paths: enabledForGitHubApps: true category: actions subcategory: workflow-runs + "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups": + get: + summary: List concurrency groups for a workflow run + description: |- + Lists all concurrency groups associated with a workflow run or its jobs. + + The set of groups is derived from the run's configuration, so a group is + included even when the run no longer has any items currently holding or + waiting in it. In that case the `group_members` array will be empty. + `total_count` reflects the number of groups the run participates in by + configuration, not the number with active items. + + This differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`, + which returns 404 when a group has no active items. That endpoint reports + the live state of a group repo-wide, while this endpoint reports the + groups associated with a specific run by configuration. + + Results are sorted by group name and support cursor-based pagination via + `before` and `after`. The `after` cursor paginates forward only and does + not emit a `rel="prev"` Link; use `before` to page backward from a + forward page's `next` cursor. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-concurrency-groups-for-workflow-run + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run + parameters: + - *466 + - *467 + - *490 + - *17 + - *108 + - *109 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Concurrency Group Run List + description: A list of concurrency groups associated with a workflow + run. + type: object + required: + - total_count + - concurrency_groups + properties: + total_count: + type: integer + description: |- + The total number of concurrency groups this workflow run participates in, + derived from the run's configuration. This count is not filtered by + whether the run currently holds or is waiting in each group, so it can + include groups whose `group_members` array is empty (for example, when + the run has already released its lease in that group). + concurrency_groups: + type: array + items: + type: object + required: + - group_name + - group_url + - group_members + properties: + group_name: + type: string + description: The name of the concurrency group. + group_url: + type: string + format: uri + description: |- + API URL for this concurrency group. May return 404 if the group + has no active items at the time it is requested, since the + get-by-name endpoint reports the live repo-wide state of a group + while this endpoint lists groups associated with a run by + configuration. + group_members: + type: array + description: |- + Items belonging to this workflow run that are either currently holding or + waiting for the concurrency group lease. May be empty if the run no + longer has any active or queued items in this group. + items: + type: object + required: + - run_id + - run_name + - run_url + - run_html_url + - status + - position + - position_url + properties: + run_id: + type: integer + description: The ID of the workflow run. + run_name: + type: string + description: The name of the workflow run. + run_url: + type: + - string + - 'null' + format: uri + description: API URL for the workflow run. + run_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the workflow run. + position: + type: integer + description: Queue position. 0 means the item holds + the concurrency lease (in_progress), 1 or higher + means queued (pending). + position_url: + type: string + format: uri + description: API URL to get items ahead of this item + in the concurrency group. + job_id: + type: + - integer + - 'null' + description: The ID of the job, when the item represents + a job-level or reusable-workflow-level lease. + job_name: + type: + - string + - 'null' + description: The display name of the job, when the + item represents a job-level or reusable-workflow-level + lease. + job_url: + type: + - string + - 'null' + format: uri + description: API URL for the job. + job_html_url: + type: + - string + - 'null' + format: uri + description: Web URL for the job. + status: + type: string + enum: + - in_progress + - pending + examples: + default: + value: + total_count: 2 + concurrency_groups: + - group_name: deploy-prod + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: in_progress + position: 0 + position_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642 + - group_name: ci-build + group_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build + group_members: + - run_id: 30433642 + run_name: Deploy to production + run_url: https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642 + run_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642 + status: pending + position: 2 + position_url: https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260 + job_id: 798245260 + job_name: build + job_url: https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260 + job_html_url: https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260 + headers: + Link: *45 + '404': *6 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: concurrency-groups "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": post: summary: Review custom deployment protection rules for a workflow run @@ -72445,9 +75461,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 requestBody: required: true content: @@ -72514,9 +75530,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '202': description: Response @@ -72549,9 +75565,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -72581,9 +75597,9 @@ paths: type: integer jobs: type: array - items: *494 + items: *495 examples: - default: *495 + default: *496 headers: Link: *45 x-github: @@ -72608,9 +75624,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '302': description: Response @@ -72637,9 +75653,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '204': description: Response @@ -72666,9 +75682,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '200': description: Response @@ -72737,7 +75753,7 @@ paths: items: type: object properties: - type: &620 + type: &621 type: string description: The type of reviewer. enum: @@ -72823,9 +75839,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 requestBody: required: true content: @@ -72875,7 +75891,7 @@ paths: application/json: schema: type: array - items: &607 + items: &608 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -72987,7 +76003,7 @@ paths: - created_at - updated_at examples: - default: &608 + default: &609 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -73043,9 +76059,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *465 - *466 - - *489 + - *467 + - *490 requestBody: required: false content: @@ -73090,9 +76106,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *465 - *466 - - *489 + - *467 + - *490 requestBody: required: false content: @@ -73147,9 +76163,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *465 - *466 - - *489 + - *467 + - *490 responses: '200': description: Response @@ -73286,8 +76302,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-secrets parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -73305,9 +76321,9 @@ paths: type: integer secrets: type: array - items: *496 + items: *497 examples: - default: *497 + default: *498 headers: Link: *45 x-github: @@ -73332,16 +76348,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-public-key parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *498 + schema: *499 examples: - default: *499 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73363,17 +76379,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 responses: '200': description: Response content: application/json: - schema: *496 + schema: *497 examples: - default: &633 + default: &634 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -73399,8 +76415,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 requestBody: required: true @@ -73458,8 +76474,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 responses: '204': @@ -73485,9 +76501,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-variables parameters: - - *465 - *466 - - *483 + - *467 + - *484 - *19 responses: '200': @@ -73504,9 +76520,9 @@ paths: type: integer variables: type: array - items: *500 + items: *501 examples: - default: *501 + default: *502 headers: Link: *45 x-github: @@ -73529,8 +76545,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-a-repository-variable parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -73582,17 +76598,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-a-repository-variable parameters: - - *465 - *466 + - *467 - *291 responses: '200': description: Response content: application/json: - schema: *500 + schema: *501 examples: - default: &634 + default: &635 value: name: USERNAME value: octocat @@ -73618,8 +76634,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-a-repository-variable parameters: - - *465 - *466 + - *467 - *291 requestBody: required: true @@ -73662,8 +76678,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-a-repository-variable parameters: - - *465 - *466 + - *467 - *291 responses: '204': @@ -73689,8 +76705,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#list-repository-workflows parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -73708,7 +76724,7 @@ paths: type: integer workflows: type: array - items: &502 + items: &503 title: Workflow description: A GitHub Actions workflow type: object @@ -73826,9 +76842,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-a-workflow parameters: - - *465 - *466 - - &503 + - *467 + - &504 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -73843,7 +76859,7 @@ paths: description: Response content: application/json: - schema: *502 + schema: *503 examples: default: value: @@ -73876,9 +76892,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#disable-a-workflow parameters: - - *465 - *466 - - *503 + - *467 + - *504 responses: '204': description: Response @@ -73903,9 +76919,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *465 - *466 - - *503 + - *467 + - *504 responses: '204': description: Empty response when `return_run_details` parameter is `false`. @@ -74003,9 +77019,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#enable-a-workflow parameters: - - *465 - *466 - - *503 + - *467 + - *504 responses: '204': description: Response @@ -74032,19 +77048,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *465 - *466 - - *503 + - *467 - *504 - *505 - *506 - *507 + - *508 - *17 - *19 - - *508 - - *487 - *509 + - *488 - *510 + - *511 responses: '200': description: Response @@ -74060,9 +77076,9 @@ paths: type: integer workflow_runs: type: array - items: *488 + items: *489 examples: - default: *511 + default: *512 headers: Link: *45 x-github: @@ -74095,9 +77111,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-workflow-usage parameters: - - *465 - *466 - - *503 + - *467 + - *504 responses: '200': description: Response @@ -74158,8 +77174,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-activities parameters: - - *465 - *466 + - *467 - *110 - *17 - *108 @@ -74327,8 +77343,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#list-assignees parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -74365,8 +77381,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *465 - *466 + - *467 - name: assignee in: path required: true @@ -74402,8 +77418,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#create-an-attestation parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -74513,8 +77529,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#list-attestations parameters: - - *465 - *466 + - *467 - *17 - *108 - *109 @@ -74571,7 +77587,7 @@ paths: initiator: type: string examples: - default: *512 + default: *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74605,8 +77621,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -74614,7 +77630,7 @@ paths: application/json: schema: type: array - items: &513 + items: &514 title: Autolink reference description: An autolink reference. type: object @@ -74673,8 +77689,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -74713,9 +77729,9 @@ paths: description: response content: application/json: - schema: *513 + schema: *514 examples: - default: &514 + default: &515 value: id: 1 key_prefix: TICKET- @@ -74746,9 +77762,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *465 - *466 - - &515 + - *467 + - &516 name: autolink_id description: The unique identifier of the autolink. in: path @@ -74760,9 +77776,9 @@ paths: description: Response content: application/json: - schema: *513 + schema: *514 examples: - default: *514 + default: *515 '404': *6 x-github: githubCloudOnly: false @@ -74782,9 +77798,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *465 - *466 - - *515 + - *467 + - *516 responses: '204': description: Response @@ -74808,8 +77824,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response if Dependabot is enabled @@ -74859,8 +77875,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-dependabot-security-updates parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -74881,8 +77897,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-dependabot-security-updates parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -74902,8 +77918,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#list-branches parameters: - - *465 - *466 + - *467 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -74941,7 +77957,7 @@ paths: - url protected: type: boolean - protection: &517 + protection: &518 title: Branch Protection description: Branch Protection type: object @@ -74984,7 +78000,7 @@ paths: required: - contexts - checks - enforce_admins: &520 + enforce_admins: &521 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -75001,7 +78017,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &522 + required_pull_request_reviews: &523 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -75085,7 +78101,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &519 + restrictions: &520 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -75378,9 +78394,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#get-a-branch parameters: - - *465 - *466 - - &518 + - *467 + - &519 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest/graphql). @@ -75394,14 +78410,14 @@ paths: description: Response content: application/json: - schema: &528 + schema: &529 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &579 + commit: &580 title: Commit description: Commit type: object @@ -75440,7 +78456,7 @@ paths: author: anyOf: - type: 'null' - - &516 + - &517 title: Git User description: Metaproperties for Git author/committer information. @@ -75462,7 +78478,7 @@ paths: committer: anyOf: - type: 'null' - - *516 + - *517 message: type: string examples: @@ -75486,7 +78502,7 @@ paths: required: - sha - url - verification: &640 + verification: &641 title: Verification type: object properties: @@ -75566,7 +78582,7 @@ paths: type: integer files: type: array - items: &590 + items: &591 title: Diff Entry description: Diff Entry type: object @@ -75662,7 +78678,7 @@ paths: - self protected: type: boolean - protection: *517 + protection: *518 protection_url: type: string format: uri @@ -75771,7 +78787,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *471 + '301': *472 '404': *6 x-github: githubCloudOnly: false @@ -75793,15 +78809,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-branch-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *517 + schema: *518 examples: default: value: @@ -75995,9 +79011,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-branch-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -76257,7 +79273,7 @@ paths: url: type: string format: uri - required_status_checks: &525 + required_status_checks: &526 title: Status Check Policy description: Status Check Policy type: object @@ -76416,7 +79432,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *519 + restrictions: *520 required_conversation_resolution: type: object properties: @@ -76528,9 +79544,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-branch-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '204': description: Response @@ -76555,17 +79571,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *520 + schema: *521 examples: - default: &521 + default: &522 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -76587,17 +79603,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *520 + schema: *521 examples: - default: *521 + default: *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76616,9 +79632,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '204': description: Response @@ -76643,17 +79659,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *522 + schema: *523 examples: - default: &523 + default: &524 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -76749,9 +79765,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: false content: @@ -76849,9 +79865,9 @@ paths: description: Response content: application/json: - schema: *522 + schema: *523 examples: - default: *523 + default: *524 '422': *15 x-github: githubCloudOnly: false @@ -76872,9 +79888,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '204': description: Response @@ -76901,17 +79917,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *520 + schema: *521 examples: - default: &524 + default: &525 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -76934,17 +79950,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *520 + schema: *521 examples: - default: *524 + default: *525 '404': *6 x-github: githubCloudOnly: false @@ -76964,9 +79980,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '204': description: Response @@ -76991,17 +80007,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-status-checks-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *525 + schema: *526 examples: - default: &526 + default: &527 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -77027,9 +80043,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-status-check-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: false content: @@ -77081,9 +80097,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *526 examples: - default: *526 + default: *527 '404': *6 '422': *15 x-github: @@ -77105,9 +80121,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-protection parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '204': description: Response @@ -77131,9 +80147,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response @@ -77167,9 +80183,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-status-check-contexts parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: false content: @@ -77236,9 +80252,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-status-check-contexts parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: false content: @@ -77302,9 +80318,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: content: application/json: @@ -77370,15 +80386,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response content: application/json: - schema: *519 + schema: *520 examples: default: value: @@ -77469,9 +80485,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '204': description: Response @@ -77494,9 +80510,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response @@ -77506,7 +80522,7 @@ paths: type: array items: *5 examples: - default: &527 + default: &528 value: - id: 1 slug: octoapp @@ -77563,9 +80579,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -77599,7 +80615,7 @@ paths: type: array items: *5 examples: - default: *527 + default: *528 '422': *15 x-github: githubCloudOnly: false @@ -77620,9 +80636,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -77656,7 +80672,7 @@ paths: type: array items: *5 examples: - default: *527 + default: *528 '422': *15 x-github: githubCloudOnly: false @@ -77677,9 +80693,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -77713,7 +80729,7 @@ paths: type: array items: *5 examples: - default: *527 + default: *528 '422': *15 x-github: githubCloudOnly: false @@ -77735,9 +80751,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response @@ -77767,9 +80783,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: false content: @@ -77828,9 +80844,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: false content: @@ -77889,9 +80905,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: content: application/json: @@ -77950,9 +80966,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *465 - *466 - - *518 + - *467 + - *519 responses: '200': description: Response @@ -77986,9 +81002,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -78046,9 +81062,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -78106,9 +81122,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -78168,9 +81184,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#rename-a-branch parameters: - - *465 - *466 - - *518 + - *467 + - *519 requestBody: required: true content: @@ -78192,7 +81208,7 @@ paths: description: Response content: application/json: - schema: *528 + schema: *529 examples: default: value: @@ -78306,8 +81322,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *465 - *466 + - *467 - *103 - *104 - *105 @@ -78343,8 +81359,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *465 - *466 + - *467 - name: bypass_request_number in: path required: true @@ -78417,8 +81433,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *465 - *466 + - *467 - *103 - *104 - *105 @@ -78458,8 +81474,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *465 - *466 + - *467 - name: bypass_request_number in: path required: true @@ -78529,8 +81545,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *465 - *466 + - *467 - name: bypass_request_number in: path required: true @@ -78601,8 +81617,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *465 - *466 + - *467 - name: bypass_response_id in: path required: true @@ -78635,8 +81651,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#create-a-check-run parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -78915,7 +81931,7 @@ paths: description: Response content: application/json: - schema: &529 + schema: &530 title: CheckRun description: A check performed on the code of a given code change type: object @@ -79051,7 +82067,7 @@ paths: check. type: array items: *222 - deployment: &859 + deployment: &860 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -79338,9 +82354,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#get-a-check-run parameters: - - *465 - *466 - - &530 + - *467 + - &531 name: check_run_id description: The unique identifier of the check run. in: path @@ -79352,9 +82368,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *530 examples: - default: &531 + default: &532 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -79454,9 +82470,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run parameters: - - *465 - *466 - - *530 + - *467 + - *531 requestBody: required: true content: @@ -79696,9 +82712,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *530 examples: - default: *531 + default: *532 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79718,9 +82734,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-run-annotations parameters: - - *465 - *466 - - *530 + - *467 + - *531 - *17 - *19 responses: @@ -79830,9 +82846,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#rerequest-a-check-run parameters: - - *465 - *466 - - *530 + - *467 + - *531 responses: '201': description: Response @@ -79876,8 +82892,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -79899,7 +82915,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &533 + schema: &534 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -79997,7 +83013,7 @@ paths: - string - 'null' format: date-time - head_commit: *532 + head_commit: *533 latest_check_runs_count: type: integer check_runs_url: @@ -80025,7 +83041,7 @@ paths: - check_runs_url - pull_requests examples: - default: &534 + default: &535 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -80316,9 +83332,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *533 + schema: *534 examples: - default: *534 + default: *535 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80337,8 +83353,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -80647,9 +83663,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite parameters: - - *465 - *466 - - &535 + - *467 + - &536 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -80661,9 +83677,9 @@ paths: description: Response content: application/json: - schema: *533 + schema: *534 examples: - default: *534 + default: *535 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80686,17 +83702,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *465 - *466 - - *535 - - &585 + - *467 + - *536 + - &586 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &586 + - &587 name: status description: Returns check runs with the specified `status`. in: query @@ -80735,9 +83751,9 @@ paths: type: integer check_runs: type: array - items: *529 + items: *530 examples: - default: &587 + default: &588 value: total_count: 1 check_runs: @@ -80839,9 +83855,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#rerequest-a-check-suite parameters: - - *465 - *466 - - *535 + - *467 + - *536 responses: '201': description: Response @@ -80874,21 +83890,21 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *465 - *466 + - *467 - *311 - *312 - *19 - *17 - - &551 + - &552 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *536 - - &552 + schema: *537 + - &553 name: pr description: The number of the pull request for the results you want to list. in: query @@ -80919,7 +83935,7 @@ paths: be returned. in: query required: false - schema: *537 + schema: *538 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -80943,7 +83959,7 @@ paths: updated_at: *135 url: *132 html_url: *133 - instances_url: *538 + instances_url: *539 state: *113 fixed_at: *137 dismissed_by: @@ -80951,11 +83967,11 @@ paths: - type: 'null' - *4 dismissed_at: *136 - dismissed_reason: *539 - dismissed_comment: *540 - rule: *541 - tool: *542 - most_recent_instance: *543 + dismissed_reason: *540 + dismissed_comment: *541 + rule: *542 + tool: *543 + most_recent_instance: *544 dismissal_approved_by: anyOf: - type: 'null' @@ -81078,7 +84094,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &544 + '403': &545 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -81105,9 +84121,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *465 - *466 - - &545 + - *467 + - &546 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -81121,7 +84137,7 @@ paths: description: Response content: application/json: - schema: &546 + schema: &547 type: object properties: number: *127 @@ -81129,7 +84145,7 @@ paths: updated_at: *135 url: *132 html_url: *133 - instances_url: *538 + instances_url: *539 state: *113 fixed_at: *137 dismissed_by: @@ -81137,8 +84153,8 @@ paths: - type: 'null' - *4 dismissed_at: *136 - dismissed_reason: *539 - dismissed_comment: *540 + dismissed_reason: *540 + dismissed_comment: *541 rule: type: object properties: @@ -81200,8 +84216,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *542 - most_recent_instance: *543 + tool: *543 + most_recent_instance: *544 dismissal_approved_by: anyOf: - type: 'null' @@ -81297,7 +84313,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -81317,9 +84333,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 requestBody: required: true content: @@ -81334,8 +84350,8 @@ paths: enum: - open - dismissed - dismissed_reason: *539 - dismissed_comment: *540 + dismissed_reason: *540 + dismissed_comment: *541 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -81363,7 +84379,7 @@ paths: description: Response content: application/json: - schema: *546 + schema: *547 examples: default: value: @@ -81439,7 +84455,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &550 + '403': &551 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -81466,15 +84482,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 responses: '200': description: Response content: application/json: - schema: &547 + schema: &548 type: object properties: status: @@ -81501,13 +84517,13 @@ paths: - description - started_at examples: - default: &548 + default: &549 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &549 + '400': &550 description: Bad Request content: application/json: @@ -81518,7 +84534,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -81543,29 +84559,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 responses: '200': description: OK content: application/json: - schema: *547 + schema: *548 examples: - default: *548 + default: *549 '202': description: Accepted content: application/json: - schema: *547 + schema: *548 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *549 + '400': *550 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -81597,9 +84613,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 requestBody: required: false content: @@ -81645,8 +84661,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *549 - '403': *550 + '400': *550 + '403': *551 '404': *6 '422': description: Unprocessable Entity @@ -81670,13 +84686,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 - *19 - *17 - - *551 - *552 + - *553 responses: '200': description: Response @@ -81687,10 +84703,10 @@ paths: items: type: object properties: - ref: *536 - analysis_key: *553 - environment: *554 - category: *555 + ref: *537 + analysis_key: *554 + environment: *555 + category: *556 state: type: - string @@ -81707,7 +84723,7 @@ paths: properties: text: type: string - location: *556 + location: *557 html_url: type: string classifications: @@ -81715,7 +84731,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: *557 + items: *558 examples: default: value: @@ -81752,7 +84768,7 @@ paths: end_column: 50 classifications: - source - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -81786,25 +84802,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *465 - *466 + - *467 - *311 - *312 - *19 - *17 - - *552 + - *553 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *536 + schema: *537 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &558 + schema: &559 type: string description: An identifier for the upload. examples: @@ -81826,23 +84842,23 @@ paths: application/json: schema: type: array - items: &559 + items: &560 type: object properties: - ref: *536 - commit_sha: &567 + ref: *537 + commit_sha: &568 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *553 + analysis_key: *554 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *555 + category: *556 error: type: string examples: @@ -81867,8 +84883,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *558 - tool: *542 + sarif_id: *559 + tool: *543 deletable: type: boolean warning: @@ -81930,7 +84946,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -81966,8 +84982,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *465 - *466 + - *467 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -81980,7 +84996,7 @@ paths: description: Response content: application/json: - schema: *559 + schema: *560 examples: response: summary: application/json response @@ -82034,7 +85050,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *544 + '403': *545 '404': *6 '422': description: Response if analysis could not be processed @@ -82121,8 +85137,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *465 - *466 + - *467 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -82178,7 +85194,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *550 + '403': *551 '404': *6 '503': *192 x-github: @@ -82200,8 +85216,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -82209,7 +85225,7 @@ paths: application/json: schema: type: array - items: &560 + items: &561 title: CodeQL Database description: A CodeQL database. type: object @@ -82321,7 +85337,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -82350,8 +85366,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *465 - *466 + - *467 - name: language in: path description: The language of the CodeQL database. @@ -82363,7 +85379,7 @@ paths: description: Response content: application/json: - schema: *560 + schema: *561 examples: default: value: @@ -82395,9 +85411,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &594 + '302': &595 description: Found - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -82419,8 +85435,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *465 - *466 + - *467 - name: language in: path description: The language of the CodeQL database. @@ -82430,7 +85446,7 @@ paths: responses: '204': description: Response - '403': *550 + '403': *551 '404': *6 '503': *192 x-github: @@ -82458,8 +85474,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -82468,7 +85484,7 @@ paths: type: object additionalProperties: false properties: - language: &561 + language: &562 type: string description: The language targeted by the CodeQL query enum: @@ -82548,7 +85564,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &565 + schema: &566 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -82558,7 +85574,7 @@ paths: description: The ID of the variant analysis. controller_repo: *120 actor: *4 - query_language: *561 + query_language: *562 query_pack_url: type: string description: The download url for the query pack. @@ -82606,7 +85622,7 @@ paths: items: type: object properties: - repository: &562 + repository: &563 title: Repository Identifier description: Repository Identifier type: object @@ -82648,7 +85664,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &566 + analysis_status: &567 type: string description: The new status of the CodeQL variant analysis repository task. @@ -82680,7 +85696,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &563 + access_mismatch_repos: &564 type: object properties: repository_count: @@ -82695,7 +85711,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *562 + items: *563 required: - repository_count - repositories @@ -82718,8 +85734,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *563 - over_limit_repos: *563 + no_codeql_db_repos: *564 + over_limit_repos: *564 required: - access_mismatch_repos - not_found_repos @@ -82735,7 +85751,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &564 + value: &565 summary: Default response value: id: 1 @@ -82881,10 +85897,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *564 + value: *565 repository_lists: summary: Response for a successful variant analysis submission - value: *564 + value: *565 '404': *6 '422': description: Unable to process variant analysis submission @@ -82912,8 +85928,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *465 - *466 + - *467 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -82925,9 +85941,9 @@ paths: description: Response content: application/json: - schema: *565 + schema: *566 examples: - default: *564 + default: *565 '404': *6 '503': *192 x-github: @@ -82950,7 +85966,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *465 + - *466 - name: repo in: path description: The name of the controller repository. @@ -82985,7 +86001,7 @@ paths: type: object properties: repository: *120 - analysis_status: *566 + analysis_status: *567 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -83110,8 +86126,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -83221,7 +86237,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *544 + '403': *545 '404': *6 '503': *192 x-github: @@ -83242,8 +86258,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -83337,7 +86353,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *550 + '403': *551 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -83408,8 +86424,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -83417,7 +86433,7 @@ paths: schema: type: object properties: - commit_sha: *567 + commit_sha: *568 ref: type: string description: |- @@ -83477,7 +86493,7 @@ paths: schema: type: object properties: - id: *558 + id: *559 url: type: string description: The REST API URL for checking the status of the upload. @@ -83491,7 +86507,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *550 + '403': *551 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -83514,8 +86530,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *465 - *466 + - *467 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -83563,7 +86579,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *544 + '403': *545 '404': description: Not Found if the sarif id does not match any upload '503': *192 @@ -83588,8 +86604,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -83670,8 +86686,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-codeowners-errors parameters: - - *465 - *466 + - *467 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -83799,8 +86815,8 @@ paths: parameters: - *17 - *19 - - *465 - *466 + - *467 responses: '200': description: Response @@ -84114,8 +87130,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -84181,7 +87197,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -84189,7 +87205,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '400': *14 '401': *23 '403': *27 @@ -84218,8 +87234,8 @@ paths: parameters: - *17 - *19 - - *465 - *466 + - *467 responses: '200': description: Response @@ -84283,8 +87299,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *465 - *466 + - *467 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -84321,9 +87337,9 @@ paths: type: integer machines: type: array - items: *569 + items: *570 examples: - default: &804 + default: &805 value: total_count: 2 machines: @@ -84363,8 +87379,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *465 - *466 + - *467 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -84451,8 +87467,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *465 - *466 + - *467 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -84521,8 +87537,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -84540,7 +87556,7 @@ paths: type: integer secrets: type: array - items: &573 + items: &574 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -84561,7 +87577,7 @@ paths: - created_at - updated_at examples: - default: *570 + default: *571 headers: Link: *45 x-github: @@ -84584,16 +87600,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *571 + schema: *572 examples: - default: *572 + default: *573 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -84613,17 +87629,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 responses: '200': description: Response content: application/json: - schema: *573 + schema: *574 examples: - default: *574 + default: *575 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84643,8 +87659,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 requestBody: required: true @@ -84697,8 +87713,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 responses: '204': @@ -84727,8 +87743,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *465 - *466 + - *467 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -84766,7 +87782,7 @@ paths: application/json: schema: type: array - items: &575 + items: &576 title: Collaborator description: Collaborator type: object @@ -84959,8 +87975,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *465 - *466 + - *467 - *140 responses: '204': @@ -85007,8 +88023,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *465 - *466 + - *467 - *140 requestBody: required: false @@ -85035,7 +88051,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &652 + schema: &653 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -85263,8 +88279,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *465 - *466 + - *467 - *140 responses: '204': @@ -85296,8 +88312,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *465 - *466 + - *467 - *140 responses: '200': @@ -85318,7 +88334,7 @@ paths: user: anyOf: - type: 'null' - - *575 + - *576 required: - permission - role_name @@ -85372,8 +88388,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -85383,7 +88399,7 @@ paths: application/json: schema: type: array - items: &576 + items: &577 title: Commit Comment description: Commit Comment type: object @@ -85441,7 +88457,7 @@ paths: - created_at - updated_at examples: - default: &581 + default: &582 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -85500,17 +88516,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment parameters: - - *465 - *466 + - *467 - *233 responses: '200': description: Response content: application/json: - schema: *576 + schema: *577 examples: - default: &582 + default: &583 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -85567,8 +88583,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#update-a-commit-comment parameters: - - *465 - *466 + - *467 - *233 requestBody: required: true @@ -85591,7 +88607,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *577 examples: default: value: @@ -85642,8 +88658,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#delete-a-commit-comment parameters: - - *465 - *466 + - *467 - *233 responses: '204': @@ -85665,8 +88681,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *465 - *466 + - *467 - *233 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). @@ -85693,7 +88709,7 @@ paths: application/json: schema: type: array - items: &577 + items: &578 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -85737,7 +88753,7 @@ paths: - content - created_at examples: - default: &655 + default: &656 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -85782,8 +88798,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *465 - *466 + - *467 - *233 requestBody: required: true @@ -85816,9 +88832,9 @@ paths: description: Reaction exists content: application/json: - schema: *577 + schema: *578 examples: - default: &578 + default: &579 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -85847,9 +88863,9 @@ paths: description: Reaction created content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '422': *15 x-github: githubCloudOnly: false @@ -85871,10 +88887,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *465 - *466 + - *467 - *233 - - &656 + - &657 name: reaction_id description: The unique identifier of the reaction. in: path @@ -85929,8 +88945,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-commits parameters: - - *465 - *466 + - *467 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -85986,9 +89002,9 @@ paths: application/json: schema: type: array - items: *579 + items: *580 examples: - default: &705 + default: &706 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -86082,9 +89098,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-branches-for-head-commit parameters: - - *465 - *466 - - &580 + - *467 + - &581 name: commit_sha description: The SHA of the commit. in: path @@ -86156,9 +89172,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments parameters: - - *465 - *466 - - *580 + - *467 + - *581 - *17 - *19 responses: @@ -86168,9 +89184,9 @@ paths: application/json: schema: type: array - items: *576 + items: *577 examples: - default: *581 + default: *582 headers: Link: *45 x-github: @@ -86198,9 +89214,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#create-a-commit-comment parameters: - - *465 - *466 - - *580 + - *467 + - *581 requestBody: required: true content: @@ -86235,9 +89251,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *577 examples: - default: *582 + default: *583 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -86265,9 +89281,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *465 - *466 - - *580 + - *467 + - *581 - *17 - *19 responses: @@ -86277,9 +89293,9 @@ paths: application/json: schema: type: array - items: *583 + items: *584 examples: - default: &697 + default: &698 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -86816,11 +89832,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#get-a-commit parameters: - - *465 - *466 + - *467 - *19 - *17 - - &584 + - &585 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -86835,9 +89851,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: &683 + default: &684 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -86925,7 +89941,7 @@ paths: schema: type: string examples: - default: &591 + default: &592 value: | diff --git a/testfile b/testfile index 9bdeaeb..912c7ef 100644 @@ -86938,7 +89954,7 @@ paths: schema: type: string examples: - default: &592 + default: &593 value: | From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 From: Mona Lisa <87831417+monalisa@users.noreply.github.com> @@ -86991,11 +90007,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *465 - *466 - - *584 + - *467 - *585 - *586 + - *587 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -87029,9 +90045,9 @@ paths: type: integer check_runs: type: array - items: *529 + items: *530 examples: - default: *587 + default: *588 headers: Link: *45 x-github: @@ -87056,9 +90072,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *465 - *466 - - *584 + - *467 + - *585 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -87066,7 +90082,7 @@ paths: schema: type: integer example: 1 - - *585 + - *586 - *17 - *19 responses: @@ -87084,7 +90100,7 @@ paths: type: integer check_suites: type: array - items: *533 + items: *534 examples: default: value: @@ -87284,9 +90300,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *465 - *466 - - *584 + - *467 + - *585 - *17 - *19 responses: @@ -87488,9 +90504,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *465 - *466 - - *584 + - *467 + - *585 - *17 - *19 responses: @@ -87500,7 +90516,7 @@ paths: application/json: schema: type: array - items: &758 + items: &759 title: Status description: The status of a commit. type: object @@ -87581,7 +90597,7 @@ paths: site_admin: false headers: Link: *45 - '301': *471 + '301': *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87609,8 +90625,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/community#get-community-profile-metrics parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -87643,11 +90659,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *588 + - *589 code_of_conduct_file: anyOf: - type: 'null' - - &589 + - &590 title: Community Health File type: object properties: @@ -87667,19 +90683,19 @@ paths: contributing: anyOf: - type: 'null' - - *589 + - *590 readme: anyOf: - type: 'null' - - *589 + - *590 issue_template: anyOf: - type: 'null' - - *589 + - *590 pull_request_template: anyOf: - type: 'null' - - *589 + - *590 required: - code_of_conduct - code_of_conduct_file @@ -87808,8 +90824,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#compare-two-commits parameters: - - *465 - *466 + - *467 - *19 - *17 - name: basehead @@ -87857,8 +90873,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *579 - merge_base_commit: *579 + base_commit: *580 + merge_base_commit: *580 status: type: string enum: @@ -87882,10 +90898,10 @@ paths: - 6 commits: type: array - items: *579 + items: *580 files: type: array - items: *590 + items: *591 required: - url - html_url @@ -88131,12 +91147,12 @@ paths: schema: type: string examples: - default: *591 + default: *592 application/vnd.github.patch: schema: type: string examples: - default: *592 + default: *593 '404': *6 '500': *38 '503': *192 @@ -88181,8 +91197,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-repository-content parameters: - - *465 - *466 + - *467 - name: path description: path parameter in: path @@ -88352,7 +91368,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &593 + response-if-content-is-a-file-github-object: &594 summary: Response if content is a file value: type: file @@ -88489,7 +91505,7 @@ paths: - size - type - url - - &710 + - &711 title: Content File description: Content File type: object @@ -88707,7 +91723,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *593 + response-if-content-is-a-file: *594 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -88776,7 +91792,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *594 + '302': *595 '304': *35 x-github: githubCloudOnly: false @@ -88829,8 +91845,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#create-or-update-file-contents parameters: - - *465 - *466 + - *467 - name: path description: path parameter in: path @@ -88925,7 +91941,7 @@ paths: description: Response content: application/json: - schema: &595 + schema: &596 title: File Commit description: File Commit type: object @@ -89081,7 +92097,7 @@ paths: description: Response content: application/json: - schema: *595 + schema: *596 examples: example-for-creating-a-file: value: @@ -89135,7 +92151,7 @@ paths: schema: oneOf: - *3 - - &635 + - &636 description: Repository rule violation was detected type: object properties: @@ -89156,7 +92172,7 @@ paths: items: type: object properties: - placeholder_id: &750 + placeholder_id: &751 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -89188,8 +92204,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#delete-a-file parameters: - - *465 - *466 + - *467 - name: path description: path parameter in: path @@ -89250,7 +92266,7 @@ paths: description: Response content: application/json: - schema: *595 + schema: *596 examples: default: value: @@ -89305,8 +92321,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-contributors parameters: - - *465 - *466 + - *467 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -89430,8 +92446,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *465 - *466 + - *467 - *332 - *333 - *334 @@ -89444,7 +92460,7 @@ paths: schema: type: string - *337 - - *596 + - *597 - *338 - *339 - *340 @@ -89459,7 +92475,7 @@ paths: application/json: schema: type: array - items: &600 + items: &601 type: object description: A Dependabot alert. properties: @@ -89510,7 +92526,7 @@ paths: - transitive - inconclusive - - security_advisory: *597 + security_advisory: *598 security_vulnerability: *131 url: *132 html_url: *133 @@ -89541,8 +92557,8 @@ paths: dismissal. maxLength: 280 fixed_at: *137 - auto_dismissed_at: *598 - dismissal_request: *599 + auto_dismissed_at: *599 + dismissal_request: *600 assignees: type: array description: The users assigned to this alert. @@ -89797,9 +92813,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *465 - *466 - - &601 + - *467 + - &602 name: alert_number in: path description: |- @@ -89814,7 +92830,7 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: default: value: @@ -89946,9 +92962,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *465 - *466 - - *601 + - *467 + - *602 requestBody: required: true content: @@ -90004,7 +93020,7 @@ paths: description: Response content: application/json: - schema: *600 + schema: *601 examples: default: value: @@ -90134,8 +93150,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-repository-secrets parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -90153,7 +93169,7 @@ paths: type: integer secrets: type: array - items: &604 + items: &605 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -90207,16 +93223,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *602 + schema: *603 examples: - default: *603 + default: *604 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90236,15 +93252,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 responses: '200': description: Response content: application/json: - schema: *604 + schema: *605 examples: default: value: @@ -90270,8 +93286,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 requestBody: required: true @@ -90324,8 +93340,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *465 - *466 + - *467 - *288 responses: '204': @@ -90348,8 +93364,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *465 - *466 + - *467 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -90523,8 +93539,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -90783,8 +93799,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *465 - *466 + - *467 - name: sbom_uuid in: path required: true @@ -90795,7 +93811,7 @@ paths: '302': description: Redirects to a temporary download URL for the completed SBOM. headers: - Location: *605 + Location: *606 '202': description: SBOM is still being processed, no content is returned. '404': *6 @@ -90816,8 +93832,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *465 - *466 + - *467 responses: '201': description: Response @@ -90855,8 +93871,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -90939,7 +93955,7 @@ paths: - version - url additionalProperties: false - metadata: &606 + metadata: &607 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -90978,7 +93994,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *606 + metadata: *607 resolved: type: object description: A collection of resolved package dependencies. @@ -90992,7 +94008,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *606 + metadata: *607 relationship: type: string description: A notation of whether a dependency is requested @@ -91125,8 +94141,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments parameters: - - *465 - *466 + - *467 - name: sha description: The SHA recorded at creation time. in: query @@ -91167,9 +94183,9 @@ paths: application/json: schema: type: array - items: *607 + items: *608 examples: - default: *608 + default: *609 headers: Link: *45 x-github: @@ -91235,8 +94251,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#create-a-deployment parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -91318,7 +94334,7 @@ paths: description: Response content: application/json: - schema: *607 + schema: *608 examples: simple-example: summary: Simple example @@ -91391,9 +94407,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#get-a-deployment parameters: - - *465 - *466 - - &609 + - *467 + - &610 name: deployment_id description: deployment_id parameter in: path @@ -91405,7 +94421,7 @@ paths: description: Response content: application/json: - schema: *607 + schema: *608 examples: default: value: @@ -91470,9 +94486,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#delete-a-deployment parameters: - - *465 - *466 - - *609 + - *467 + - *610 responses: '204': description: Response @@ -91494,9 +94510,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#list-deployment-statuses parameters: - - *465 - *466 - - *609 + - *467 + - *610 - *17 - *19 responses: @@ -91506,7 +94522,7 @@ paths: application/json: schema: type: array - items: &610 + items: &611 title: Deployment Status description: The status of a deployment. type: object @@ -91670,9 +94686,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#create-a-deployment-status parameters: - - *465 - *466 - - *609 + - *467 + - *610 requestBody: required: true content: @@ -91747,9 +94763,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *611 examples: - default: &611 + default: &612 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -91805,9 +94821,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#get-a-deployment-status parameters: - - *465 - *466 - - *609 + - *467 + - *610 - name: status_id in: path required: true @@ -91818,9 +94834,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *611 examples: - default: *611 + default: *612 '404': *6 x-github: githubCloudOnly: false @@ -91847,12 +94863,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *465 - *466 - - *612 + - *467 - *613 - *614 - *615 + - *616 - *17 - *19 responses: @@ -91862,9 +94878,9 @@ paths: application/json: schema: type: array - items: *616 + items: *617 examples: - default: *617 + default: *618 '404': *6 '403': *27 '500': *38 @@ -91888,8 +94904,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -91901,7 +94917,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *616 + schema: *617 examples: default: value: @@ -91957,8 +94973,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -92017,12 +95033,12 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *465 - *466 - - *612 + - *467 - *613 - *614 - *615 + - *616 - *17 - *19 responses: @@ -92032,9 +95048,9 @@ paths: application/json: schema: type: array - items: *618 + items: *619 examples: - default: *619 + default: *620 '404': *6 '403': *27 '500': *38 @@ -92058,8 +95074,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -92071,7 +95087,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -92122,8 +95138,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -92161,7 +95177,7 @@ paths: description: The created dismissal request. content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -92212,8 +95228,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -92284,8 +95300,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -92318,8 +95334,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - *103 - *104 - *105 @@ -92360,8 +95376,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -92431,8 +95447,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *465 - *466 + - *467 - name: alert_number in: path required: true @@ -92501,8 +95517,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -92559,8 +95575,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#list-environments parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -92578,7 +95594,7 @@ paths: - 5 environments: type: array - items: &621 + items: &622 title: Environment description: Details of a deployment environment type: object @@ -92640,7 +95656,7 @@ paths: type: string examples: - wait_timer - wait_timer: &623 + wait_timer: &624 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -92682,7 +95698,7 @@ paths: items: type: object properties: - type: *620 + type: *621 reviewer: anyOf: - *4 @@ -92709,7 +95725,7 @@ paths: - id - node_id - type - deployment_branch_policy: &624 + deployment_branch_policy: &625 type: - object - 'null' @@ -92826,9 +95842,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#get-an-environment parameters: - - *465 - *466 - - &622 + - *467 + - &623 name: environment_name in: path required: true @@ -92841,9 +95857,9 @@ paths: description: Response content: application/json: - schema: *621 + schema: *622 examples: - default: &625 + default: &626 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -92927,9 +95943,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#create-or-update-an-environment parameters: - - *465 - *466 - - *622 + - *467 + - *623 requestBody: required: false content: @@ -92939,7 +95955,7 @@ paths: - object - 'null' properties: - wait_timer: *623 + wait_timer: *624 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -92958,14 +95974,14 @@ paths: items: type: object properties: - type: *620 + type: *621 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *624 + deployment_branch_policy: *625 additionalProperties: false examples: default: @@ -92985,9 +96001,9 @@ paths: description: Response content: application/json: - schema: *621 + schema: *622 examples: - default: *625 + default: *626 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -93011,9 +96027,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#delete-an-environment parameters: - - *465 - *466 - - *622 + - *467 + - *623 responses: '204': description: Default response @@ -93038,9 +96054,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *465 - *466 - - *622 + - *467 + - *623 - *17 - *19 responses: @@ -93059,7 +96075,7 @@ paths: - 2 branch_policies: type: array - items: &626 + items: &627 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -93120,9 +96136,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *465 - *466 - - *622 + - *467 + - *623 requestBody: required: true content: @@ -93170,9 +96186,9 @@ paths: description: Response content: application/json: - schema: *626 + schema: *627 examples: - example-wildcard: &627 + example-wildcard: &628 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -93214,10 +96230,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *465 - *466 - - *622 - - &628 + - *467 + - *623 + - &629 name: branch_policy_id in: path required: true @@ -93229,9 +96245,9 @@ paths: description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: *627 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93250,10 +96266,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *465 - *466 - - *622 - - *628 + - *467 + - *623 + - *629 requestBody: required: true content: @@ -93282,9 +96298,9 @@ paths: description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: *627 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93303,10 +96319,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *465 - *466 - - *622 - - *628 + - *467 + - *623 + - *629 responses: '204': description: Response @@ -93331,9 +96347,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *622 + - *623 + - *467 - *466 - - *465 responses: '200': description: List of deployment protection rules @@ -93350,7 +96366,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &629 + items: &630 title: Deployment protection rule description: Deployment protection rule type: object @@ -93372,7 +96388,7 @@ paths: for the environment. examples: - true - app: &630 + app: &631 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -93475,9 +96491,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *622 + - *623 + - *467 - *466 - - *465 requestBody: content: application/json: @@ -93498,9 +96514,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *629 + schema: *630 examples: - default: &631 + default: &632 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -93535,9 +96551,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *622 + - *623 + - *467 - *466 - - *465 - *19 - *17 responses: @@ -93557,7 +96573,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *630 + items: *631 examples: default: value: @@ -93592,10 +96608,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *465 - *466 - - *622 - - &632 + - *467 + - *623 + - &633 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -93607,9 +96623,9 @@ paths: description: Response content: application/json: - schema: *629 + schema: *630 examples: - default: *631 + default: *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93630,10 +96646,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *622 + - *623 + - *467 - *466 - - *465 - - *632 + - *633 responses: '204': description: Response @@ -93659,9 +96675,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-environment-secrets parameters: - - *465 - *466 - - *622 + - *467 + - *623 - *17 - *19 responses: @@ -93679,9 +96695,9 @@ paths: type: integer secrets: type: array - items: *496 + items: *497 examples: - default: *497 + default: *498 headers: Link: *45 x-github: @@ -93706,17 +96722,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-public-key parameters: - - *465 - *466 - - *622 + - *467 + - *623 responses: '200': description: Response content: application/json: - schema: *498 + schema: *499 examples: - default: *499 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93738,18 +96754,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-secret parameters: - - *465 - *466 - - *622 + - *467 + - *623 - *288 responses: '200': description: Response content: application/json: - schema: *496 + schema: *497 examples: - default: *633 + default: *634 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93771,9 +96787,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *465 - *466 - - *622 + - *467 + - *623 - *288 requestBody: required: true @@ -93831,9 +96847,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-an-environment-secret parameters: - - *465 - *466 - - *622 + - *467 + - *623 - *288 responses: '204': @@ -93859,10 +96875,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-environment-variables parameters: - - *465 - *466 - - *622 - - *483 + - *467 + - *623 + - *484 - *19 responses: '200': @@ -93879,9 +96895,9 @@ paths: type: integer variables: type: array - items: *500 + items: *501 examples: - default: *501 + default: *502 headers: Link: *45 x-github: @@ -93904,9 +96920,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-an-environment-variable parameters: - - *465 - *466 - - *622 + - *467 + - *623 requestBody: required: true content: @@ -93958,18 +96974,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-an-environment-variable parameters: - - *465 - *466 - - *622 + - *467 + - *623 - *291 responses: '200': description: Response content: application/json: - schema: *500 + schema: *501 examples: - default: *634 + default: *635 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93990,10 +97006,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-an-environment-variable parameters: - - *465 - *466 + - *467 - *291 - - *622 + - *623 requestBody: required: true content: @@ -94035,10 +97051,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-an-environment-variable parameters: - - *465 - *466 + - *467 - *291 - - *622 + - *623 responses: '204': description: Response @@ -94060,8 +97076,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-repository-events parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -94129,8 +97145,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#list-forks parameters: - - *465 - *466 + - *467 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -94289,8 +97305,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#create-a-fork parameters: - - *465 - *466 + - *467 requestBody: required: false content: @@ -94323,9 +97339,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: *472 + default: *473 '400': *14 '422': *15 '403': *27 @@ -94346,8 +97362,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#create-a-blob parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -94407,7 +97423,7 @@ paths: schema: oneOf: - *253 - - *635 + - *636 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94432,8 +97448,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#get-a-blob parameters: - - *465 - *466 + - *467 - name: file_sha in: path required: true @@ -94533,8 +97549,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/commits#create-a-commit parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -94643,7 +97659,7 @@ paths: description: Response content: application/json: - schema: &636 + schema: &637 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -94870,15 +97886,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/commits#get-a-commit-object parameters: - - *465 - *466 - - *580 + - *467 + - *581 responses: '200': description: Response content: application/json: - schema: *636 + schema: *637 examples: default: value: @@ -94934,9 +97950,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#list-matching-references parameters: - - *465 - *466 - - &637 + - *467 + - &638 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -94953,7 +97969,7 @@ paths: application/json: schema: type: array - items: &638 + items: &639 title: Git Reference description: Git references within a repository type: object @@ -95029,17 +98045,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference parameters: - - *465 - *466 - - *637 + - *467 + - *638 responses: '200': description: Response content: application/json: - schema: *638 + schema: *639 examples: - default: &639 + default: &640 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -95068,8 +98084,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#create-a-reference parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -95098,9 +98114,9 @@ paths: description: Response content: application/json: - schema: *638 + schema: *639 examples: - default: *639 + default: *640 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -95126,9 +98142,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#update-a-reference parameters: - - *465 - *466 - - *637 + - *467 + - *638 requestBody: required: true content: @@ -95157,9 +98173,9 @@ paths: description: Response content: application/json: - schema: *638 + schema: *639 examples: - default: *639 + default: *640 '422': *15 '409': *119 x-github: @@ -95177,9 +98193,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#delete-a-reference parameters: - - *465 - *466 - - *637 + - *467 + - *638 responses: '204': description: Response @@ -95234,8 +98250,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/tags#create-a-tag-object parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -95302,7 +98318,7 @@ paths: description: Response content: application/json: - schema: &641 + schema: &642 title: Git Tag description: Metadata for a Git tag type: object @@ -95358,7 +98374,7 @@ paths: - sha - type - url - verification: *640 + verification: *641 required: - sha - url @@ -95368,7 +98384,7 @@ paths: - tag - message examples: - default: &642 + default: &643 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -95441,8 +98457,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/tags#get-a-tag parameters: - - *465 - *466 + - *467 - name: tag_sha in: path required: true @@ -95453,9 +98469,9 @@ paths: description: Response content: application/json: - schema: *641 + schema: *642 examples: - default: *642 + default: *643 '404': *6 '409': *119 x-github: @@ -95479,8 +98495,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/trees#create-a-tree parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -95554,7 +98570,7 @@ paths: description: Response content: application/json: - schema: &643 + schema: &644 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -95656,8 +98672,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/trees#get-a-tree parameters: - - *465 - *466 + - *467 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -95680,7 +98696,7 @@ paths: description: Response content: application/json: - schema: *643 + schema: *644 examples: default-response: summary: Default response @@ -95739,8 +98755,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-repository-webhooks parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -95750,7 +98766,7 @@ paths: application/json: schema: type: array - items: &644 + items: &645 title: Webhook description: Webhooks for repositories. type: object @@ -95813,7 +98829,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &895 + last_response: &896 title: Hook Response type: object properties: @@ -95890,8 +98906,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#create-a-repository-webhook parameters: - - *465 - *466 + - *467 requestBody: required: false content: @@ -95944,9 +98960,9 @@ paths: description: Response content: application/json: - schema: *644 + schema: *645 examples: - default: &645 + default: &646 value: type: Repository id: 12345678 @@ -95994,17 +99010,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 responses: '200': description: Response content: application/json: - schema: *644 + schema: *645 examples: - default: *645 + default: *646 '404': *6 x-github: githubCloudOnly: false @@ -96024,8 +99040,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#update-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 requestBody: required: true @@ -96071,9 +99087,9 @@ paths: description: Response content: application/json: - schema: *644 + schema: *645 examples: - default: *645 + default: *646 '422': *15 '404': *6 x-github: @@ -96094,8 +99110,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 responses: '204': @@ -96120,8 +99136,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *465 - *466 + - *467 - *352 responses: '200': @@ -96149,8 +99165,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *465 - *466 + - *467 - *352 requestBody: required: false @@ -96195,8 +99211,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 - *17 - *353 @@ -96229,8 +99245,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 - *16 responses: @@ -96259,8 +99275,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 - *16 responses: @@ -96284,8 +99300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *465 - *466 + - *467 - *352 responses: '204': @@ -96311,8 +99327,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *465 - *466 + - *467 - *352 responses: '204': @@ -96336,8 +99352,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response if immutable releases are enabled @@ -96385,8 +99401,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-immutable-releases parameters: - - *465 - *466 + - *467 responses: '204': *126 '409': *119 @@ -96406,8 +99422,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-immutable-releases parameters: - - *465 - *466 + - *467 responses: '204': *126 '409': *119 @@ -96464,14 +99480,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-an-import-status parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: &646 + schema: &647 title: Import description: A repository import from an external source. type: object @@ -96578,7 +99594,7 @@ paths: - html_url - authors_url examples: - default: &649 + default: &650 value: vcs: subversion use_lfs: true @@ -96594,7 +99610,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &647 + '503': &648 description: Unavailable due to service under maintenance. content: application/json: @@ -96623,8 +99639,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#start-an-import parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -96672,7 +99688,7 @@ paths: description: Response content: application/json: - schema: *646 + schema: *647 examples: default: value: @@ -96697,7 +99713,7 @@ paths: type: string '422': *15 '404': *6 - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96725,8 +99741,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import parameters: - - *465 - *466 + - *467 requestBody: required: false content: @@ -96778,7 +99794,7 @@ paths: description: Response content: application/json: - schema: *646 + schema: *647 examples: example-1: summary: Example 1 @@ -96826,7 +99842,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96849,12 +99865,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#cancel-an-import parameters: - - *465 - *466 + - *467 responses: '204': description: Response - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96880,9 +99896,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-commit-authors parameters: - - *465 - *466 - - &825 + - *467 + - &826 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -96896,7 +99912,7 @@ paths: application/json: schema: type: array - items: &648 + items: &649 title: Porter Author description: Porter Author type: object @@ -96950,7 +99966,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96975,8 +99991,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#map-a-commit-author parameters: - - *465 - *466 + - *467 - name: author_id in: path required: true @@ -97006,7 +100022,7 @@ paths: description: Response content: application/json: - schema: *648 + schema: *649 examples: default: value: @@ -97019,7 +100035,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97043,8 +100059,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-large-files parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -97085,7 +100101,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97113,8 +100129,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -97141,11 +100157,11 @@ paths: description: Response content: application/json: - schema: *646 + schema: *647 examples: - default: *649 + default: *650 '422': *15 - '503': *647 + '503': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97168,8 +100184,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -97178,7 +100194,7 @@ paths: schema: *20 examples: default: *370 - '301': *471 + '301': *472 '404': *6 x-github: githubCloudOnly: false @@ -97198,8 +100214,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -97212,7 +100228,7 @@ paths: properties: {} additionalProperties: false examples: - default: &651 + default: &652 value: limit: collaborators_only origin: repository @@ -97237,13 +100253,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: application/json: - schema: *650 + schema: *651 examples: default: summary: Example request body @@ -97257,7 +100273,7 @@ paths: application/json: schema: *372 examples: - default: *651 + default: *652 '409': description: Response x-github: @@ -97279,8 +100295,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -97303,8 +100319,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#list-repository-invitations parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -97314,9 +100330,9 @@ paths: application/json: schema: type: array - items: *652 + items: *653 examples: - default: &818 + default: &819 value: - id: 1 repository: @@ -97447,8 +100463,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *465 - *466 + - *467 - *376 requestBody: required: false @@ -97478,7 +100494,7 @@ paths: description: Response content: application/json: - schema: *652 + schema: *653 examples: default: value: @@ -97609,8 +100625,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *465 - *466 + - *467 - *376 responses: '204': @@ -97642,8 +100658,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-repository-issues parameters: - - *465 - *466 + - *467 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -97716,7 +100732,7 @@ paths: type: array items: *219 examples: - default: &661 + default: &662 value: - id: 1 node_id: MDU6SXNzdWUx @@ -97865,7 +100881,7 @@ paths: state_reason: completed headers: Link: *45 - '301': *471 + '301': *472 '422': *15 '404': *6 x-github: @@ -97894,8 +100910,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#create-an-issue parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -97987,7 +101003,7 @@ paths: application/json: schema: *219 examples: - default: &658 + default: &659 value: id: 1 node_id: MDU6SXNzdWUx @@ -98150,7 +101166,7 @@ paths: '422': *15 '503': *192 '404': *6 - '410': *653 + '410': *654 x-github: triggersNotification: true githubCloudOnly: false @@ -98188,8 +101204,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *465 - *466 + - *467 - *241 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -98212,7 +101228,7 @@ paths: type: array items: *220 examples: - default: &660 + default: &661 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -98270,8 +101286,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 responses: '200': @@ -98280,7 +101296,7 @@ paths: application/json: schema: *220 examples: - default: &654 + default: &655 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -98335,8 +101351,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#update-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 requestBody: required: true @@ -98361,7 +101377,7 @@ paths: application/json: schema: *220 examples: - default: *654 + default: *655 '422': *15 x-github: githubCloudOnly: false @@ -98379,8 +101395,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#delete-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 responses: '204': @@ -98409,8 +101425,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#pin-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 responses: '200': @@ -98473,7 +101489,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *653 + '410': *654 '422': *15 x-github: githubCloudOnly: false @@ -98490,8 +101506,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#unpin-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 responses: '204': @@ -98499,7 +101515,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *653 + '410': *654 '503': *192 x-github: githubCloudOnly: false @@ -98517,8 +101533,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). @@ -98545,9 +101561,9 @@ paths: application/json: schema: type: array - items: *577 + items: *578 examples: - default: *655 + default: *656 headers: Link: *45 '404': *6 @@ -98568,8 +101584,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *465 - *466 + - *467 - *233 requestBody: required: true @@ -98602,16 +101618,16 @@ paths: description: Reaction exists content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '201': description: Reaction created content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '422': *15 x-github: githubCloudOnly: false @@ -98633,10 +101649,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *465 - *466 + - *467 - *233 - - *656 + - *657 responses: '204': description: Response @@ -98656,8 +101672,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events-for-a-repository parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -98667,7 +101683,7 @@ paths: application/json: schema: type: array - items: &657 + items: &658 title: Issue Event description: Issue Event type: object @@ -99007,8 +102023,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#get-an-issue-event parameters: - - *465 - *466 + - *467 - name: event_id in: path required: true @@ -99019,7 +102035,7 @@ paths: description: Response content: application/json: - schema: *657 + schema: *658 examples: default: value: @@ -99212,7 +102228,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *653 + '410': *654 '403': *27 x-github: githubCloudOnly: false @@ -99246,9 +102262,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue parameters: - - *465 - *466 - - &659 + - *467 + - &660 name: issue_number description: The number that identifies the issue. in: path @@ -99264,7 +102280,7 @@ paths: examples: default: summary: Issue - value: *658 + value: *659 pinned_comment: summary: Issue with pinned comment value: @@ -99469,9 +102485,9 @@ paths: - op: remove path: "/value/assignee" version: '2026-03-10' - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 '304': *35 x-github: githubCloudOnly: false @@ -99496,9 +102512,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#update-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: false content: @@ -99639,13 +102655,13 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 '422': *15 '503': *192 '403': *27 - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99673,9 +102689,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: false content: @@ -99703,7 +102719,7 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99719,9 +102735,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: content: application/json: @@ -99748,7 +102764,7 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99770,9 +102786,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - name: assignee in: path required: true @@ -99812,9 +102828,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *224 - *17 - *19 @@ -99827,11 +102843,11 @@ paths: type: array items: *220 examples: - default: *660 + default: *661 headers: Link: *45 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99860,9 +102876,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#create-an-issue-comment parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -99886,14 +102902,14 @@ paths: application/json: schema: *220 examples: - default: *654 + default: *655 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *653 + '410': *654 '422': *15 '404': *6 x-github: @@ -99921,9 +102937,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -99935,12 +102951,12 @@ paths: type: array items: *219 examples: - default: *661 + default: *662 headers: Link: *45 - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99968,9 +102984,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -99994,15 +103010,15 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *471 + '301': *472 '403': *27 - '410': *653 + '410': *654 '422': *15 '404': *6 x-github: @@ -100033,9 +103049,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *465 - *466 - - *659 + - *467 + - *660 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -100049,13 +103065,13 @@ paths: application/json: schema: *219 examples: - default: *658 - '301': *471 + default: *659 + '301': *472 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *653 + '410': *654 x-github: triggersNotification: true githubCloudOnly: false @@ -100081,9 +103097,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -100095,12 +103111,12 @@ paths: type: array items: *219 examples: - default: *661 + default: *662 headers: Link: *45 - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100117,9 +103133,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -100133,7 +103149,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &665 + - &666 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -100182,7 +103198,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &666 + - &667 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -100310,7 +103326,7 @@ paths: - performed_via_github_app - assignee - assigner - - &667 + - &668 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -100356,7 +103372,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &668 + - &669 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -100402,7 +103418,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &669 + - &670 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -100451,7 +103467,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &670 + - &671 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -100493,7 +103509,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &671 + - &672 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -100535,7 +103551,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &672 + - &673 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -100591,7 +103607,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &673 + - &674 title: Locked Issue Event description: Locked Issue Event type: object @@ -100636,7 +103652,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &674 + - &675 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -100697,7 +103713,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &675 + - &676 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -100758,7 +103774,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &676 + - &677 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -100819,7 +103835,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &677 + - &678 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -100912,7 +103928,7 @@ paths: color: red headers: Link: *45 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100929,9 +103945,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -100941,9 +103957,9 @@ paths: application/json: schema: type: array - items: *662 + items: *663 examples: - default: &663 + default: &664 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -100967,9 +103983,9 @@ paths: value: '2025-12-25' headers: Link: *45 - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100998,9 +104014,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -101066,9 +104082,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *662 + items: *663 examples: - default: *663 + default: *664 '400': *14 '403': *27 '404': *6 @@ -101104,9 +104120,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -101173,9 +104189,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *662 + items: *663 examples: - default: *663 + default: *664 '400': *14 '403': *27 '404': *6 @@ -101206,9 +104222,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *379 responses: '204': @@ -101234,9 +104250,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -101248,7 +104264,7 @@ paths: type: array items: *218 examples: - default: &664 + default: &665 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -101266,9 +104282,9 @@ paths: default: false headers: Link: *45 - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101284,9 +104300,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#add-labels-to-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: false content: @@ -101331,10 +104347,10 @@ paths: type: array items: *218 examples: - default: *664 - '301': *471 + default: *665 + '301': *472 '404': *6 - '410': *653 + '410': *654 '422': *15 x-github: githubCloudOnly: false @@ -101351,9 +104367,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#set-labels-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: false content: @@ -101415,10 +104431,10 @@ paths: type: array items: *218 examples: - default: *664 - '301': *471 + default: *665 + '301': *472 '404': *6 - '410': *653 + '410': *654 '422': *15 x-github: githubCloudOnly: false @@ -101435,15 +104451,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 responses: '204': description: Response - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101462,9 +104478,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - name: name in: path required: true @@ -101488,9 +104504,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *471 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101510,9 +104526,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#lock-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: false content: @@ -101541,7 +104557,7 @@ paths: '204': description: Response '403': *27 - '410': *653 + '410': *654 '404': *6 '422': *15 x-github: @@ -101559,9 +104575,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#unlock-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 responses: '204': description: Response @@ -101591,9 +104607,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#get-parent-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 responses: '200': description: Response @@ -101601,10 +104617,10 @@ paths: application/json: schema: *219 examples: - default: *658 - '301': *471 + default: *659 + '301': *472 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101621,9 +104637,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -101649,13 +104665,13 @@ paths: application/json: schema: type: array - items: *577 + items: *578 examples: - default: *655 + default: *656 headers: Link: *45 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101673,9 +104689,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -101707,16 +104723,16 @@ paths: description: Response content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '201': description: Response content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '422': *15 x-github: githubCloudOnly: false @@ -101738,10 +104754,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *465 - *466 - - *659 - - *656 + - *467 + - *660 + - *657 responses: '204': description: Response @@ -101770,9 +104786,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#remove-sub-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -101796,7 +104812,7 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -101829,9 +104845,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#list-sub-issues parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -101843,11 +104859,11 @@ paths: type: array items: *219 examples: - default: *661 + default: *662 headers: Link: *45 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101875,9 +104891,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#add-sub-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -101906,14 +104922,14 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *653 + '410': *654 '422': *15 '404': *6 x-github: @@ -101933,9 +104949,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 requestBody: required: true content: @@ -101968,7 +104984,7 @@ paths: application/json: schema: *219 examples: - default: *658 + default: *659 '403': *27 '404': *6 '422': *7 @@ -101990,9 +105006,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *465 - *466 - - *659 + - *467 + - *660 - *17 - *19 responses: @@ -102007,7 +105023,6 @@ paths: description: Timeline Event type: object anyOf: - - *665 - *666 - *667 - *668 @@ -102020,6 +105035,7 @@ paths: - *675 - *676 - *677 + - *678 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -102076,7 +105092,7 @@ paths: pin: anyOf: - type: 'null' - - *678 + - *679 required: - event - actor @@ -102352,7 +105368,7 @@ paths: type: string comments: type: array - items: &699 + items: &700 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -102593,7 +105609,7 @@ paths: type: string comments: type: array - items: *576 + items: *577 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -102868,7 +105884,7 @@ paths: headers: Link: *45 '404': *6 - '410': *653 + '410': *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102885,8 +105901,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -102896,7 +105912,7 @@ paths: application/json: schema: type: array - items: &679 + items: &680 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -102964,8 +105980,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -103001,9 +106017,9 @@ paths: description: Response content: application/json: - schema: *679 + schema: *680 examples: - default: &680 + default: &681 value: id: 1 key: ssh-rsa AAA... @@ -103037,9 +106053,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *465 - *466 - - &681 + - *467 + - &682 name: key_id description: The unique identifier of the key. in: path @@ -103051,9 +106067,9 @@ paths: description: Response content: application/json: - schema: *679 + schema: *680 examples: - default: *680 + default: *681 '404': *6 x-github: githubCloudOnly: false @@ -103071,9 +106087,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *465 - *466 - - *681 + - *467 + - *682 responses: '204': description: Response @@ -103093,8 +106109,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-a-repository parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -103106,7 +106122,7 @@ paths: type: array items: *218 examples: - default: *664 + default: *665 headers: Link: *45 '404': *6 @@ -103127,8 +106143,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#create-a-label parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -103166,7 +106182,7 @@ paths: application/json: schema: *218 examples: - default: &682 + default: &683 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -103198,8 +106214,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#get-a-label parameters: - - *465 - *466 + - *467 - name: name in: path required: true @@ -103212,7 +106228,7 @@ paths: application/json: schema: *218 examples: - default: *682 + default: *683 '404': *6 x-github: githubCloudOnly: false @@ -103229,8 +106245,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#update-a-label parameters: - - *465 - *466 + - *467 - name: name in: path required: true @@ -103295,8 +106311,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#delete-a-label parameters: - - *465 - *466 + - *467 - name: name in: path required: true @@ -103322,8 +106338,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-languages parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -103359,8 +106375,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *465 - *466 + - *467 responses: '202': *37 '403': @@ -103388,8 +106404,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -103415,9 +106431,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *465 - *466 - - *551 + - *467 + - *552 responses: '200': description: Response @@ -103564,8 +106580,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -103630,8 +106646,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#merge-a-branch parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -103665,9 +106681,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *579 + schema: *580 examples: - default: *683 + default: *684 '204': description: Response when already merged '404': @@ -103692,8 +106708,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#list-milestones parameters: - - *465 - *466 + - *467 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -103790,8 +106806,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#create-a-milestone parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -103833,7 +106849,7 @@ paths: application/json: schema: *414 examples: - default: &684 + default: &685 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -103892,9 +106908,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#get-a-milestone parameters: - - *465 - *466 - - &685 + - *467 + - &686 name: milestone_number description: The number that identifies the milestone. in: path @@ -103908,7 +106924,7 @@ paths: application/json: schema: *414 examples: - default: *684 + default: *685 '404': *6 x-github: githubCloudOnly: false @@ -103925,9 +106941,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#update-a-milestone parameters: - - *465 - *466 - - *685 + - *467 + - *686 requestBody: required: false content: @@ -103967,7 +106983,7 @@ paths: application/json: schema: *414 examples: - default: *684 + default: *685 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103983,9 +106999,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#delete-a-milestone parameters: - - *465 - *466 - - *685 + - *467 + - *686 responses: '204': description: Response @@ -104006,9 +107022,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *465 - *466 - - *685 + - *467 + - *686 - *17 - *19 responses: @@ -104020,7 +107036,7 @@ paths: type: array items: *218 examples: - default: *664 + default: *665 headers: Link: *45 x-github: @@ -104039,12 +107055,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *465 - *466 - - *686 + - *467 - *687 - - *224 - *688 + - *224 + - *689 - *17 - *19 responses: @@ -104056,7 +107072,7 @@ paths: type: array items: *244 examples: - default: *689 + default: *690 headers: Link: *45 x-github: @@ -104080,8 +107096,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *465 - *466 + - *467 requestBody: required: false content: @@ -104139,14 +107155,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-a-apiname-pages-site parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: &690 + schema: &691 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -104290,7 +107306,7 @@ paths: - custom_404 - public examples: - default: &691 + default: &692 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -104331,8 +107347,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-apiname-pages-site parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -104387,9 +107403,9 @@ paths: description: Response content: application/json: - schema: *690 + schema: *691 examples: - default: *691 + default: *692 '422': *15 '409': *119 x-github: @@ -104412,8 +107428,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -104521,8 +107537,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -104548,8 +107564,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#list-apiname-pages-builds parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -104559,7 +107575,7 @@ paths: application/json: schema: type: array - items: &692 + items: &693 title: Page Build description: Page Build type: object @@ -104651,8 +107667,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#request-a-apiname-pages-build parameters: - - *465 - *466 + - *467 responses: '201': description: Response @@ -104699,16 +107715,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-latest-pages-build parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *692 + schema: *693 examples: - default: &693 + default: &694 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -104756,8 +107772,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-apiname-pages-build parameters: - - *465 - *466 + - *467 - name: build_id in: path required: true @@ -104768,9 +107784,9 @@ paths: description: Response content: application/json: - schema: *692 + schema: *693 examples: - default: *693 + default: *694 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104790,8 +107806,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-github-pages-deployment parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -104899,9 +107915,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *465 - *466 - - &694 + - *467 + - &695 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -104959,9 +107975,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *465 - *466 - - *694 + - *467 + - *695 responses: '204': *126 '404': *6 @@ -104988,8 +108004,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -105284,8 +108300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Private vulnerability reporting status @@ -105322,8 +108338,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': *126 '422': *14 @@ -105344,8 +108360,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': *126 '422': *14 @@ -105367,8 +108383,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -105378,7 +108394,7 @@ paths: type: array items: *152 examples: - default: *695 + default: *696 '403': *27 '404': *6 x-github: @@ -105400,8 +108416,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -105417,7 +108433,7 @@ paths: required: - properties examples: - default: *696 + default: *697 responses: '204': description: No Content when custom property values are successfully created @@ -105455,8 +108471,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests parameters: - - *465 - *466 + - *467 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -105516,9 +108532,9 @@ paths: application/json: schema: type: array - items: *583 + items: *584 examples: - default: *697 + default: *698 headers: Link: *45 '304': *35 @@ -105550,8 +108566,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#create-a-pull-request parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -105618,7 +108634,7 @@ paths: description: Response content: application/json: - schema: &701 + schema: &702 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -105852,7 +108868,7 @@ paths: - review_comment - self author_association: *216 - auto_merge: *698 + auto_merge: *699 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -106048,7 +109064,7 @@ paths: - review_comments version: '2026-03-10' examples: - default: &702 + default: &703 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -106586,8 +109602,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *465 - *466 + - *467 - name: sort in: query required: false @@ -106616,9 +109632,9 @@ paths: application/json: schema: type: array - items: *699 + items: *700 examples: - default: &704 + default: &705 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -106695,17 +109711,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *465 - *466 + - *467 - *233 responses: '200': description: Response content: application/json: - schema: *699 + schema: *700 examples: - default: &700 + default: &701 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -106780,8 +109796,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *465 - *466 + - *467 - *233 requestBody: required: true @@ -106804,9 +109820,9 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: - default: *700 + default: *701 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106822,8 +109838,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *465 - *466 + - *467 - *233 responses: '204': @@ -106845,8 +109861,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *465 - *466 + - *467 - *233 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). @@ -106873,9 +109889,9 @@ paths: application/json: schema: type: array - items: *577 + items: *578 examples: - default: *655 + default: *656 headers: Link: *45 '404': *6 @@ -106896,8 +109912,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *465 - *466 + - *467 - *233 requestBody: required: true @@ -106930,16 +109946,16 @@ paths: description: Reaction exists content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '201': description: Reaction created content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '422': *15 x-github: githubCloudOnly: false @@ -106961,10 +109977,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *465 - *466 + - *467 - *233 - - *656 + - *657 responses: '204': description: Response @@ -107007,9 +110023,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request parameters: - - *465 - *466 - - &703 + - *467 + - &704 name: pull_number description: The number that identifies the pull request. in: path @@ -107022,9 +110038,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *701 + schema: *702 examples: - default: *702 + default: *703 '304': *35 '404': *6 '406': @@ -107059,9 +110075,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: false content: @@ -107103,9 +110119,9 @@ paths: description: Response content: application/json: - schema: *701 + schema: *702 examples: - default: *702 + default: *703 '422': *15 '403': *27 x-github: @@ -107127,9 +110143,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#archive-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 responses: '204': description: Response @@ -107154,9 +110170,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#unarchive-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 responses: '204': description: Response @@ -107182,9 +110198,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: true content: @@ -107247,7 +110263,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -107255,7 +110271,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '401': *23 '403': *27 '404': *6 @@ -107285,9 +110301,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 - *241 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -107308,9 +110324,9 @@ paths: application/json: schema: type: array - items: *699 + items: *700 examples: - default: *704 + default: *705 headers: Link: *45 x-github: @@ -107343,9 +110359,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: true content: @@ -107451,7 +110467,7 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: example-for-a-multi-line-comment: value: @@ -107539,9 +110555,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *465 - *466 - - *703 + - *467 + - *704 - *233 requestBody: required: true @@ -107564,7 +110580,7 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: default: value: @@ -107650,9 +110666,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 - *17 - *19 responses: @@ -107662,9 +110678,9 @@ paths: application/json: schema: type: array - items: *579 + items: *580 examples: - default: *705 + default: *706 headers: Link: *45 x-github: @@ -107694,9 +110710,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests-files parameters: - - *465 - *466 - - *703 + - *467 + - *704 - *17 - *19 responses: @@ -107706,7 +110722,7 @@ paths: application/json: schema: type: array - items: *590 + items: *591 examples: default: value: @@ -107744,9 +110760,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *465 - *466 - - *703 + - *467 + - *704 responses: '204': description: Response if pull request has been merged @@ -107769,9 +110785,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#merge-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: false content: @@ -107883,9 +110899,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 responses: '200': description: Response @@ -107960,9 +110976,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: false content: @@ -107999,7 +111015,7 @@ paths: description: Response content: application/json: - schema: *583 + schema: *584 examples: default: value: @@ -108535,9 +111551,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: true content: @@ -108571,7 +111587,7 @@ paths: description: Response content: application/json: - schema: *583 + schema: *584 examples: default: value: @@ -109087,9 +112103,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 - *17 - *19 responses: @@ -109099,7 +112115,7 @@ paths: application/json: schema: type: array - items: &706 + items: &707 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -109255,9 +112271,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: false content: @@ -109347,9 +112363,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: &708 + default: &709 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -109412,10 +112428,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *465 - *466 - - *703 - - &707 + - *467 + - *704 + - &708 name: review_id description: The unique identifier of the review. in: path @@ -109427,9 +112443,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: &709 + default: &710 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -109488,10 +112504,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *465 - *466 - - *703 - - *707 + - *467 + - *704 + - *708 requestBody: required: true content: @@ -109514,7 +112530,7 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: default: value: @@ -109576,18 +112592,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *465 - *466 - - *703 - - *707 + - *467 + - *704 + - *708 responses: '200': description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: *708 + default: *709 '422': *7 '404': *6 x-github: @@ -109614,10 +112630,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *465 - *466 - - *703 - - *707 + - *467 + - *704 + - *708 - *17 - *19 responses: @@ -109875,10 +112891,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *465 - *466 - - *703 - - *707 + - *467 + - *704 + - *708 requestBody: required: true content: @@ -109907,7 +112923,7 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: default: value: @@ -109970,10 +112986,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *465 - *466 - - *703 - - *707 + - *467 + - *704 + - *708 requestBody: required: true content: @@ -110008,9 +113024,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: *709 + default: *710 '404': *6 '422': *7 '403': *27 @@ -110032,9 +113048,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *465 - *466 - - *703 + - *467 + - *704 requestBody: required: false content: @@ -110098,8 +113114,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-a-repository-readme parameters: - - *465 - *466 + - *467 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -110112,9 +113128,9 @@ paths: description: Response content: application/json: - schema: *710 + schema: *711 examples: - default: &711 + default: &712 value: type: file encoding: base64 @@ -110156,8 +113172,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *465 - *466 + - *467 - name: dir description: The alternate path to look for a README file in: path @@ -110177,9 +113193,9 @@ paths: description: Response content: application/json: - schema: *710 + schema: *711 examples: - default: *711 + default: *712 '404': *6 '422': *15 x-github: @@ -110201,8 +113217,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#list-releases parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -110212,7 +113228,7 @@ paths: application/json: schema: type: array - items: *712 + items: *713 examples: default: value: @@ -110306,8 +113322,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#create-a-release parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -110383,9 +113399,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: &716 + default: &717 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -110490,9 +113506,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#get-a-release-asset parameters: - - *465 - *466 - - &714 + - *467 + - &715 name: asset_id description: The unique identifier of the asset. in: path @@ -110504,9 +113520,9 @@ paths: description: Response content: application/json: - schema: *713 + schema: *714 examples: - default: &715 + default: &716 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -110541,7 +113557,7 @@ paths: type: User site_admin: false '404': *6 - '302': *594 + '302': *595 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110557,9 +113573,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#update-a-release-asset parameters: - - *465 - *466 - - *714 + - *467 + - *715 requestBody: required: false content: @@ -110588,9 +113604,9 @@ paths: description: Response content: application/json: - schema: *713 + schema: *714 examples: - default: *715 + default: *716 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110606,9 +113622,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#delete-a-release-asset parameters: - - *465 - *466 - - *714 + - *467 + - *715 responses: '204': description: Response @@ -110633,8 +113649,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -110720,16 +113736,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-the-latest-release parameters: - - *465 - *466 + - *467 responses: '200': description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: *716 + default: *717 '404': *6 x-github: githubCloudOnly: false @@ -110747,8 +113763,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release-by-tag-name parameters: - - *465 - *466 + - *467 - name: tag description: tag parameter in: path @@ -110761,9 +113777,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: *716 + default: *717 '404': *6 x-github: githubCloudOnly: false @@ -110785,9 +113801,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release parameters: - - *465 - *466 - - &717 + - *467 + - &718 name: release_id description: The unique identifier of the release. in: path @@ -110801,9 +113817,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *712 + schema: *713 examples: - default: *716 + default: *717 '401': description: Unauthorized x-github: @@ -110821,9 +113837,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#update-a-release parameters: - - *465 - *466 - - *717 + - *467 + - *718 requestBody: required: false content: @@ -110887,9 +113903,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: *716 + default: *717 '404': description: Not Found if the discussion category name is invalid content: @@ -110910,9 +113926,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#delete-a-release parameters: - - *465 - *466 - - *717 + - *467 + - *718 responses: '204': description: Response @@ -110933,9 +113949,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#list-release-assets parameters: - - *465 - *466 - - *717 + - *467 + - *718 - *17 - *19 responses: @@ -110945,7 +113961,7 @@ paths: application/json: schema: type: array - items: *713 + items: *714 examples: default: value: @@ -111027,9 +114043,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *465 - *466 - - *717 + - *467 + - *718 - name: name in: query required: true @@ -111055,7 +114071,7 @@ paths: description: Response for successful upload content: application/json: - schema: *713 + schema: *714 examples: response-for-successful-upload: value: @@ -111110,9 +114126,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *465 - *466 - - *717 + - *467 + - *718 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -111136,9 +114152,9 @@ paths: application/json: schema: type: array - items: *577 + items: *578 examples: - default: *655 + default: *656 headers: Link: *45 '404': *6 @@ -111159,9 +114175,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *465 - *466 - - *717 + - *467 + - *718 requestBody: required: true content: @@ -111191,16 +114207,16 @@ paths: description: Reaction exists content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '201': description: Reaction created content: application/json: - schema: *577 + schema: *578 examples: - default: *578 + default: *579 '422': *15 x-github: githubCloudOnly: false @@ -111222,10 +114238,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-release-reaction parameters: - - *465 - *466 - - *717 - - *656 + - *467 + - *718 + - *657 responses: '204': description: Response @@ -111249,9 +114265,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-rules-for-a-branch parameters: - - *465 - *466 - - *518 + - *467 + - *519 - *17 - *19 responses: @@ -111268,7 +114284,7 @@ paths: oneOf: - allOf: - *166 - - &718 + - &719 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -111289,67 +114305,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *167 - - *718 + - *719 - allOf: - *168 - - *718 + - *719 - allOf: - *169 - - *718 + - *719 - allOf: + - *720 - *719 - - *718 - allOf: - *170 - - *718 + - *719 - allOf: - *171 - - *718 + - *719 - allOf: - *172 - - *718 + - *719 - allOf: - *173 - - *718 + - *719 - allOf: - *174 - - *718 + - *719 - allOf: - *175 - - *718 + - *719 - allOf: - *176 - - *718 + - *719 - allOf: - *177 - - *718 + - *719 - allOf: - *178 - - *718 + - *719 - allOf: - *179 - - *718 + - *719 - allOf: - *180 - - *718 + - *719 - allOf: - *181 - - *718 + - *719 - allOf: - *182 - - *718 + - *719 - allOf: - *183 - - *718 + - *719 - allOf: - *184 - - *718 + - *719 - allOf: - *185 - - *718 + - *719 - allOf: - *186 - - *718 + - *719 examples: default: value: @@ -111388,8 +114404,8 @@ paths: category: repos subcategory: rules parameters: - - *465 - *466 + - *467 - *17 - *19 - name: includes_parents @@ -111400,7 +114416,7 @@ paths: schema: type: boolean default: true - - *720 + - *721 responses: '200': description: Response @@ -111455,8 +114471,8 @@ paths: category: repos subcategory: rules parameters: - - *465 - *466 + - *467 requestBody: description: Request body required: true @@ -111485,7 +114501,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *721 + items: *722 required: - name - enforcement @@ -111518,7 +114534,7 @@ paths: application/json: schema: *187 examples: - default: &730 + default: &731 value: id: 42 name: super cool ruleset @@ -111566,12 +114582,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *465 - *466 - - *722 - - *105 + - *467 - *723 + - *105 - *724 + - *725 - *17 - *19 responses: @@ -111579,9 +114595,9 @@ paths: description: Response content: application/json: - schema: *725 + schema: *726 examples: - default: *726 + default: *727 '404': *6 '500': *38 x-github: @@ -111602,17 +114618,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *465 - *466 - - *727 + - *467 + - *728 responses: '200': description: Response content: application/json: - schema: *728 + schema: *729 examples: - default: *729 + default: *730 '404': *6 '500': *38 x-github: @@ -111640,8 +114656,8 @@ paths: category: repos subcategory: rules parameters: - - *465 - *466 + - *467 - name: ruleset_id description: The ID of the ruleset. in: path @@ -111663,7 +114679,7 @@ paths: application/json: schema: *187 examples: - default: *730 + default: *731 '404': *6 '500': *38 put: @@ -111681,8 +114697,8 @@ paths: category: repos subcategory: rules parameters: - - *465 - *466 + - *467 - name: ruleset_id description: The ID of the ruleset. in: path @@ -111716,7 +114732,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *721 + items: *722 examples: default: value: @@ -111746,7 +114762,7 @@ paths: application/json: schema: *187 examples: - default: *730 + default: *731 '404': *6 '422': *15 '500': *38 @@ -111765,8 +114781,8 @@ paths: category: repos subcategory: rules parameters: - - *465 - *466 + - *467 - name: ruleset_id description: The ID of the ruleset. in: path @@ -111789,8 +114805,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-history parameters: - - *465 - *466 + - *467 - *17 - *19 - name: ruleset_id @@ -111827,8 +114843,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-version parameters: - - *465 - *466 + - *467 - name: ruleset_id description: The ID of the ruleset. in: path @@ -111901,8 +114917,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *465 - *466 + - *467 - *433 - *434 - *435 @@ -111914,12 +114930,13 @@ paths: - *110 - *19 - *17 - - *731 - *732 + - *733 - *441 - *442 - *443 - *444 + - *445 responses: '200': description: Response @@ -111927,7 +114944,7 @@ paths: application/json: schema: type: array - items: &736 + items: &737 type: object properties: number: *127 @@ -111943,8 +114960,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *733 - resolution: *734 + state: *734 + resolution: *735 resolved_at: type: - string @@ -112050,7 +115067,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *735 + - *736 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -112209,16 +115226,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 - *444 responses: '200': description: Response content: application/json: - schema: *736 + schema: *737 examples: default: value: @@ -112272,9 +115289,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 requestBody: required: true content: @@ -112282,8 +115299,8 @@ paths: schema: type: object properties: - state: *733 - resolution: *734 + state: *734 + resolution: *735 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -112331,7 +115348,7 @@ paths: description: Response content: application/json: - schema: *736 + schema: *737 examples: default: value: @@ -112427,9 +115444,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *465 - *466 - - *545 + - *467 + - *546 - *19 - *17 responses: @@ -112440,7 +115457,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &915 + items: &916 type: object properties: type: @@ -112467,7 +115484,6 @@ paths: - commit details: oneOf: - - *737 - *738 - *739 - *740 @@ -112480,6 +115496,7 @@ paths: - *747 - *748 - *749 + - *750 examples: default: value: @@ -112565,8 +115582,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -112574,14 +115591,14 @@ paths: schema: type: object properties: - reason: &751 + reason: &752 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *750 + placeholder_id: *751 required: - reason - placeholder_id @@ -112598,7 +115615,7 @@ paths: schema: type: object properties: - reason: *751 + reason: *752 expire_at: type: - string @@ -112645,8 +115662,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *465 - *466 + - *467 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -112661,7 +115678,7 @@ paths: properties: incremental_scans: type: array - items: &752 + items: &753 description: Information on a single scan performed by secret scanning on the repository type: object @@ -112689,15 +115706,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *752 + items: *753 backfill_scans: type: array - items: *752 + items: *753 custom_pattern_backfill_scans: type: array items: allOf: - - *752 + - *753 - type: object properties: pattern_name: @@ -112710,7 +115727,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *752 + items: *753 examples: default: value: @@ -112775,8 +115792,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *465 - *466 + - *467 - *110 - name: sort description: The property to sort the results by. @@ -112820,9 +115837,9 @@ paths: application/json: schema: type: array - items: *753 + items: *754 examples: - default: *754 + default: *755 '400': *14 '404': *6 x-github: @@ -112845,8 +115862,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -112926,7 +115943,7 @@ paths: login: type: string description: The username of the user credited. - type: *449 + type: *450 required: - login - type @@ -113016,9 +116033,9 @@ paths: description: Response content: application/json: - schema: *753 + schema: *754 examples: - default: &756 + default: &757 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -113257,8 +116274,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -113371,7 +116388,7 @@ paths: description: Response content: application/json: - schema: *753 + schema: *754 examples: default: value: @@ -113524,17 +116541,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *465 - *466 - - *755 + - *467 + - *756 responses: '200': description: Response content: application/json: - schema: *753 + schema: *754 examples: - default: *756 + default: *757 '403': *27 '404': *6 x-github: @@ -113558,9 +116575,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *465 - *466 - - *755 + - *467 + - *756 requestBody: required: true content: @@ -113640,7 +116657,7 @@ paths: login: type: string description: The username of the user credited. - type: *449 + type: *450 required: - login - type @@ -113731,10 +116748,10 @@ paths: description: Response content: application/json: - schema: *753 + schema: *754 examples: - default: *756 - add_credit: *756 + default: *757 + add_credit: *757 '403': *27 '404': *6 '422': @@ -113772,9 +116789,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *465 - *466 - - *755 + - *467 + - *756 responses: '202': *37 '400': *14 @@ -113801,17 +116818,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *465 - *466 - - *755 + - *467 + - *756 responses: '202': description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: *472 + default: *473 '400': *14 '422': *15 '403': *27 @@ -113837,8 +116854,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-stargazers parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -113934,8 +116951,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *465 - *466 + - *467 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -113944,7 +116961,7 @@ paths: application/json: schema: type: array - items: &757 + items: &758 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -113977,8 +116994,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -114056,8 +117073,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -114151,8 +117168,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *465 - *466 + - *467 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -114306,8 +117323,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *465 - *466 + - *467 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -114317,7 +117334,7 @@ paths: application/json: schema: type: array - items: *757 + items: *758 examples: default: value: @@ -114350,8 +117367,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#create-a-commit-status parameters: - - *465 - *466 + - *467 - name: sha in: path required: true @@ -114407,7 +117424,7 @@ paths: description: Response content: application/json: - schema: *758 + schema: *759 examples: default: value: @@ -114461,8 +117478,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#list-watchers parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -114494,14 +117511,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#get-a-repository-subscription parameters: - - *465 - *466 + - *467 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &759 + schema: &760 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -114574,8 +117591,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#set-a-repository-subscription parameters: - - *465 - *466 + - *467 requestBody: required: false content: @@ -114601,7 +117618,7 @@ paths: description: Response content: application/json: - schema: *759 + schema: *760 examples: default: value: @@ -114628,8 +117645,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#delete-a-repository-subscription parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -114649,8 +117666,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-tags parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -114732,8 +117749,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *465 - *466 + - *467 - name: ref in: path required: true @@ -114769,8 +117786,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-teams parameters: - - *465 - *466 + - *467 - *17 - *19 responses: @@ -114802,8 +117819,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-all-repository-topics parameters: - - *465 - *466 + - *467 - *19 - *17 responses: @@ -114811,7 +117828,7 @@ paths: description: Response content: application/json: - schema: &760 + schema: &761 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -114823,7 +117840,7 @@ paths: required: - names examples: - default: &761 + default: &762 value: names: - octocat @@ -114846,8 +117863,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#replace-all-repository-topics parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -114878,9 +117895,9 @@ paths: description: Response content: application/json: - schema: *760 + schema: *761 examples: - default: *761 + default: *762 '404': *6 '422': *7 x-github: @@ -114901,9 +117918,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-repository-clones parameters: - - *465 - *466 - - &762 + - *467 + - &763 name: per description: The time frame to display results for. in: query @@ -114934,7 +117951,7 @@ paths: - 128 clones: type: array - items: &763 + items: &764 title: Traffic type: object properties: @@ -115021,8 +118038,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-paths parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -115116,8 +118133,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-sources parameters: - - *465 - *466 + - *467 responses: '200': description: Response @@ -115180,9 +118197,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-page-views parameters: - - *465 - *466 - - *762 + - *467 + - *763 responses: '200': description: Response @@ -115203,7 +118220,7 @@ paths: - 3782 views: type: array - items: *763 + items: *764 required: - uniques - count @@ -115280,8 +118297,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#transfer-a-repository parameters: - - *465 - *466 + - *467 requestBody: required: true content: @@ -115561,8 +118578,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *465 - *466 + - *467 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -115585,8 +118602,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-vulnerability-alerts parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -115608,8 +118625,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-vulnerability-alerts parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -115635,8 +118652,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *465 - *466 + - *467 - name: ref in: path required: true @@ -115728,9 +118745,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: *472 + default: *473 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -115881,7 +118898,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &771 + - &772 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -115891,7 +118908,7 @@ paths: type: string examples: - members - - &776 + - &777 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -115903,7 +118920,7 @@ paths: format: int32 examples: - 1 - - &777 + - &778 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -115947,7 +118964,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &766 + items: &767 allOf: - type: object required: @@ -116029,7 +119046,7 @@ paths: - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 - meta: &778 + meta: &779 type: object description: The metadata associated with the creation/updates to the user. @@ -116094,30 +119111,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &767 + '400': &768 description: Bad request content: application/json: - schema: *764 + schema: *765 application/scim+json: - schema: *764 - '401': *765 - '403': &768 + schema: *765 + '401': *766 + '403': &769 description: Permission denied - '429': &769 + '429': &770 description: Too many requests content: application/json: - schema: *764 + schema: *765 application/scim+json: - schema: *764 - '500': &770 + schema: *765 + '500': &771 description: Internal server error content: application/json: - schema: *764 + schema: *765 application/scim+json: - schema: *764 + schema: *765 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -116141,7 +119158,7 @@ paths: required: true content: application/json: - schema: &774 + schema: &775 type: object required: - schemas @@ -116205,9 +119222,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *766 + schema: *767 examples: - group: &772 + group: &773 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -116226,13 +119243,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *767 - '401': *765 - '403': *768 - '409': &775 + '400': *768 + '401': *766 + '403': *769 + '409': &776 description: Duplicate record detected - '429': *769 - '500': *770 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -116249,7 +119266,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - - &773 + - &774 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -116258,22 +119275,22 @@ paths: type: string examples: - 7fce0092-d52e-4f76-b727-3955bd72c939 - - *771 + - *772 - *39 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *766 + schema: *767 examples: - default: *772 - '400': *767 - '401': *765 - '403': *768 + default: *773 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '429': *769 - '500': *770 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -116292,13 +119309,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - - *773 + - *774 - *39 requestBody: required: true content: application/json: - schema: *774 + schema: *775 examples: group: summary: Group @@ -116324,17 +119341,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *766 + schema: *767 examples: - group: *772 - groupWithMembers: *772 - '400': *767 - '401': *765 - '403': *768 + group: *773 + groupWithMembers: *773 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '409': *775 - '429': *769 - '500': *770 + '409': *776 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -116358,13 +119375,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - - *773 + - *774 - *39 requestBody: required: true content: application/json: - schema: &785 + schema: &786 type: object required: - Operations @@ -116424,17 +119441,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *766 + schema: *767 examples: - updateGroup: *772 - addMembers: *772 - '400': *767 - '401': *765 - '403': *768 + updateGroup: *773 + addMembers: *773 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '409': *775 - '429': *769 - '500': *770 + '409': *776 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -116450,17 +119467,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - - *773 + - *774 - *39 responses: '204': description: Group was deleted, no content - '400': *767 - '401': *765 - '403': *768 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '429': *769 - '500': *770 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -116494,8 +119511,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *776 - *777 + - *778 - *39 responses: '200': @@ -116529,7 +119546,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &780 + items: &781 allOf: - type: object required: @@ -116621,7 +119638,7 @@ paths: address. examples: - true - roles: &779 + roles: &780 type: array description: The roles assigned to the user. items: @@ -116680,7 +119697,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *778 + meta: *779 startIndex: type: integer description: A starting index for the returned page @@ -116719,11 +119736,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *767 - '401': *765 - '403': *768 - '429': *769 - '500': *770 + '400': *768 + '401': *766 + '403': *769 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -116747,7 +119764,7 @@ paths: required: true content: application/json: - schema: &783 + schema: &784 type: object required: - schemas @@ -116840,9 +119857,9 @@ paths: description: Whether this email address is the primary address. examples: - true - roles: *779 + roles: *780 examples: - user: &784 + user: &785 summary: User value: schemas: @@ -116889,9 +119906,9 @@ paths: description: User has been created content: application/scim+json: - schema: *780 + schema: *781 examples: - user: &781 + user: &782 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -116917,13 +119934,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 - enterpriseOwner: *781 - '400': *767 - '401': *765 - '403': *768 - '409': *775 - '429': *769 - '500': *770 + enterpriseOwner: *782 + '400': *768 + '401': *766 + '403': *769 + '409': *776 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -116940,7 +119957,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - - &782 + - &783 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -116953,15 +119970,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *780 + schema: *781 examples: - default: *781 - '400': *767 - '401': *765 - '403': *768 + default: *782 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '429': *769 - '500': *770 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -117012,30 +120029,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - - *782 + - *783 - *39 requestBody: required: true content: application/json: - schema: *783 + schema: *784 examples: - user: *784 + user: *785 responses: '200': description: User was updated content: application/scim+json: - schema: *780 + schema: *781 examples: - user: *781 - '400': *767 - '401': *765 - '403': *768 + user: *782 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '409': *775 - '429': *769 - '500': *770 + '409': *776 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -117076,13 +120093,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - - *782 + - *783 - *39 requestBody: required: true content: application/json: - schema: *785 + schema: *786 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -117122,18 +120139,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *780 - examples: - userMultiValuedProperties: *781 - userSingleValuedProperties: *781 - disableUser: *781 - '400': *767 - '401': *765 - '403': *768 + schema: *781 + examples: + userMultiValuedProperties: *782 + userSingleValuedProperties: *782 + disableUser: *782 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '409': *775 - '429': *769 - '500': *770 + '409': *776 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -117153,17 +120170,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - - *782 + - *783 - *39 responses: '204': description: User was deleted, no content - '400': *767 - '401': *765 - '403': *768 + '400': *768 + '401': *766 + '403': *769 '404': *6 - '429': *769 - '500': *770 + '429': *770 + '500': *771 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -117254,7 +120271,7 @@ paths: - 1 Resources: type: array - items: &786 + items: &787 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -117501,22 +120518,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *35 - '404': &787 + '404': &788 description: Resource not found content: application/json: - schema: *764 + schema: *765 application/scim+json: - schema: *764 - '403': &788 + schema: *765 + '403': &789 description: Forbidden content: application/json: - schema: *764 + schema: *765 application/scim+json: - schema: *764 - '400': *767 - '429': *769 + schema: *765 + '400': *768 + '429': *770 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -117542,9 +120559,9 @@ paths: description: Response content: application/scim+json: - schema: *786 + schema: *787 examples: - default: &789 + default: &790 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -117567,17 +120584,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *35 - '404': *787 - '403': *788 - '500': *770 + '404': *788 + '403': *789 + '500': *771 '409': description: Conflict content: application/json: - schema: *764 + schema: *765 application/scim+json: - schema: *764 - '400': *767 + schema: *765 + '400': *768 requestBody: required: true content: @@ -117677,17 +120694,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *87 - - *782 + - *783 responses: '200': description: Response content: application/scim+json: - schema: *786 + schema: *787 examples: - default: *789 - '404': *787 - '403': *788 + default: *790 + '404': *788 + '403': *789 '304': *35 x-github: githubCloudOnly: true @@ -117711,18 +120728,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-a-provisioned-organization-membership parameters: - *87 - - *782 + - *783 responses: '200': description: Response content: application/scim+json: - schema: *786 + schema: *787 examples: - default: *789 + default: *790 '304': *35 - '404': *787 - '403': *788 + '404': *788 + '403': *789 requestBody: required: true content: @@ -117837,19 +120854,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *87 - - *782 + - *783 responses: '200': description: Response content: application/scim+json: - schema: *786 + schema: *787 examples: - default: *789 + default: *790 '304': *35 - '404': *787 - '403': *788 - '400': *767 + '404': *788 + '403': *789 + '400': *768 '429': description: Response content: @@ -117945,12 +120962,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *87 - - *782 + - *783 responses: '204': description: Response - '404': *787 - '403': *788 + '404': *788 + '403': *789 '304': *35 x-github: githubCloudOnly: true @@ -118087,7 +121104,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &790 + text_matches: &791 title: Search Result Text Matches type: array items: @@ -118251,7 +121268,7 @@ paths: enum: - author-date - committer-date - - &791 + - &792 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -118320,7 +121337,7 @@ paths: committer: anyOf: - type: 'null' - - *516 + - *517 comment_count: type: integer message: @@ -118339,7 +121356,7 @@ paths: url: type: string format: uri - verification: *640 + verification: *641 required: - author - committer @@ -118354,7 +121371,7 @@ paths: committer: anyOf: - type: 'null' - - *516 + - *517 parents: type: array items: @@ -118371,7 +121388,7 @@ paths: type: number node_id: type: string - text_matches: *790 + text_matches: *791 required: - sha - node_id @@ -118564,7 +121581,7 @@ paths: - interactions - created - updated - - *791 + - *792 - *17 - *19 - name: advanced_search @@ -118678,11 +121695,11 @@ paths: type: - string - 'null' - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: type: string state_reason: @@ -118710,7 +121727,7 @@ paths: - string - 'null' format: date-time - text_matches: *790 + text_matches: *791 pull_request: type: object properties: @@ -119010,7 +122027,7 @@ paths: enum: - created - updated - - *791 + - *792 - *17 - *19 responses: @@ -119055,7 +122072,7 @@ paths: - 'null' score: type: number - text_matches: *790 + text_matches: *791 required: - id - node_id @@ -119141,7 +122158,7 @@ paths: - forks - help-wanted-issues - updated - - *791 + - *792 - *17 - *19 responses: @@ -119387,7 +122404,7 @@ paths: - admin - pull - push - text_matches: *790 + text_matches: *791 temp_clone_token: type: string allow_merge_commit: @@ -119696,7 +122713,7 @@ paths: - string - 'null' format: uri - text_matches: *790 + text_matches: *791 related: type: - array @@ -119891,7 +122908,7 @@ paths: - followers - repositories - joined - - *791 + - *792 - *17 - *19 responses: @@ -120001,7 +123018,7 @@ paths: type: - boolean - 'null' - text_matches: *790 + text_matches: *791 blog: type: - string @@ -120083,7 +123100,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#get-a-team-legacy parameters: - - &794 + - &795 name: team_id description: The unique identifier of the team. in: path @@ -120095,9 +123112,9 @@ paths: description: Response content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 '404': *6 x-github: githubCloudOnly: false @@ -120124,7 +123141,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#update-a-team-legacy parameters: - - *794 + - *795 requestBody: required: true content: @@ -120188,16 +123205,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 '201': description: Response content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 '404': *6 '422': *15 '403': *27 @@ -120225,7 +123242,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#delete-a-team-legacy parameters: - - *794 + - *795 responses: '204': description: Response @@ -120254,7 +123271,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *794 + - *795 - *17 - *19 responses: @@ -120292,7 +123309,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-team-members-legacy parameters: - - *794 + - *795 - name: role description: Filters members returned by their role in the team. in: query @@ -120343,7 +123360,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-member-legacy parameters: - - *794 + - *795 - *140 responses: '204': @@ -120380,7 +123397,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-team-member-legacy parameters: - - *794 + - *795 - *140 responses: '204': @@ -120420,7 +123437,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-member-legacy parameters: - - *794 + - *795 - *140 responses: '204': @@ -120457,16 +123474,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *794 + - *795 - *140 responses: '200': description: Response content: application/json: - schema: *464 + schema: *465 examples: - response-if-user-is-a-team-maintainer: *795 + response-if-user-is-a-team-maintainer: *796 '404': *6 x-github: githubCloudOnly: false @@ -120499,7 +123516,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *794 + - *795 - *140 requestBody: required: false @@ -120525,9 +123542,9 @@ paths: description: Response content: application/json: - schema: *464 + schema: *465 examples: - response-if-users-membership-with-team-is-now-pending: *796 + response-if-users-membership-with-team-is-now-pending: *797 '403': description: Forbidden if team synchronization is set up '422': @@ -120561,7 +123578,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *794 + - *795 - *140 responses: '204': @@ -120589,7 +123606,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-team-repositories-legacy parameters: - - *794 + - *795 - *17 - *19 responses: @@ -120631,15 +123648,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *794 - - *465 + - *795 - *466 + - *467 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *797 + schema: *798 examples: alternative-response-with-extra-repository-information: value: @@ -120796,9 +123813,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *794 - - *465 + - *795 - *466 + - *467 requestBody: required: false content: @@ -120848,9 +123865,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *794 - - *465 + - *795 - *466 + - *467 responses: '204': description: Response @@ -120879,15 +123896,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - - *794 + - *795 responses: '200': description: Response content: application/json: - schema: *467 + schema: *468 examples: - default: *468 + default: *469 '403': *27 '404': *6 x-github: @@ -120914,7 +123931,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - - *794 + - *795 requestBody: required: true content: @@ -120975,7 +123992,7 @@ paths: description: Response content: application/json: - schema: *467 + schema: *468 examples: default: value: @@ -121006,7 +124023,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-child-teams-legacy parameters: - - *794 + - *795 - *17 - *19 responses: @@ -121018,7 +124035,7 @@ paths: type: array items: *307 examples: - response-if-child-teams-exist: *798 + response-if-child-teams-exist: *799 headers: Link: *45 '404': *6 @@ -121051,7 +124068,7 @@ paths: application/json: schema: oneOf: - - &800 + - &801 title: Private User description: Private User type: object @@ -121301,7 +124318,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *799 + - *800 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -121461,7 +124478,7 @@ paths: description: Response content: application/json: - schema: *800 + schema: *801 examples: default: value: @@ -121807,7 +124824,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -121815,7 +124832,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '401': *23 '403': *27 '404': *6 @@ -121859,7 +124876,7 @@ paths: type: integer secrets: type: array - items: &801 + items: &802 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -121901,7 +124918,7 @@ paths: - visibility - selected_repositories_url examples: - default: *570 + default: *571 headers: Link: *45 x-github: @@ -121979,7 +124996,7 @@ paths: description: Response content: application/json: - schema: *801 + schema: *802 examples: default: value: @@ -122277,7 +125294,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '304': *35 '500': *38 '401': *23 @@ -122335,7 +125352,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '401': *23 '403': *27 '404': *6 @@ -122392,7 +125409,7 @@ paths: description: Response content: application/json: - schema: &802 + schema: &803 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -122445,7 +125462,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &803 + default: &804 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -122490,9 +125507,9 @@ paths: description: Response content: application/json: - schema: *802 + schema: *803 examples: - default: *803 + default: *804 '404': *6 x-github: githubCloudOnly: false @@ -122529,9 +125546,9 @@ paths: type: integer machines: type: array - items: *569 + items: *570 examples: - default: *804 + default: *805 '304': *35 '500': *38 '401': *23 @@ -122616,11 +125633,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *470 + repository: *471 machine: anyOf: - type: 'null' - - *569 + - *570 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -123425,7 +126442,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '304': *35 '500': *38 '400': *14 @@ -123465,7 +126482,7 @@ paths: application/json: schema: *385 examples: - default: *568 + default: *569 '500': *38 '401': *23 '403': *27 @@ -123497,7 +126514,7 @@ paths: type: array items: *395 examples: - default: &815 + default: &816 value: - id: 197 name: hello_docker @@ -123598,7 +126615,7 @@ paths: application/json: schema: type: array - items: &805 + items: &806 title: Email description: Email type: object @@ -123668,9 +126685,9 @@ paths: application/json: schema: type: array - items: *805 + items: *806 examples: - default: &817 + default: &818 value: - email: octocat@github.com verified: true @@ -123747,7 +126764,7 @@ paths: application/json: schema: type: array - items: *805 + items: *806 examples: default: value: @@ -124005,7 +127022,7 @@ paths: application/json: schema: type: array - items: &806 + items: &807 title: GPG Key description: A unique encryption key type: object @@ -124150,7 +127167,7 @@ paths: - subkeys - revoked examples: - default: &834 + default: &835 value: - id: 3 name: Octocat's GPG Key @@ -124235,9 +127252,9 @@ paths: description: Response content: application/json: - schema: *806 + schema: *807 examples: - default: &807 + default: &808 value: id: 3 name: Octocat's GPG Key @@ -124294,7 +127311,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &808 + - &809 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -124306,9 +127323,9 @@ paths: description: Response content: application/json: - schema: *806 + schema: *807 examples: - default: *807 + default: *808 '404': *6 '304': *35 '403': *27 @@ -124331,7 +127348,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *808 + - *809 responses: '204': description: Response @@ -124639,7 +127656,7 @@ paths: required: true content: application/json: - schema: *650 + schema: *651 examples: default: value: @@ -124789,7 +127806,7 @@ paths: application/json: schema: type: array - items: &809 + items: &810 title: Key description: Key type: object @@ -124892,9 +127909,9 @@ paths: description: Response content: application/json: - schema: *809 + schema: *810 examples: - default: &810 + default: &811 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -124927,15 +127944,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *681 + - *682 responses: '200': description: Response content: application/json: - schema: *809 + schema: *810 examples: - default: *810 + default: *811 '404': *6 '304': *35 '403': *27 @@ -124958,7 +127975,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *681 + - *682 responses: '204': description: Response @@ -124991,7 +128008,7 @@ paths: application/json: schema: type: array - items: &811 + items: &812 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -125070,7 +128087,7 @@ paths: - account - plan examples: - default: &812 + default: &813 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -125132,9 +128149,9 @@ paths: application/json: schema: type: array - items: *811 + items: *812 examples: - default: *812 + default: *813 headers: Link: *45 '304': *35 @@ -126152,7 +129169,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#unlock-a-user-repository parameters: - *391 - - *813 + - *814 responses: '204': description: Response @@ -126285,7 +129302,7 @@ paths: - docker - nuget - container - - *814 + - *815 - *19 - *17 responses: @@ -126297,8 +129314,8 @@ paths: type: array items: *395 examples: - default: *815 - '400': *816 + default: *816 + '400': *817 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -126327,7 +129344,7 @@ paths: application/json: schema: *395 examples: - default: &835 + default: &836 value: id: 40201 name: octo-name @@ -126689,9 +129706,9 @@ paths: application/json: schema: type: array - items: *805 + items: *806 examples: - default: *817 + default: *818 headers: Link: *45 '304': *35 @@ -126804,7 +129821,7 @@ paths: type: array items: *78 examples: - default: &824 + default: &825 summary: Default response value: - id: 1296269 @@ -127122,9 +130139,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *471 examples: - default: *472 + default: *473 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -127168,9 +130185,9 @@ paths: application/json: schema: type: array - items: *652 + items: *653 examples: - default: *818 + default: *819 headers: Link: *45 '304': *35 @@ -127255,7 +130272,7 @@ paths: application/json: schema: type: array - items: &819 + items: &820 title: Social account description: Social media account type: object @@ -127272,7 +130289,7 @@ paths: - provider - url examples: - default: &820 + default: &821 value: - provider: twitter url: https://twitter.com/github @@ -127335,9 +130352,9 @@ paths: application/json: schema: type: array - items: *819 + items: *820 examples: - default: *820 + default: *821 '422': *15 '304': *35 '404': *6 @@ -127425,7 +130442,7 @@ paths: application/json: schema: type: array - items: &821 + items: &822 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -127445,7 +130462,7 @@ paths: - title - created_at examples: - default: &849 + default: &850 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -127510,9 +130527,9 @@ paths: description: Response content: application/json: - schema: *821 + schema: *822 examples: - default: &822 + default: &823 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -127542,7 +130559,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &823 + - &824 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -127554,9 +130571,9 @@ paths: description: Response content: application/json: - schema: *821 + schema: *822 examples: - default: *822 + default: *823 '404': *6 '304': *35 '403': *27 @@ -127579,7 +130596,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *823 + - *824 responses: '204': description: Response @@ -127608,7 +130625,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &850 + - &851 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -127633,11 +130650,11 @@ paths: type: array items: *78 examples: - default-response: *824 + default-response: *825 application/vnd.github.v3.star+json: schema: type: array - items: &851 + items: &852 title: Starred Repository description: Starred Repository type: object @@ -127793,8 +130810,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *465 - *466 + - *467 responses: '204': description: Response if this repository is starred by you @@ -127822,8 +130839,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -127847,8 +130864,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *465 - *466 + - *467 responses: '204': description: Response @@ -127920,7 +130937,7 @@ paths: application/json: schema: type: array - items: *457 + items: *458 examples: default: value: @@ -128006,10 +131023,10 @@ paths: application/json: schema: oneOf: + - *801 - *800 - - *799 examples: - default-response: &828 + default-response: &829 summary: Default response value: login: octocat @@ -128044,7 +131061,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &829 + response-with-git-hub-plan-information: &830 summary: Response with GitHub plan information value: login: octocat @@ -128101,7 +131118,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &826 + - &827 name: user_id description: The unique identifier of the user. in: path @@ -128167,7 +131184,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/users#list-users parameters: - - *825 + - *826 - *17 responses: '200': @@ -128202,7 +131219,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *826 + - *827 - *413 requestBody: required: true @@ -128277,7 +131294,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *827 + schema: *828 examples: table_view: summary: Response for creating a table view @@ -128329,11 +131346,11 @@ paths: application/json: schema: oneOf: + - *801 - *800 - - *799 examples: - default-response: *828 - response-with-git-hub-plan-information: *829 + default-response: *829 + response-with-git-hub-plan-information: *830 '404': *6 x-github: githubCloudOnly: false @@ -128383,8 +131400,8 @@ paths: required: - subject_digests examples: - default: *830 - withPredicateType: *831 + default: *831 + withPredicateType: *832 responses: '200': description: Response @@ -128438,7 +131455,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *832 + default: *833 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -128658,7 +131675,7 @@ paths: initiator: type: string examples: - default: *512 + default: *513 '201': description: Response content: @@ -128956,7 +131973,7 @@ paths: application/json: schema: *322 examples: - default: &833 + default: &834 summary: Example response for a user copilot space value: id: 42 @@ -129057,7 +132074,7 @@ paths: application/json: schema: *322 examples: - default: *833 + default: *834 '403': *27 '404': *6 x-github: @@ -129183,7 +132200,7 @@ paths: application/json: schema: *322 examples: - default: *833 + default: *834 '403': *27 '404': *6 '422': *15 @@ -129951,7 +132968,7 @@ paths: type: array items: *395 examples: - default: *815 + default: *816 '403': *27 '401': *23 x-github: @@ -130335,9 +133352,9 @@ paths: application/json: schema: type: array - items: *806 + items: *807 examples: - default: *834 + default: *835 headers: Link: *45 x-github: @@ -130566,7 +133583,7 @@ paths: - docker - nuget - container - - *814 + - *815 - *140 - *19 - *17 @@ -130579,10 +133596,10 @@ paths: type: array items: *395 examples: - default: *815 + default: *816 '403': *27 '401': *23 - '400': *816 + '400': *817 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -130612,7 +133629,7 @@ paths: application/json: schema: *395 examples: - default: *835 + default: *836 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -130961,7 +133978,7 @@ paths: type: array items: *416 examples: - default: *836 + default: *837 headers: Link: *45 '304': *35 @@ -131021,7 +134038,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *837 + items: *838 required: - name - data_type @@ -131037,7 +134054,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *838 + iteration_configuration: *839 required: - name - data_type @@ -131059,8 +134076,8 @@ paths: value: name: Due date data_type: date - single_select_field: *839 - iteration_field: *840 + single_select_field: *840 + iteration_field: *841 responses: '201': description: Response @@ -131068,11 +134085,11 @@ paths: application/json: schema: *416 examples: - text_field: *841 - number_field: *842 - date_field: *843 - single_select_field: *844 - iteration_field: *845 + text_field: *842 + number_field: *843 + date_field: *844 + single_select_field: *845 + iteration_field: *846 '304': *35 '403': *27 '401': *23 @@ -131094,7 +134111,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-user parameters: - *413 - - *846 + - *847 - *140 responses: '200': @@ -131103,7 +134120,7 @@ paths: application/json: schema: *416 examples: - default: *847 + default: *848 headers: Link: *45 '304': *35 @@ -131460,7 +134477,7 @@ paths: parameters: - *413 - *140 - - *848 + - *849 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -131739,9 +134756,9 @@ paths: application/json: schema: type: array - items: *819 + items: *820 examples: - default: *820 + default: *821 headers: Link: *45 x-github: @@ -131771,9 +134788,9 @@ paths: application/json: schema: type: array - items: *821 + items: *822 examples: - default: *849 + default: *850 headers: Link: *45 x-github: @@ -131798,7 +134815,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *140 - - *850 + - *851 - *110 - *17 - *19 @@ -131810,11 +134827,11 @@ paths: schema: anyOf: - type: array - items: *851 + items: *852 - type: array items: *78 examples: - default-response: *824 + default-response: *825 headers: Link: *45 x-github: @@ -131974,7 +134991,7 @@ webhooks: type: string enum: - disabled - enterprise: &852 + enterprise: &853 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -132043,7 +135060,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &853 + installation: &854 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -132064,7 +135081,7 @@ webhooks: required: - id - node_id - organization: &854 + organization: &855 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -132137,7 +135154,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &855 + repository: &856 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -133077,10 +136094,10 @@ webhooks: type: string enum: - enabled - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -133156,11 +136173,11 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - rule: &856 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + rule: &857 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -133383,11 +136400,11 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - rule: *856 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + rule: *857 sender: *4 required: - action @@ -133575,11 +136592,11 @@ webhooks: - everyone required: - from - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - rule: *856 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + rule: *857 sender: *4 required: - action @@ -133652,7 +136669,7 @@ webhooks: required: true content: application/json: - schema: &876 + schema: &877 title: Exemption request cancellation event type: object properties: @@ -133660,11 +136677,11 @@ webhooks: type: string enum: - cancelled - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - exemption_request: &857 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + exemption_request: &858 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -133973,7 +136990,7 @@ webhooks: - array - 'null' description: The responses to the exemption request. - items: &858 + items: &859 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -134085,7 +137102,7 @@ webhooks: required: true content: application/json: - schema: &877 + schema: &878 title: Exemption request completed event type: object properties: @@ -134093,11 +137110,11 @@ webhooks: type: string enum: - completed - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - exemption_request: *857 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + exemption_request: *858 sender: *4 required: - action @@ -134169,7 +137186,7 @@ webhooks: required: true content: application/json: - schema: &874 + schema: &875 title: Exemption request created event type: object properties: @@ -134177,11 +137194,11 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - exemption_request: *857 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + exemption_request: *858 sender: *4 required: - action @@ -134253,7 +137270,7 @@ webhooks: required: true content: application/json: - schema: &878 + schema: &879 title: Exemption response dismissed event type: object properties: @@ -134261,12 +137278,12 @@ webhooks: type: string enum: - response_dismissed - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - exemption_request: *857 - exemption_response: *858 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + exemption_request: *858 + exemption_response: *859 sender: *4 required: - action @@ -134340,7 +137357,7 @@ webhooks: required: true content: application/json: - schema: &875 + schema: &876 title: Exemption response submitted event type: object properties: @@ -134348,12 +137365,12 @@ webhooks: type: string enum: - response_submitted - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - exemption_request: *857 - exemption_response: *858 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + exemption_request: *858 + exemption_response: *859 sender: *4 required: - action @@ -134437,7 +137454,7 @@ webhooks: type: string enum: - completed - check_run: &860 + check_run: &861 title: CheckRun description: A check performed on the code of a given code change type: object @@ -134547,7 +137564,7 @@ webhooks: - examples: - neutral - deployment: *859 + deployment: *860 details_url: type: string examples: @@ -134645,10 +137662,10 @@ webhooks: - output - app - pull_requests - installation: *853 - enterprise: *852 - organization: *854 - repository: *855 + installation: *854 + enterprise: *853 + organization: *855 + repository: *856 sender: *4 required: - check_run @@ -135039,11 +138056,11 @@ webhooks: type: string enum: - created - check_run: *860 - installation: *853 - enterprise: *852 - organization: *854 - repository: *855 + check_run: *861 + installation: *854 + enterprise: *853 + organization: *855 + repository: *856 sender: *4 required: - check_run @@ -135437,11 +138454,11 @@ webhooks: type: string enum: - requested_action - check_run: *860 - installation: *853 - enterprise: *852 - organization: *854 - repository: *855 + check_run: *861 + installation: *854 + enterprise: *853 + organization: *855 + repository: *856 requested_action: description: The action requested by the user. type: object @@ -135844,11 +138861,11 @@ webhooks: type: string enum: - rerequested - check_run: *860 - installation: *853 - enterprise: *852 - organization: *854 - repository: *855 + check_run: *861 + installation: *854 + enterprise: *853 + organization: *855 + repository: *856 sender: *4 required: - check_run @@ -136833,10 +139850,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -137540,10 +140557,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -138241,10 +141258,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -138413,7 +141430,7 @@ webhooks: required: - login - id - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -138565,20 +141582,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &861 + commit_oid: &862 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *852 - installation: *853 - organization: *854 - ref: &862 + enterprise: *853 + installation: *854 + organization: *855 + ref: &863 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *855 + repository: *856 sender: *4 required: - action @@ -138745,7 +141762,7 @@ webhooks: required: - login - id - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -138986,12 +142003,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *861 - enterprise: *852 - installation: *853 - organization: *854 - ref: *862 - repository: *855 + commit_oid: *862 + enterprise: *853 + installation: *854 + organization: *855 + ref: *863 + repository: *856 sender: *4 required: - action @@ -139089,7 +142106,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -139274,12 +142291,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *861 - enterprise: *852 - installation: *853 - organization: *854 - ref: *862 - repository: *855 + commit_oid: *862 + enterprise: *853 + installation: *854 + organization: *855 + ref: *863 + repository: *856 sender: *4 required: - action @@ -139448,7 +142465,7 @@ webhooks: required: - login - id - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -139625,12 +142642,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *861 - enterprise: *852 - installation: *853 - organization: *854 - ref: *862 - repository: *855 + commit_oid: *862 + enterprise: *853 + installation: *854 + organization: *855 + ref: *863 + repository: *856 sender: *4 required: - action @@ -139731,7 +142748,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -139920,9 +142937,9 @@ webhooks: type: - string - 'null' - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -139930,7 +142947,7 @@ webhooks: type: - string - 'null' - repository: *855 + repository: *856 sender: *4 required: - action @@ -140029,7 +143046,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -140176,12 +143193,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *861 - enterprise: *852 - installation: *853 - organization: *854 - ref: *862 - repository: *855 + commit_oid: *862 + enterprise: *853 + installation: *854 + organization: *855 + ref: *863 + repository: *856 sender: *4 required: - action @@ -140350,7 +143367,7 @@ webhooks: required: - login - id - dismissed_comment: *540 + dismissed_comment: *541 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -140502,10 +143519,10 @@ webhooks: - dismissed_reason - rule - tool - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -140765,10 +143782,10 @@ webhooks: - updated_at - author_association - body - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -140849,18 +143866,18 @@ webhooks: type: - string - 'null' - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *854 - pusher_type: &863 + organization: *855 + pusher_type: &864 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &864 + ref: &865 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference) resource. type: string @@ -140870,7 +143887,7 @@ webhooks: enum: - tag - branch - repository: *855 + repository: *856 sender: *4 required: - ref @@ -140953,9 +143970,9 @@ webhooks: enum: - created definition: *153 - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 sender: *4 required: - action @@ -141040,9 +144057,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 sender: *4 required: - action @@ -141120,9 +144137,9 @@ webhooks: enum: - promote_to_enterprise definition: *153 - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 sender: *4 required: - action @@ -141200,9 +144217,9 @@ webhooks: enum: - updated definition: *153 - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 sender: *4 required: - action @@ -141279,10 +144296,10 @@ webhooks: type: string enum: - updated - enterprise: *852 - installation: *853 - repository: *855 - organization: *854 + enterprise: *853 + installation: *854 + repository: *856 + organization: *855 sender: *4 new_property_values: type: array @@ -141367,18 +144384,18 @@ webhooks: title: delete event type: object properties: - enterprise: *852 - installation: *853 - organization: *854 - pusher_type: *863 - ref: *864 + enterprise: *853 + installation: *854 + organization: *855 + pusher_type: *864 + ref: *865 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *855 + repository: *856 sender: *4 required: - ref @@ -141458,11 +144475,11 @@ webhooks: type: string enum: - assignees_changed - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -141542,11 +144559,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -141627,11 +144644,11 @@ webhooks: type: string enum: - auto_reopened - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -141712,11 +144729,11 @@ webhooks: type: string enum: - created - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -141795,11 +144812,11 @@ webhooks: type: string enum: - dismissed - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -141878,11 +144895,11 @@ webhooks: type: string enum: - fixed - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -141962,11 +144979,11 @@ webhooks: type: string enum: - reintroduced - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -142045,11 +145062,11 @@ webhooks: type: string enum: - reopened - alert: *600 - installation: *853 - organization: *854 - enterprise: *852 - repository: *855 + alert: *601 + installation: *854 + organization: *855 + enterprise: *853 + repository: *856 sender: *4 required: - action @@ -142126,9 +145143,9 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - key: &865 + enterprise: *853 + installation: *854 + key: &866 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -142166,8 +145183,8 @@ webhooks: - verified - created_at - read_only - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -142244,11 +145261,11 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - key: *865 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + key: *866 + organization: *855 + repository: *856 sender: *4 required: - action @@ -142815,12 +145832,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - workflow: &869 + workflow: &870 title: Workflow type: - object @@ -143571,13 +146588,13 @@ webhooks: deployment: anyOf: - type: 'null' - - *607 + - *608 pull_requests: type: array - items: *701 - repository: *855 - organization: *854 - installation: *853 + items: *702 + repository: *856 + organization: *855 + installation: *854 sender: *4 responses: '200': @@ -143648,7 +146665,7 @@ webhooks: type: string enum: - approved - approver: &866 + approver: &867 type: object properties: avatar_url: @@ -143691,11 +146708,11 @@ webhooks: type: string comment: type: string - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - reviewers: &867 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + reviewers: &868 type: array items: type: object @@ -143776,7 +146793,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &868 + workflow_job_run: &869 type: object properties: conclusion: @@ -144522,18 +147539,18 @@ webhooks: type: string enum: - rejected - approver: *866 + approver: *867 comment: type: string - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - reviewers: *867 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + reviewers: *868 sender: *4 since: type: string - workflow_job_run: *868 + workflow_job_run: *869 workflow_job_runs: type: array items: @@ -145250,13 +148267,13 @@ webhooks: type: string enum: - requested - enterprise: *852 + enterprise: *853 environment: type: string - installation: *853 - organization: *854 - repository: *855 - requestor: &879 + installation: *854 + organization: *855 + repository: *856 + requestor: &880 title: User type: - object @@ -147189,12 +150206,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - workflow: *869 + workflow: *870 workflow_run: title: Deployment Workflow Run type: @@ -147885,7 +150902,7 @@ webhooks: type: string enum: - answered - answer: &872 + answer: &873 type: object properties: author_association: @@ -148045,11 +151062,11 @@ webhooks: - created_at - updated_at - body - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148176,11 +151193,11 @@ webhooks: - from required: - category - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148263,11 +151280,11 @@ webhooks: type: string enum: - closed - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148349,7 +151366,7 @@ webhooks: type: string enum: - created - comment: &871 + comment: &872 type: object properties: author_association: @@ -148509,11 +151526,11 @@ webhooks: - updated_at - body - reactions - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148596,12 +151613,12 @@ webhooks: type: string enum: - deleted - comment: *871 - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + comment: *872 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148696,12 +151713,12 @@ webhooks: - from required: - body - comment: *871 - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + comment: *872 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148785,11 +151802,11 @@ webhooks: type: string enum: - created - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148871,11 +151888,11 @@ webhooks: type: string enum: - deleted - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -148975,11 +151992,11 @@ webhooks: type: string required: - from - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -149061,10 +152078,10 @@ webhooks: type: string enum: - labeled - discussion: *870 - enterprise: *852 - installation: *853 - label: &873 + discussion: *871 + enterprise: *853 + installation: *854 + label: &874 title: Label type: object properties: @@ -149097,8 +152114,8 @@ webhooks: - color - default - description - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -149181,11 +152198,11 @@ webhooks: type: string enum: - locked - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -149267,11 +152284,11 @@ webhooks: type: string enum: - pinned - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -149353,11 +152370,11 @@ webhooks: type: string enum: - reopened - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -149442,16 +152459,16 @@ webhooks: changes: type: object properties: - new_discussion: *870 - new_repository: *855 + new_discussion: *871 + new_repository: *856 required: - new_discussion - new_repository - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -149534,10 +152551,10 @@ webhooks: type: string enum: - unanswered - discussion: *870 - old_answer: *872 - organization: *854 - repository: *855 + discussion: *871 + old_answer: *873 + organization: *855 + repository: *856 sender: *4 required: - action @@ -149619,12 +152636,12 @@ webhooks: type: string enum: - unlabeled - discussion: *870 - enterprise: *852 - installation: *853 - label: *873 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -149707,11 +152724,11 @@ webhooks: type: string enum: - unlocked - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -149793,11 +152810,11 @@ webhooks: type: string enum: - unpinned - discussion: *870 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + discussion: *871 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -149866,7 +152883,7 @@ webhooks: required: true content: application/json: - schema: *874 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149929,7 +152946,7 @@ webhooks: required: true content: application/json: - schema: *875 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -149992,7 +153009,7 @@ webhooks: required: true content: application/json: - schema: *876 + schema: *877 responses: '200': description: Return a 200 status to indicate that the data was received @@ -150055,7 +153072,7 @@ webhooks: required: true content: application/json: - schema: *874 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -150118,7 +153135,7 @@ webhooks: required: true content: application/json: - schema: *875 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -150184,7 +153201,7 @@ webhooks: required: true content: application/json: - schema: *876 + schema: *877 responses: '200': description: Return a 200 status to indicate that the data was received @@ -150250,7 +153267,7 @@ webhooks: required: true content: application/json: - schema: *877 + schema: *878 responses: '200': description: Return a 200 status to indicate that the data was received @@ -150316,7 +153333,7 @@ webhooks: required: true content: application/json: - schema: *874 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -150382,7 +153399,7 @@ webhooks: required: true content: application/json: - schema: *878 + schema: *879 responses: '200': description: Return a 200 status to indicate that the data was received @@ -150448,7 +153465,7 @@ webhooks: required: true content: application/json: - schema: *875 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -150513,7 +153530,7 @@ webhooks: required: true content: application/json: - schema: *876 + schema: *877 responses: '200': description: Return a 200 status to indicate that the data was received @@ -150578,7 +153595,7 @@ webhooks: required: true content: application/json: - schema: *877 + schema: *878 responses: '200': description: Return a 200 status to indicate that the data was received @@ -150643,7 +153660,7 @@ webhooks: required: true content: application/json: - schema: *874 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -150708,7 +153725,7 @@ webhooks: required: true content: application/json: - schema: *878 + schema: *879 responses: '200': description: Return a 200 status to indicate that the data was received @@ -150774,7 +153791,7 @@ webhooks: required: true content: application/json: - schema: *875 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -150841,7 +153858,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *852 + enterprise: *853 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) resource. @@ -151519,9 +154536,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - forkee @@ -151667,9 +154684,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pages: description: The pages that were updated. type: array @@ -151707,7 +154724,7 @@ webhooks: - action - sha - html_url - repository: *855 + repository: *856 sender: *4 required: - pages @@ -151783,10 +154800,10 @@ webhooks: type: string enum: - created - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories: &880 + organization: *855 + repositories: &881 description: An array of repository objects that the installation can access. type: array @@ -151812,8 +154829,8 @@ webhooks: - name - full_name - private - repository: *855 - requester: *879 + repository: *856 + requester: *880 sender: *4 required: - action @@ -151888,11 +154905,11 @@ webhooks: type: string enum: - deleted - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories: *880 - repository: *855 + organization: *855 + repositories: *881 + repository: *856 requester: type: - 'null' @@ -151969,11 +154986,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories: *880 - repository: *855 + organization: *855 + repositories: *881 + repository: *856 requester: type: - 'null' @@ -152050,10 +155067,10 @@ webhooks: type: string enum: - added - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories_added: &881 + organization: *855 + repositories_added: &882 description: An array of repository objects, which were added to the installation. type: array @@ -152099,15 +155116,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *855 - repository_selection: &882 + repository: *856 + repository_selection: &883 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *879 + requester: *880 sender: *4 required: - action @@ -152186,10 +155203,10 @@ webhooks: type: string enum: - removed - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories_added: *881 + organization: *855 + repositories_added: *882 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -152216,9 +155233,9 @@ webhooks: - name - full_name - private - repository: *855 - repository_selection: *882 - requester: *879 + repository: *856 + repository_selection: *883 + requester: *880 sender: *4 required: - action @@ -152297,11 +155314,11 @@ webhooks: type: string enum: - suspend - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories: *880 - repository: *855 + organization: *855 + repositories: *881 + repository: *856 requester: type: - 'null' @@ -152484,10 +155501,10 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 target_type: type: string @@ -152566,11 +155583,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *852 + enterprise: *853 installation: *20 - organization: *854 - repositories: *880 - repository: *855 + organization: *855 + repositories: *881 + repository: *856 requester: type: - 'null' @@ -152736,7 +155753,7 @@ webhooks: pin: anyOf: - type: 'null' - - *678 + - *679 user: title: User type: @@ -152822,8 +155839,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -153635,8 +156652,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153997,8 +157014,8 @@ webhooks: - state - locked - assignee - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -154078,7 +157095,7 @@ webhooks: type: string enum: - deleted - comment: &883 + comment: &884 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself. @@ -154235,7 +157252,7 @@ webhooks: pin: anyOf: - type: 'null' - - *678 + - *679 required: - url - html_url @@ -154249,8 +157266,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -155058,8 +158075,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155422,8 +158439,8 @@ webhooks: - state - locked - assignee - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -155503,7 +158520,7 @@ webhooks: type: string enum: - edited - changes: &907 + changes: &908 description: The changes to the comment. type: object properties: @@ -155515,9 +158532,9 @@ webhooks: type: string required: - from - comment: *883 - enterprise: *852 - installation: *853 + comment: *884 + enterprise: *853 + installation: *854 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -156328,8 +159345,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156690,8 +159707,8 @@ webhooks: - state - locked - assignee - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -156772,9 +159789,9 @@ webhooks: type: string enum: - pinned - comment: *883 - enterprise: *852 - installation: *853 + comment: *884 + enterprise: *853 + installation: *854 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -157587,8 +160604,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157951,8 +160968,8 @@ webhooks: - state - locked - assignee - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -158032,9 +161049,9 @@ webhooks: type: string enum: - unpinned - comment: *883 - enterprise: *852 - installation: *853 + comment: *884 + enterprise: *853 + installation: *854 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -158847,8 +161864,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159211,8 +162228,8 @@ webhooks: - state - locked - assignee - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -159301,9 +162318,9 @@ webhooks: type: number blocking_issue: *219 blocking_issue_repo: *78 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -159392,9 +162409,9 @@ webhooks: type: number blocking_issue: *219 blocking_issue_repo: *78 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -159482,9 +162499,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *219 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -159573,9 +162590,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *219 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -159655,10 +162672,10 @@ webhooks: type: string enum: - assigned - assignee: *879 - enterprise: *852 - installation: *853 - issue: &884 + assignee: *880 + enterprise: *853 + installation: *854 + issue: &885 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. @@ -160469,11 +163486,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160593,8 +163610,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -160674,8 +163691,8 @@ webhooks: type: string enum: - closed - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. @@ -161491,11 +164508,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -161758,8 +164775,8 @@ webhooks: required: - state - closed_at - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -161838,8 +164855,8 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -162646,11 +165663,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -162769,8 +165786,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -162849,8 +165866,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -163680,11 +166697,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -163782,7 +166799,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &885 + milestone: &886 title: Milestone description: A collection of related issues and pull requests. type: object @@ -163925,8 +166942,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -164025,8 +167042,8 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -164837,11 +167854,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -164961,9 +167978,9 @@ webhooks: - active_lock_reason - body - reactions - label: *873 - organization: *854 - repository: *855 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -165043,9 +168060,9 @@ webhooks: type: string enum: - field_added - enterprise: *852 - installation: *853 - issue: *884 + enterprise: *853 + installation: *854 + issue: *885 issue_field: type: object description: The issue field whose value was set or updated on the @@ -165164,8 +168181,8 @@ webhooks: - id required: - from - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -165245,9 +168262,9 @@ webhooks: type: string enum: - field_removed - enterprise: *852 - installation: *853 - issue: *884 + enterprise: *853 + installation: *854 + issue: *885 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -165310,8 +168327,8 @@ webhooks: - 'null' required: - id - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -165391,8 +168408,8 @@ webhooks: type: string enum: - labeled - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -166202,11 +169219,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -166326,9 +169343,9 @@ webhooks: - active_lock_reason - body - reactions - label: *873 - organization: *854 - repository: *855 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -166408,8 +169425,8 @@ webhooks: type: string enum: - locked - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -167244,11 +170261,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -167345,8 +170362,8 @@ webhooks: format: uri user_view_type: type: string - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -167425,8 +170442,8 @@ webhooks: type: string enum: - milestoned - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -168255,11 +171272,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -168356,9 +171373,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *885 - organization: *854 - repository: *855 + milestone: *886 + organization: *855 + repository: *856 sender: *4 required: - action @@ -169245,11 +172262,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -169841,8 +172858,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -170649,11 +173666,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -170776,8 +173793,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -170857,9 +173874,9 @@ webhooks: type: string enum: - pinned - enterprise: *852 - installation: *853 - issue: &886 + enterprise: *853 + installation: *854 + issue: &887 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. @@ -171664,11 +174681,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -171787,8 +174804,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -171867,8 +174884,8 @@ webhooks: type: string enum: - reopened - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -172701,11 +175718,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -172803,8 +175820,8 @@ webhooks: user_view_type: type: string type: *380 - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -173692,11 +176709,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -174306,11 +177323,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *852 - installation: *853 - issue: *886 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + issue: *887 + organization: *855 + repository: *856 sender: *4 required: - action @@ -174390,12 +177407,12 @@ webhooks: type: string enum: - typed - enterprise: *852 - installation: *853 - issue: *884 + enterprise: *853 + installation: *854 + issue: *885 type: *380 - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -174476,7 +177493,7 @@ webhooks: type: string enum: - unassigned - assignee: &910 + assignee: &911 title: User type: - object @@ -174548,11 +177565,11 @@ webhooks: required: - login - id - enterprise: *852 - installation: *853 - issue: *884 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + issue: *885 + organization: *855 + repository: *856 sender: *4 required: - action @@ -174631,12 +177648,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *852 - installation: *853 - issue: *884 - label: *873 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + issue: *885 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -174716,8 +177733,8 @@ webhooks: type: string enum: - unlocked - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -175550,11 +178567,11 @@ webhooks: anyOf: - type: 'null' - *220 - sub_issues_summary: *792 - issue_dependencies_summary: *793 + sub_issues_summary: *793 + issue_dependencies_summary: *794 issue_field_values: type: array - items: *662 + items: *663 state: description: State of the issue; either 'open' or 'closed' type: string @@ -175651,8 +178668,8 @@ webhooks: format: uri user_view_type: type: string - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -175732,11 +178749,11 @@ webhooks: type: string enum: - unpinned - enterprise: *852 - installation: *853 - issue: *886 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + issue: *887 + organization: *855 + repository: *856 sender: *4 required: - action @@ -175815,12 +178832,12 @@ webhooks: type: string enum: - untyped - enterprise: *852 - installation: *853 - issue: *884 + enterprise: *853 + installation: *854 + issue: *885 type: *380 - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -175900,11 +178917,11 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - label: *873 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -175982,11 +178999,11 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - label: *873 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -176096,11 +179113,11 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - label: *873 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + label: *874 + organization: *855 + repository: *856 sender: *4 required: - action @@ -176182,9 +179199,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *852 - installation: *853 - marketplace_purchase: &887 + enterprise: *853 + installation: *854 + marketplace_purchase: &888 title: Marketplace Purchase type: object required: @@ -176272,8 +179289,8 @@ webhooks: type: integer unit_count: type: integer - organization: *854 - previous_marketplace_purchase: &888 + organization: *855 + previous_marketplace_purchase: &889 title: Marketplace Purchase type: object properties: @@ -176357,7 +179374,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *855 + repository: *856 sender: *4 required: - action @@ -176437,10 +179454,10 @@ webhooks: - changed effective_date: type: string - enterprise: *852 - installation: *853 - marketplace_purchase: *887 - organization: *854 + enterprise: *853 + installation: *854 + marketplace_purchase: *888 + organization: *855 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -176528,7 +179545,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *855 + repository: *856 sender: *4 required: - action @@ -176610,10 +179627,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *852 - installation: *853 - marketplace_purchase: *887 - organization: *854 + enterprise: *853 + installation: *854 + marketplace_purchase: *888 + organization: *855 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -176699,7 +179716,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *855 + repository: *856 sender: *4 required: - action @@ -176780,8 +179797,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 marketplace_purchase: title: Marketplace Purchase type: object @@ -176867,9 +179884,9 @@ webhooks: type: integer unit_count: type: integer - organization: *854 - previous_marketplace_purchase: *888 - repository: *855 + organization: *855 + previous_marketplace_purchase: *889 + repository: *856 sender: *4 required: - action @@ -176949,12 +179966,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *852 - installation: *853 - marketplace_purchase: *887 - organization: *854 - previous_marketplace_purchase: *888 - repository: *855 + enterprise: *853 + installation: *854 + marketplace_purchase: *888 + organization: *855 + previous_marketplace_purchase: *889 + repository: *856 sender: *4 required: - action @@ -177056,11 +180073,11 @@ webhooks: type: string required: - to - enterprise: *852 - installation: *853 - member: *879 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + member: *880 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177162,11 +180179,11 @@ webhooks: type: - string - 'null' - enterprise: *852 - installation: *853 - member: *879 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + member: *880 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177245,11 +180262,11 @@ webhooks: type: string enum: - removed - enterprise: *852 - installation: *853 - member: *879 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + member: *880 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177327,11 +180344,11 @@ webhooks: type: string enum: - added - enterprise: *852 - installation: *853 - member: *879 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + member: *880 + organization: *855 + repository: *856 scope: description: The scope of the membership. Currently, can only be `team`. @@ -177409,7 +180426,7 @@ webhooks: required: - login - id - team: &889 + team: &890 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -177639,11 +180656,11 @@ webhooks: type: string enum: - removed - enterprise: *852 - installation: *853 - member: *879 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + member: *880 + organization: *855 + repository: *856 scope: description: The scope of the membership. Currently, can only be `team`. @@ -177722,7 +180739,7 @@ webhooks: required: - login - id - team: *889 + team: *890 required: - action - scope @@ -177804,8 +180821,8 @@ webhooks: type: string enum: - checks_requested - installation: *853 - merge_group: &890 + installation: *854 + merge_group: &891 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -177824,15 +180841,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *532 + head_commit: *533 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177918,10 +180935,10 @@ webhooks: - merged - invalidated - dequeued - installation: *853 - merge_group: *890 - organization: *854 - repository: *855 + installation: *854 + merge_group: *891 + organization: *855 + repository: *856 sender: *4 required: - action @@ -177994,7 +181011,7 @@ webhooks: type: string enum: - deleted - enterprise: *852 + enterprise: *853 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -178103,12 +181120,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *853 - organization: *854 + installation: *854 + organization: *855 repository: anyOf: - type: 'null' - - *855 + - *856 sender: *4 required: - action @@ -178188,11 +181205,11 @@ webhooks: type: string enum: - closed - enterprise: *852 - installation: *853 - milestone: *885 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + milestone: *886 + organization: *855 + repository: *856 sender: *4 required: - action @@ -178271,9 +181288,9 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - milestone: &891 + enterprise: *853 + installation: *854 + milestone: &892 title: Milestone description: A collection of related issues and pull requests. type: object @@ -178415,8 +181432,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -178495,11 +181512,11 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - milestone: *885 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + milestone: *886 + organization: *855 + repository: *856 sender: *4 required: - action @@ -178609,11 +181626,11 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - milestone: *885 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + milestone: *886 + organization: *855 + repository: *856 sender: *4 required: - action @@ -178693,11 +181710,11 @@ webhooks: type: string enum: - opened - enterprise: *852 - installation: *853 - milestone: *891 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + milestone: *892 + organization: *855 + repository: *856 sender: *4 required: - action @@ -178776,11 +181793,11 @@ webhooks: type: string enum: - blocked - blocked_user: *879 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + blocked_user: *880 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -178859,11 +181876,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *879 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + blocked_user: *880 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -178939,7 +181956,7 @@ webhooks: enum: - created definition: *148 - enterprise: *852 + enterprise: *853 sender: *4 required: - action @@ -179019,8 +182036,8 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 sender: *4 required: - action @@ -179093,8 +182110,8 @@ webhooks: enum: - updated definition: *148 - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 sender: *4 required: - action @@ -179166,9 +182183,9 @@ webhooks: type: string enum: - updated - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 sender: *4 new_property_values: type: array @@ -179256,9 +182273,9 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - membership: &892 + enterprise: *853 + installation: *854 + membership: &893 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -179368,8 +182385,8 @@ webhooks: - role - organization_url - user - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 required: - action @@ -179447,11 +182464,11 @@ webhooks: type: string enum: - member_added - enterprise: *852 - installation: *853 - membership: *892 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + membership: *893 + organization: *855 + repository: *856 sender: *4 required: - action @@ -179530,8 +182547,8 @@ webhooks: type: string enum: - member_invited - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -179653,10 +182670,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 - user: *879 + user: *880 required: - action - invitation @@ -179734,11 +182751,11 @@ webhooks: type: string enum: - member_removed - enterprise: *852 - installation: *853 - membership: *892 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + membership: *893 + organization: *855 + repository: *856 sender: *4 required: - action @@ -179825,11 +182842,11 @@ webhooks: properties: from: type: string - enterprise: *852 - installation: *853 - membership: *892 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + membership: *893 + organization: *855 + repository: *856 sender: *4 required: - action @@ -179907,9 +182924,9 @@ webhooks: type: string enum: - published - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 package: description: Information about the package. type: object @@ -180432,7 +183449,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &893 + items: &894 title: Ruby Gems metadata type: object properties: @@ -180529,7 +183546,7 @@ webhooks: - owner - package_version - registry - repository: *855 + repository: *856 sender: *4 required: - action @@ -180606,9 +183623,9 @@ webhooks: type: string enum: - updated - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 package: description: Information about the package. type: object @@ -180970,7 +183987,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *893 + items: *894 source_url: type: string format: uri @@ -181041,7 +184058,7 @@ webhooks: - owner - package_version - registry - repository: *855 + repository: *856 sender: *4 required: - action @@ -181221,12 +184238,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *852 + enterprise: *853 id: type: integer - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - id @@ -181303,7 +184320,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &894 + personal_access_token_request: &895 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -181453,10 +184470,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *852 - organization: *854 + enterprise: *853 + organization: *855 sender: *4 - installation: *853 + installation: *854 required: - action - personal_access_token_request @@ -181533,11 +184550,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *894 - enterprise: *852 - organization: *854 + personal_access_token_request: *895 + enterprise: *853 + organization: *855 sender: *4 - installation: *853 + installation: *854 required: - action - personal_access_token_request @@ -181613,11 +184630,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *894 - enterprise: *852 - organization: *854 + personal_access_token_request: *895 + enterprise: *853 + organization: *855 sender: *4 - installation: *853 + installation: *854 required: - action - personal_access_token_request @@ -181692,11 +184709,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *894 - organization: *854 - enterprise: *852 + personal_access_token_request: *895 + organization: *855 + enterprise: *853 sender: *4 - installation: *853 + installation: *854 required: - action - personal_access_token_request @@ -181801,7 +184818,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *895 + last_response: *896 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -181833,8 +184850,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 zen: description: Random string of GitHub zen. @@ -182079,10 +185096,10 @@ webhooks: - from required: - note - enterprise: *852 - installation: *853 - organization: *854 - project_card: &896 + enterprise: *853 + installation: *854 + organization: *855 + project_card: &897 title: Project Card type: object properties: @@ -182205,7 +185222,7 @@ webhooks: - creator - created_at - updated_at - repository: *855 + repository: *856 sender: *4 required: - action @@ -182286,11 +185303,11 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - project_card: *896 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project_card: *897 + repository: *856 sender: *4 required: - action @@ -182370,9 +185387,9 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 project_card: title: Project Card type: object @@ -182502,7 +185519,7 @@ webhooks: repository: anyOf: - type: 'null' - - *855 + - *856 sender: *4 required: - action @@ -182596,11 +185613,11 @@ webhooks: - from required: - note - enterprise: *852 - installation: *853 - organization: *854 - project_card: *896 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project_card: *897 + repository: *856 sender: *4 required: - action @@ -182694,9 +185711,9 @@ webhooks: - from required: - column_id - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 project_card: allOf: - title: Project Card @@ -182893,7 +185910,7 @@ webhooks: type: string required: - after_id - repository: *855 + repository: *856 sender: *4 required: - action @@ -182973,10 +185990,10 @@ webhooks: type: string enum: - closed - enterprise: *852 - installation: *853 - organization: *854 - project: &898 + enterprise: *853 + installation: *854 + organization: *855 + project: &899 title: Project type: object properties: @@ -183103,7 +186120,7 @@ webhooks: - creator - created_at - updated_at - repository: *855 + repository: *856 sender: *4 required: - action @@ -183183,10 +186200,10 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - project_column: &897 + enterprise: *853 + installation: *854 + organization: *855 + project_column: &898 title: Project Column type: object properties: @@ -183226,7 +186243,7 @@ webhooks: - name - created_at - updated_at - repository: *855 + repository: *856 sender: *4 required: - action @@ -183305,14 +186322,14 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - project_column: *897 + enterprise: *853 + installation: *854 + organization: *855 + project_column: *898 repository: anyOf: - type: 'null' - - *855 + - *856 sender: *4 required: - action @@ -183401,11 +186418,11 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - organization: *854 - project_column: *897 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project_column: *898 + repository: *856 sender: *4 required: - action @@ -183485,11 +186502,11 @@ webhooks: type: string enum: - moved - enterprise: *852 - installation: *853 - organization: *854 - project_column: *897 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project_column: *898 + repository: *856 sender: *4 required: - action @@ -183569,11 +186586,11 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - project: *898 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project: *899 + repository: *856 sender: *4 required: - action @@ -183653,14 +186670,14 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - project: *898 + enterprise: *853 + installation: *854 + organization: *855 + project: *899 repository: anyOf: - type: 'null' - - *855 + - *856 sender: *4 required: - action @@ -183761,11 +186778,11 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - organization: *854 - project: *898 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project: *899 + repository: *856 sender: *4 required: - action @@ -183844,11 +186861,11 @@ webhooks: type: string enum: - reopened - enterprise: *852 - installation: *853 - organization: *854 - project: *898 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + project: *899 + repository: *856 sender: *4 required: - action @@ -183929,8 +186946,8 @@ webhooks: type: string enum: - closed - installation: *853 - organization: *854 + installation: *854 + organization: *855 projects_v2: *411 sender: *4 required: @@ -184012,8 +187029,8 @@ webhooks: type: string enum: - created - installation: *853 - organization: *854 + installation: *854 + organization: *855 projects_v2: *411 sender: *4 required: @@ -184095,8 +187112,8 @@ webhooks: type: string enum: - deleted - installation: *853 - organization: *854 + installation: *854 + organization: *855 projects_v2: *411 sender: *4 required: @@ -184218,8 +187235,8 @@ webhooks: type: string to: type: string - installation: *853 - organization: *854 + installation: *854 + organization: *855 projects_v2: *411 sender: *4 required: @@ -184303,7 +187320,7 @@ webhooks: type: string enum: - archived - changes: &902 + changes: &903 type: object properties: archived_at: @@ -184319,9 +187336,9 @@ webhooks: - string - 'null' format: date-time - installation: *853 - organization: *854 - projects_v2_item: &899 + installation: *854 + organization: *855 + projects_v2_item: &900 title: Projects v2 Item description: An item belonging to a project type: object @@ -184461,9 +187478,9 @@ webhooks: - 'null' to: type: string - installation: *853 - organization: *854 - projects_v2_item: *899 + installation: *854 + organization: *855 + projects_v2_item: *900 sender: *4 required: - action @@ -184545,9 +187562,9 @@ webhooks: type: string enum: - created - installation: *853 - organization: *854 - projects_v2_item: *899 + installation: *854 + organization: *855 + projects_v2_item: *900 sender: *4 required: - action @@ -184628,9 +187645,9 @@ webhooks: type: string enum: - deleted - installation: *853 - organization: *854 - projects_v2_item: *899 + installation: *854 + organization: *855 + projects_v2_item: *900 sender: *4 required: - action @@ -184735,7 +187752,7 @@ webhooks: oneOf: - type: string - type: integer - - &900 + - &901 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -184759,7 +187776,7 @@ webhooks: required: - id - name - - &901 + - &902 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -184799,8 +187816,8 @@ webhooks: oneOf: - type: string - type: integer - - *900 - *901 + - *902 type: - 'null' - string @@ -184823,9 +187840,9 @@ webhooks: - 'null' required: - body - installation: *853 - organization: *854 - projects_v2_item: *899 + installation: *854 + organization: *855 + projects_v2_item: *900 sender: *4 required: - action @@ -184922,9 +187939,9 @@ webhooks: type: - string - 'null' - installation: *853 - organization: *854 - projects_v2_item: *899 + installation: *854 + organization: *855 + projects_v2_item: *900 sender: *4 required: - action @@ -185007,10 +188024,10 @@ webhooks: type: string enum: - restored - changes: *902 - installation: *853 - organization: *854 - projects_v2_item: *899 + changes: *903 + installation: *854 + organization: *855 + projects_v2_item: *900 sender: *4 required: - action @@ -185092,8 +188109,8 @@ webhooks: type: string enum: - reopened - installation: *853 - organization: *854 + installation: *854 + organization: *855 projects_v2: *411 sender: *4 required: @@ -185175,9 +188192,9 @@ webhooks: type: string enum: - created - installation: *853 - organization: *854 - projects_v2_status_update: *903 + installation: *854 + organization: *855 + projects_v2_status_update: *904 sender: *4 required: - action @@ -185258,9 +188275,9 @@ webhooks: type: string enum: - deleted - installation: *853 - organization: *854 - projects_v2_status_update: *903 + installation: *854 + organization: *855 + projects_v2_status_update: *904 sender: *4 required: - action @@ -185406,9 +188423,9 @@ webhooks: - string - 'null' format: date - installation: *853 - organization: *854 - projects_v2_status_update: *903 + installation: *854 + organization: *855 + projects_v2_status_update: *904 sender: *4 required: - action @@ -185479,10 +188496,10 @@ webhooks: title: public event type: object properties: - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - repository @@ -185559,13 +188576,13 @@ webhooks: type: string enum: - assigned - assignee: *879 - enterprise: *852 - installation: *853 - number: &904 + assignee: *880 + enterprise: *853 + installation: *854 + number: &905 description: The pull request number. type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -187936,7 +190953,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -188033,11 +191050,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -190401,7 +193418,7 @@ webhooks: - draft reason: type: string - repository: *855 + repository: *856 sender: *4 required: - action @@ -190498,11 +193515,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -192866,7 +195883,7 @@ webhooks: - draft reason: type: string - repository: *855 + repository: *856 sender: *4 required: - action @@ -192963,13 +195980,13 @@ webhooks: type: string enum: - closed - enterprise: *852 - installation: *853 - number: *904 - organization: *854 - pull_request: &905 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 + pull_request: &906 allOf: - - *701 + - *702 - type: object properties: allow_auto_merge: @@ -193031,7 +196048,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *855 + repository: *856 sender: *4 required: - action @@ -193112,12 +196129,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *852 - installation: *853 - number: *904 - organization: *854 - pull_request: *905 - repository: *855 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 + pull_request: *906 + repository: *856 sender: *4 required: - action @@ -193197,11 +196214,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *852 + enterprise: *853 milestone: *414 - number: *904 - organization: *854 - pull_request: &906 + number: *905 + organization: *855 + pull_request: &907 title: Pull Request type: object properties: @@ -195592,7 +198609,7 @@ webhooks: - active_lock_reason - draft version: '2026-03-10' - repository: *855 + repository: *856 sender: *4 required: - action @@ -195671,11 +198688,11 @@ webhooks: type: string enum: - dequeued - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -198043,7 +201060,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *855 + repository: *856 sender: *4 required: - action @@ -198175,12 +201192,12 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - number: *904 - organization: *854 - pull_request: *905 - repository: *855 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 + pull_request: *906 + repository: *856 sender: *4 required: - action @@ -198260,11 +201277,11 @@ webhooks: type: string enum: - enqueued - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -200617,7 +203634,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -200705,11 +203722,11 @@ webhooks: type: string enum: - labeled - enterprise: *852 - installation: *853 - label: *873 - number: *904 - organization: *854 + enterprise: *853 + installation: *854 + label: *874 + number: *905 + organization: *855 pull_request: title: Pull Request type: object @@ -203079,7 +206096,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -203175,10 +206192,10 @@ webhooks: type: string enum: - locked - enterprise: *852 - installation: *853 - number: *904 - organization: *854 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 pull_request: title: Pull Request type: object @@ -205546,7 +208563,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -205641,12 +208658,12 @@ webhooks: type: string enum: - milestoned - enterprise: *852 + enterprise: *853 milestone: *414 - number: *904 - organization: *854 - pull_request: *906 - repository: *855 + number: *905 + organization: *855 + pull_request: *907 + repository: *856 sender: *4 required: - action @@ -205725,12 +208742,12 @@ webhooks: type: string enum: - opened - enterprise: *852 - installation: *853 - number: *904 - organization: *854 - pull_request: *905 - repository: *855 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 + pull_request: *906 + repository: *856 sender: *4 required: - action @@ -205811,12 +208828,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *852 - installation: *853 - number: *904 - organization: *854 - pull_request: *905 - repository: *855 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 + pull_request: *906 + repository: *856 sender: *4 required: - action @@ -205896,12 +208913,12 @@ webhooks: type: string enum: - reopened - enterprise: *852 - installation: *853 - number: *904 - organization: *854 - pull_request: *905 - repository: *855 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 + pull_request: *906 + repository: *856 sender: *4 required: - action @@ -206276,9 +209293,9 @@ webhooks: - start_side - side - reactions - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: type: object properties: @@ -208530,7 +211547,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *855 + repository: *856 sender: *4 required: - action @@ -208625,7 +211642,7 @@ webhooks: type: string enum: - deleted - comment: &908 + comment: &909 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -208918,9 +211935,9 @@ webhooks: - start_side - side - reactions - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: type: object properties: @@ -211160,7 +214177,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *855 + repository: *856 sender: *4 required: - action @@ -211255,11 +214272,11 @@ webhooks: type: string enum: - edited - changes: *907 - comment: *908 - enterprise: *852 - installation: *853 - organization: *854 + changes: *908 + comment: *909 + enterprise: *853 + installation: *854 + organization: *855 pull_request: type: object properties: @@ -213502,7 +216519,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *855 + repository: *856 sender: *4 required: - action @@ -213598,9 +216615,9 @@ webhooks: type: string enum: - dismissed - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: title: Simple Pull Request type: object @@ -215855,7 +218872,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *855 + repository: *856 review: description: The review that was affected. type: object @@ -216121,9 +219138,9 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: title: Simple Pull Request type: object @@ -218237,8 +221254,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *855 - review: &909 + repository: *856 + review: &910 description: The review that was affected. type: object properties: @@ -218484,12 +221501,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: description: The pull request number. type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -220858,7 +223875,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 requested_reviewer: title: User type: @@ -220944,12 +223961,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: description: The pull request number. type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -223325,7 +226342,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 requested_team: title: Team description: Groups of organization members that gives permissions @@ -223543,12 +226560,12 @@ webhooks: type: string enum: - review_requested - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: description: The pull request number. type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -225919,7 +228936,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 requested_reviewer: title: User type: @@ -226006,12 +229023,12 @@ webhooks: type: string enum: - review_requested - enterprise: *852 - installation: *853 + enterprise: *853 + installation: *854 number: description: The pull request number. type: integer - organization: *854 + organization: *855 pull_request: title: Pull Request type: object @@ -228373,7 +231390,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 requested_team: title: Team description: Groups of organization members that gives permissions @@ -228580,9 +231597,9 @@ webhooks: type: string enum: - submitted - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: title: Simple Pull Request type: object @@ -230840,8 +233857,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *855 - review: *909 + repository: *856 + review: *910 sender: *4 required: - action @@ -230936,9 +233953,9 @@ webhooks: type: string enum: - resolved - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: title: Simple Pull Request type: object @@ -233091,7 +236108,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *855 + repository: *856 sender: *4 thread: type: object @@ -233496,9 +236513,9 @@ webhooks: type: string enum: - unresolved - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 pull_request: title: Simple Pull Request type: object @@ -235634,7 +238651,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *855 + repository: *856 sender: *4 thread: type: object @@ -236041,10 +239058,10 @@ webhooks: type: string before: type: string - enterprise: *852 - installation: *853 - number: *904 - organization: *854 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 pull_request: title: Pull Request type: object @@ -238401,7 +241418,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -238498,11 +241515,11 @@ webhooks: type: string enum: - unassigned - assignee: *910 - enterprise: *852 - installation: *853 - number: *904 - organization: *854 + assignee: *911 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 pull_request: title: Pull Request type: object @@ -240874,7 +243891,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -240968,11 +243985,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *852 - installation: *853 - label: *873 - number: *904 - organization: *854 + enterprise: *853 + installation: *854 + label: *874 + number: *905 + organization: *855 pull_request: title: Pull Request type: object @@ -243333,7 +246350,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -243429,10 +246446,10 @@ webhooks: type: string enum: - unlocked - enterprise: *852 - installation: *853 - number: *904 - organization: *854 + enterprise: *853 + installation: *854 + number: *905 + organization: *855 pull_request: title: Pull Request type: object @@ -245783,7 +248800,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *855 + repository: *856 sender: *4 required: - action @@ -246001,7 +249018,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *852 + enterprise: *853 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -246096,8 +249113,8 @@ webhooks: - url - author - committer - installation: *853 - organization: *854 + installation: *854 + organization: *855 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -246696,9 +249713,9 @@ webhooks: type: string enum: - published - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 registry_package: type: object properties: @@ -247175,7 +250192,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *893 + items: *894 summary: type: string tag_name: @@ -247231,7 +250248,7 @@ webhooks: - owner - package_version - registry - repository: *855 + repository: *856 sender: *4 required: - action @@ -247309,9 +250326,9 @@ webhooks: type: string enum: - updated - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 registry_package: type: object properties: @@ -247623,7 +250640,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *893 + items: *894 summary: type: string tag_name: @@ -247673,7 +250690,7 @@ webhooks: - owner - package_version - registry - repository: *855 + repository: *856 sender: *4 required: - action @@ -247750,10 +250767,10 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - release: &911 + enterprise: *853 + installation: *854 + organization: *855 + release: &912 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object. @@ -248084,7 +251101,7 @@ webhooks: - updated_at - zipball_url - body - repository: *855 + repository: *856 sender: *4 required: - action @@ -248161,11 +251178,11 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - release: *911 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + release: *912 + repository: *856 sender: *4 required: - action @@ -248282,11 +251299,11 @@ webhooks: type: boolean required: - to - enterprise: *852 - installation: *853 - organization: *854 - release: *911 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + release: *912 + repository: *856 sender: *4 required: - action @@ -248364,9 +251381,9 @@ webhooks: type: string enum: - prereleased - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) @@ -248702,7 +251719,7 @@ webhooks: - string - 'null' format: uri - repository: *855 + repository: *856 sender: *4 required: - action @@ -248778,10 +251795,10 @@ webhooks: type: string enum: - published - enterprise: *852 - installation: *853 - organization: *854 - release: &912 + enterprise: *853 + installation: *854 + organization: *855 + release: &913 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object. @@ -249114,7 +252131,7 @@ webhooks: - string - 'null' format: uri - repository: *855 + repository: *856 sender: *4 required: - action @@ -249190,11 +252207,11 @@ webhooks: type: string enum: - released - enterprise: *852 - installation: *853 - organization: *854 - release: *911 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + release: *912 + repository: *856 sender: *4 required: - action @@ -249270,11 +252287,11 @@ webhooks: type: string enum: - unpublished - enterprise: *852 - installation: *853 - organization: *854 - release: *912 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + release: *913 + repository: *856 sender: *4 required: - action @@ -249350,11 +252367,11 @@ webhooks: type: string enum: - published - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - repository_advisory: *753 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + repository_advisory: *754 sender: *4 required: - action @@ -249430,11 +252447,11 @@ webhooks: type: string enum: - reported - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - repository_advisory: *753 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + repository_advisory: *754 sender: *4 required: - action @@ -249510,10 +252527,10 @@ webhooks: type: string enum: - archived - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -249590,10 +252607,10 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -249671,10 +252688,10 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -249759,10 +252776,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -249877,10 +252894,10 @@ webhooks: - 'null' items: type: string - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -249952,10 +252969,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 status: type: string @@ -250036,10 +253053,10 @@ webhooks: type: string enum: - privatized - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -250116,10 +253133,10 @@ webhooks: type: string enum: - publicized - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -250213,10 +253230,10 @@ webhooks: - name required: - repository - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -250296,10 +253313,10 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 repository_ruleset: *187 sender: *4 required: @@ -250378,10 +253395,10 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 repository_ruleset: *187 sender: *4 required: @@ -250460,10 +253477,10 @@ webhooks: type: string enum: - edited - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 repository_ruleset: *187 changes: type: object @@ -250525,16 +253542,16 @@ webhooks: properties: added: type: array - items: *721 + items: *722 deleted: type: array - items: *721 + items: *722 updated: type: array items: type: object properties: - rule: *721 + rule: *722 changes: type: object properties: @@ -250771,10 +253788,10 @@ webhooks: - from required: - owner - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -250852,10 +253869,10 @@ webhooks: type: string enum: - unarchived - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -250933,7 +253950,7 @@ webhooks: type: string enum: - create - alert: &913 + alert: &914 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -251058,10 +254075,10 @@ webhooks: enum: - auto_dismissed - open - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -251271,10 +254288,10 @@ webhooks: type: string enum: - dismissed - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -251352,11 +254369,11 @@ webhooks: type: string enum: - reopen - alert: *913 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + alert: *914 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -251558,10 +254575,10 @@ webhooks: enum: - fixed - open - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -251639,7 +254656,7 @@ webhooks: type: string enum: - assigned - alert: &914 + alert: &915 type: object properties: number: *127 @@ -251779,10 +254796,10 @@ webhooks: - type: 'null' - *4 assignee: *4 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -251860,11 +254877,11 @@ webhooks: type: string enum: - created - alert: *914 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + alert: *915 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -251945,11 +254962,11 @@ webhooks: type: string enum: - created - alert: *914 - installation: *853 - location: *915 - organization: *854 - repository: *855 + alert: *915 + installation: *854 + location: *916 + organization: *855 + repository: *856 sender: *4 required: - location @@ -252187,11 +255204,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *914 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + alert: *915 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -252269,11 +255286,11 @@ webhooks: type: string enum: - reopened - alert: *914 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + alert: *915 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -252351,11 +255368,11 @@ webhooks: type: string enum: - resolved - alert: *914 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + alert: *915 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -252433,12 +255450,12 @@ webhooks: type: string enum: - unassigned - alert: *914 + alert: *915 assignee: *4 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -252516,11 +255533,11 @@ webhooks: type: string enum: - validated - alert: *914 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + alert: *915 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -252650,10 +255667,10 @@ webhooks: - organization - enterprise - - repository: *855 - enterprise: *852 - installation: *853 - organization: *854 + repository: *856 + enterprise: *853 + installation: *854 + organization: *855 sender: *4 required: - action @@ -252731,11 +255748,11 @@ webhooks: type: string enum: - published - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - security_advisory: &916 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + security_advisory: &917 description: The details of the security advisory, including summary, description, and severity. type: object @@ -252939,11 +255956,11 @@ webhooks: type: string enum: - updated - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 - security_advisory: *916 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 + security_advisory: *917 sender: *4 required: - action @@ -253016,10 +256033,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -253214,10 +256231,10 @@ webhooks: type: object properties: security_and_analysis: *425 - enterprise: *852 - installation: *853 - organization: *854 - repository: *470 + enterprise: *853 + installation: *854 + organization: *855 + repository: *471 sender: *4 required: - changes @@ -253295,12 +256312,12 @@ webhooks: type: string enum: - cancelled - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - sponsorship: &917 + sponsorship: &918 type: object properties: created_at: @@ -253605,12 +256622,12 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - sponsorship: *917 + sponsorship: *918 required: - action - sponsorship @@ -253698,12 +256715,12 @@ webhooks: type: string required: - from - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - sponsorship: *917 + sponsorship: *918 required: - action - changes @@ -253780,17 +256797,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &918 + effective_date: &919 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - sponsorship: *917 + sponsorship: *918 required: - action - sponsorship @@ -253864,7 +256881,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &919 + changes: &920 type: object properties: tier: @@ -253908,13 +256925,13 @@ webhooks: - from required: - tier - effective_date: *918 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + effective_date: *919 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - sponsorship: *917 + sponsorship: *918 required: - action - changes @@ -253991,13 +257008,13 @@ webhooks: type: string enum: - tier_changed - changes: *919 - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + changes: *920 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - sponsorship: *917 + sponsorship: *918 required: - action - changes @@ -254071,10 +257088,10 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -254158,10 +257175,10 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -254595,15 +257612,15 @@ webhooks: type: - string - 'null' - enterprise: *852 + enterprise: *853 id: description: The unique identifier of the status. type: integer - installation: *853 + installation: *854 name: type: string - organization: *854 - repository: *855 + organization: *855 + repository: *856 sender: *4 sha: description: The Commit SHA. @@ -254719,9 +257736,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *219 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -254811,9 +257828,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *219 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -254903,9 +257920,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *219 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -254995,9 +258012,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *219 - installation: *853 - organization: *854 - repository: *855 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -255074,12 +258091,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 - team: &920 + team: &921 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -255309,9 +258326,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 repository: title: Repository description: A git repository @@ -255781,7 +258798,7 @@ webhooks: - topics - visibility sender: *4 - team: *920 + team: *921 required: - action - team @@ -255857,9 +258874,9 @@ webhooks: type: string enum: - created - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 repository: title: Repository description: A git repository @@ -256329,7 +259346,7 @@ webhooks: - topics - visibility sender: *4 - team: *920 + team: *921 required: - action - team @@ -256406,9 +259423,9 @@ webhooks: type: string enum: - deleted - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 repository: title: Repository description: A git repository @@ -256878,7 +259895,7 @@ webhooks: - topics - visibility sender: *4 - team: *920 + team: *921 required: - action - team @@ -257022,9 +260039,9 @@ webhooks: - from required: - permissions - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 repository: title: Repository description: A git repository @@ -257494,7 +260511,7 @@ webhooks: - topics - visibility sender: *4 - team: *920 + team: *921 required: - action - changes @@ -257572,9 +260589,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *852 - installation: *853 - organization: *854 + enterprise: *853 + installation: *854 + organization: *855 repository: title: Repository description: A git repository @@ -258044,7 +261061,7 @@ webhooks: - topics - visibility sender: *4 - team: *920 + team: *921 required: - action - team @@ -258120,10 +261137,10 @@ webhooks: type: string enum: - started - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 required: - action @@ -258196,17 +261213,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *852 + enterprise: *853 inputs: type: - object - 'null' additionalProperties: true - installation: *853 - organization: *854 + installation: *854 + organization: *855 ref: type: string - repository: *855 + repository: *856 sender: *4 workflow: type: string @@ -258288,10 +261305,10 @@ webhooks: type: string enum: - completed - enterprise: *852 - installation: *853 - organization: *854 - repository: *855 + enterprise: *853 + installation: *854 + organization: *855 + repository: *856 sender: *4 workflow_job: allOf: @@ -258547,7 +261564,7 @@ webhooks: type: string required: - conclusion - deployment: *607 + deployment: *608 required: - action - repository @@ -258626,10 +261643,10 @@ webhooks: type: string enum: {"code":"deadline_exceeded","msg":"operation timed out"}