diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index a545ddaf3..3aa2c8bf0 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -530,6 +530,3164 @@ } } }, + "/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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", @@ -14656,7 +17814,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" ], @@ -14709,20 +17867,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, "example": "1.2.3" @@ -27964,7 +31122,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" ], @@ -28047,7 +31205,387 @@ } }, "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.", + "example": "012345678912345678", + "type": "string" + }, + "key": { + "description": "The Base64 encoded public key.", + "example": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "type": "string" + } + } + }, + "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", + "nullable": true + }, + "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", @@ -28055,7 +31593,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -28091,7 +31630,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": { @@ -28109,365 +31648,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.", - "example": "012345678912345678", - "type": "string" - }, - "key": { - "description": "The Base64 encoded public key.", - "example": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "type": "string" - } - } - }, - "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", - "nullable": true - }, - "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`.", + "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" }, - "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" } } @@ -31648,6 +34835,9 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-bypassed" } ], "responses": { @@ -35066,6 +38256,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", @@ -37477,6 +40800,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", @@ -66131,6 +69522,9 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-bypassed" } ], "responses": { @@ -66337,6 +69731,9 @@ "400": { "description": "Bad request, resolution comment is invalid or the resolution was not changed." }, + "403": { + "description": "Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer." + }, "404": { "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, @@ -122005,7 +125402,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -122086,6 +125484,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" @@ -122142,7 +125548,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -122229,6 +125636,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" @@ -128912,6 +132327,134 @@ "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", + "format": "date-time", + "nullable": true + } + } + } + } + } + }, + "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", + "format": "uri", + "description": "API URL for the workflow run.", + "nullable": true + }, + "run_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the workflow run.", + "nullable": true + }, + "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", + "format": "uri", + "description": "API URL for the job.", + "nullable": true + }, + "job_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the job.", + "nullable": true + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + }, "job": { "title": "Job", "description": "Information of a job execution in a workflow run", @@ -129646,6 +133189,119 @@ "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", + "format": "uri", + "description": "API URL for the workflow run.", + "nullable": true + }, + "run_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the workflow run.", + "nullable": true + }, + "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", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease.", + "nullable": true + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease.", + "nullable": true + }, + "job_url": { + "type": "string", + "format": "uri", + "description": "API URL for the job.", + "nullable": true + }, + "job_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the job.", + "nullable": true + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } + }, "review-custom-gates-comment-required": { "type": "object", "properties": { @@ -303317,6 +306973,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, @@ -304105,6 +307812,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": [ { @@ -324106,6 +327854,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.", @@ -324239,6 +327996,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/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index c1277e1db..66f9f9816 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -343,6 +343,2525 @@ 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 @@ -10620,6 +13139,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 @@ -10662,24 +13185,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 example: 1.2.3 @@ -20417,7 +22934,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: @@ -20510,7 +23027,332 @@ 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. + example: '012345678912345678' + type: string + key: + description: The Base64 encoded public key. + example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + type: string + 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 + nullable: true + 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 @@ -20519,6 +23361,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`. @@ -20551,7 +23394,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` @@ -20569,309 +23412,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. - example: '012345678912345678' - type: string - key: - description: The Base64 encoded public key. - example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - type: string - 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. - 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 - nullable: true - 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. + 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 - 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: @@ -23058,6 +25607,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 @@ -25646,6 +28196,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 @@ -27347,6 +30002,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 @@ -48168,6 +50881,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 @@ -48308,6 +51022,9 @@ paths: '400': description: Bad request, resolution comment is invalid or the resolution was not changed. + '403': + description: Delegated alert dismissal is enabled and the authenticated + user is not a valid reviewer. '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found @@ -89433,6 +92150,7 @@ components: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -89498,6 +92216,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 @@ -89547,6 +92273,7 @@ components: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -89618,6 +92345,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 @@ -94838,6 +97573,107 @@ 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 + format: date-time + nullable: true + 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 + format: uri + description: API URL for the workflow run. + nullable: true + run_html_url: + type: string + format: uri + description: Web URL for the workflow run. + nullable: true + 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 + format: uri + description: API URL for the job. + nullable: true + job_html_url: + type: string + format: uri + description: Web URL for the job. + nullable: true + status: + type: string + enum: + - in_progress + - pending job: title: Job description: Information of a job execution in a workflow run @@ -95444,6 +98280,110 @@ 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 + format: uri + description: API URL for the workflow run. + nullable: true + run_html_url: + type: string + format: uri + description: Web URL for the workflow run. + nullable: true + 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 + description: The ID of the job, when the item represents a job-level + or reusable-workflow-level lease. + nullable: true + job_name: + type: string + description: The display name of the job, when the item represents + a job-level or reusable-workflow-level lease. + nullable: true + job_url: + type: string + format: uri + description: API URL for the job. + nullable: true + job_html_url: + type: string + format: uri + description: Web URL for the job. + nullable: true + status: + type: string + enum: + - in_progress + - pending review-custom-gates-comment-required: type: object properties: @@ -228091,6 +231031,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 @@ -228767,6 +231742,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: @@ -246071,6 +249074,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. @@ -246186,6 +249200,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/api.github.com/api.github.com.2026-03-10.json b/descriptions/api.github.com/api.github.com.2026-03-10.json index eff49dadc..442f99604 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions/api.github.com/api.github.com.2026-03-10.json @@ -530,6 +530,3164 @@ } } }, + "/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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", @@ -14655,7 +17813,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" ], @@ -14708,20 +17866,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, "example": "1.2.3" @@ -27923,7 +31081,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" ], @@ -28006,7 +31164,387 @@ } }, "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.", + "example": "012345678912345678", + "type": "string" + }, + "key": { + "description": "The Base64 encoded public key.", + "example": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "type": "string" + } + } + }, + "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", + "nullable": true + }, + "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", @@ -28014,7 +31552,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -28050,7 +31589,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": { @@ -28068,365 +31607,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.", - "example": "012345678912345678", - "type": "string" - }, - "key": { - "description": "The Base64 encoded public key.", - "example": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "type": "string" - } - } - }, - "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", - "nullable": true - }, - "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`.", + "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" }, - "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" } } @@ -31610,6 +34797,9 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-bypassed" } ], "responses": { @@ -35019,6 +38209,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", @@ -37430,6 +40753,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", @@ -66048,6 +69439,9 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-bypassed" } ], "responses": { @@ -66254,6 +69648,9 @@ "400": { "description": "Bad request, resolution comment is invalid or the resolution was not changed." }, + "403": { + "description": "Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer." + }, "404": { "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, @@ -121506,7 +124903,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -121587,6 +124985,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" @@ -121643,7 +125049,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -121730,6 +125137,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" @@ -128343,6 +131758,134 @@ "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", + "format": "date-time", + "nullable": true + } + } + } + } + } + }, + "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", + "format": "uri", + "description": "API URL for the workflow run.", + "nullable": true + }, + "run_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the workflow run.", + "nullable": true + }, + "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", + "format": "uri", + "description": "API URL for the job.", + "nullable": true + }, + "job_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the job.", + "nullable": true + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + }, "job": { "title": "Job", "description": "Information of a job execution in a workflow run", @@ -129077,6 +132620,119 @@ "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", + "format": "uri", + "description": "API URL for the workflow run.", + "nullable": true + }, + "run_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the workflow run.", + "nullable": true + }, + "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", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease.", + "nullable": true + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease.", + "nullable": true + }, + "job_url": { + "type": "string", + "format": "uri", + "description": "API URL for the job.", + "nullable": true + }, + "job_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the job.", + "nullable": true + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } + }, "review-custom-gates-comment-required": { "type": "object", "properties": { @@ -302562,6 +306218,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, @@ -303350,6 +307057,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": [ { @@ -323261,6 +327009,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.", @@ -323394,6 +327151,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/api.github.com/api.github.com.2026-03-10.yaml b/descriptions/api.github.com/api.github.com.2026-03-10.yaml index 93cb1e7c8..bbe44c60a 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions/api.github.com/api.github.com.2026-03-10.yaml @@ -343,6 +343,2525 @@ 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 @@ -10618,6 +13137,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 @@ -10660,24 +13183,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 example: 1.2.3 @@ -20386,7 +22903,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: @@ -20479,7 +22996,332 @@ 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. + example: '012345678912345678' + type: string + key: + description: The Base64 encoded public key. + example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + type: string + 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 + nullable: true + 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 @@ -20488,6 +23330,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`. @@ -20520,7 +23363,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` @@ -20538,309 +23381,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. - example: '012345678912345678' - type: string - key: - description: The Base64 encoded public key. - example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - type: string - 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. - 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 - nullable: true - 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. + 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 - 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: @@ -23029,6 +25578,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 @@ -25609,6 +28159,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 @@ -27310,6 +29965,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 @@ -48096,6 +50809,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 @@ -48236,6 +50950,9 @@ paths: '400': description: Bad request, resolution comment is invalid or the resolution was not changed. + '403': + description: Delegated alert dismissal is enabled and the authenticated + user is not a valid reviewer. '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found @@ -89039,6 +91756,7 @@ components: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -89104,6 +91822,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 @@ -89153,6 +91879,7 @@ components: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -89224,6 +91951,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 @@ -94386,6 +97121,107 @@ 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 + format: date-time + nullable: true + 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 + format: uri + description: API URL for the workflow run. + nullable: true + run_html_url: + type: string + format: uri + description: Web URL for the workflow run. + nullable: true + 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 + format: uri + description: API URL for the job. + nullable: true + job_html_url: + type: string + format: uri + description: Web URL for the job. + nullable: true + status: + type: string + enum: + - in_progress + - pending job: title: Job description: Information of a job execution in a workflow run @@ -94992,6 +97828,110 @@ 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 + format: uri + description: API URL for the workflow run. + nullable: true + run_html_url: + type: string + format: uri + description: Web URL for the workflow run. + nullable: true + 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 + description: The ID of the job, when the item represents a job-level + or reusable-workflow-level lease. + nullable: true + job_name: + type: string + description: The display name of the job, when the item represents + a job-level or reusable-workflow-level lease. + nullable: true + job_url: + type: string + format: uri + description: API URL for the job. + nullable: true + job_html_url: + type: string + format: uri + description: Web URL for the job. + nullable: true + status: + type: string + enum: + - in_progress + - pending review-custom-gates-comment-required: type: object properties: @@ -227410,6 +230350,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 @@ -228086,6 +231061,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: @@ -245305,6 +248308,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. @@ -245420,6 +248434,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/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 805b21cf4..ce29d69a8 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -530,6 +530,3164 @@ } } }, + "/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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", @@ -14702,7 +17860,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" ], @@ -14755,20 +17913,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, "example": "1.2.3" @@ -28143,7 +31301,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" ], @@ -28226,7 +31384,387 @@ } }, "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.", + "example": "012345678912345678", + "type": "string" + }, + "key": { + "description": "The Base64 encoded public key.", + "example": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "type": "string" + } + } + }, + "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", + "nullable": true + }, + "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", @@ -28234,7 +31772,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -28270,7 +31809,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": { @@ -28288,365 +31827,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.", - "example": "012345678912345678", - "type": "string" - }, - "key": { - "description": "The Base64 encoded public key.", - "example": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "type": "string" - } - } - }, - "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", - "nullable": true - }, - "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`.", + "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" }, - "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" } } @@ -31840,6 +35027,9 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-bypassed" } ], "responses": { @@ -35278,6 +38468,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", @@ -37689,6 +41012,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", @@ -66438,6 +69829,9 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-bypassed" } ], "responses": { @@ -66644,6 +70038,9 @@ "400": { "description": "Bad request, resolution comment is invalid or the resolution was not changed." }, + "403": { + "description": "Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer." + }, "404": { "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, @@ -122787,7 +126184,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -122868,6 +126266,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" @@ -122924,7 +126330,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -123011,6 +126418,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" @@ -130037,6 +133452,134 @@ "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", + "format": "date-time", + "nullable": true + } + } + } + } + } + }, + "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", + "format": "uri", + "description": "API URL for the workflow run.", + "nullable": true + }, + "run_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the workflow run.", + "nullable": true + }, + "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", + "format": "uri", + "description": "API URL for the job.", + "nullable": true + }, + "job_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the job.", + "nullable": true + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + }, "job": { "title": "Job", "description": "Information of a job execution in a workflow run", @@ -130771,6 +134314,119 @@ "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", + "format": "uri", + "description": "API URL for the workflow run.", + "nullable": true + }, + "run_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the workflow run.", + "nullable": true + }, + "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", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease.", + "nullable": true + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease.", + "nullable": true + }, + "job_url": { + "type": "string", + "format": "uri", + "description": "API URL for the job.", + "nullable": true + }, + "job_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the job.", + "nullable": true + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } + }, "review-custom-gates-comment-required": { "type": "object", "properties": { @@ -305500,6 +309156,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, @@ -306288,6 +309995,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": [ { @@ -326417,6 +330165,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.", @@ -326550,6 +330307,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/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index e056574f0..43b0e6504 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -343,6 +343,2525 @@ 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 @@ -10645,6 +13164,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 @@ -10687,24 +13210,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 example: 1.2.3 @@ -20512,7 +23029,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: @@ -20605,7 +23122,332 @@ 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. + example: '012345678912345678' + type: string + key: + description: The Base64 encoded public key. + example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + type: string + 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 + nullable: true + 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 @@ -20614,6 +23456,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`. @@ -20646,7 +23489,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` @@ -20664,309 +23507,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. - example: '012345678912345678' - type: string - key: - description: The Base64 encoded public key. - example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - type: string - 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. - 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 - nullable: true - 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. + 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 - 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: @@ -23160,6 +25709,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 @@ -25759,6 +28309,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 @@ -27460,6 +30115,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 @@ -48356,6 +51069,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 @@ -48496,6 +51210,9 @@ paths: '400': description: Bad request, resolution comment is invalid or the resolution was not changed. + '403': + description: Delegated alert dismissal is enabled and the authenticated + user is not a valid reviewer. '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found @@ -89941,6 +92658,7 @@ components: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -90006,6 +92724,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 @@ -90055,6 +92781,7 @@ components: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -90126,6 +92853,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 @@ -95637,6 +98372,107 @@ 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 + format: date-time + nullable: true + 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 + format: uri + description: API URL for the workflow run. + nullable: true + run_html_url: + type: string + format: uri + description: Web URL for the workflow run. + nullable: true + 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 + format: uri + description: API URL for the job. + nullable: true + job_html_url: + type: string + format: uri + description: Web URL for the job. + nullable: true + status: + type: string + enum: + - in_progress + - pending job: title: Job description: Information of a job execution in a workflow run @@ -96243,6 +99079,110 @@ 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 + format: uri + description: API URL for the workflow run. + nullable: true + run_html_url: + type: string + format: uri + description: Web URL for the workflow run. + nullable: true + 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 + description: The ID of the job, when the item represents a job-level + or reusable-workflow-level lease. + nullable: true + job_name: + type: string + description: The display name of the job, when the item represents + a job-level or reusable-workflow-level lease. + nullable: true + job_url: + type: string + format: uri + description: API URL for the job. + nullable: true + job_html_url: + type: string + format: uri + description: Web URL for the job. + nullable: true + status: + type: string + enum: + - in_progress + - pending review-custom-gates-comment-required: type: object properties: @@ -229517,6 +232457,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 @@ -230193,6 +233168,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: @@ -247561,6 +250564,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. @@ -247676,6 +250690,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/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index ac2c32de8..e40f105bd 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -2028,6 +2028,3164 @@ } } }, + "/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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", @@ -92788,7 +95946,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" ], @@ -92847,20 +96005,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, "example": "1.2.3" @@ -169523,7 +172681,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -169604,6 +172763,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" @@ -169748,7 +172915,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" ], @@ -169837,7 +173004,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", @@ -169845,7 +173012,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -169881,7 +173049,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": { @@ -169899,6 +173067,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": [ @@ -169957,6 +173133,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" + } } } } @@ -170006,7 +173193,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -170093,412 +173281,429 @@ "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": { - "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": { - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "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": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "key_id", - "key" - ], - "properties": { - "key_id": { - "description": "The identifier for the key.", - "example": "012345678912345678", - "type": "string" - }, - "key": { - "description": "The Base64 encoded public key.", - "example": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "type": "string" - } - } - }, - "examples": { - "default": { - "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "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" - } - } - } - } - } - } - }, - "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": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The specified private registry configuration for the organization", - "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.", - "example": "MAVEN_REPOSITORY_SECRET", - "type": "string" - }, - "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" - ], + "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": { + "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": { + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key_id", + "key" + ], + "properties": { + "key_id": { + "description": "The identifier for the key.", + "example": "012345678912345678", + "type": "string" + }, + "key": { + "description": "The Base64 encoded public key.", + "example": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "type": "string" + } + } + }, + "examples": { + "default": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "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" + } + } + } + } + } + } + }, + "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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "The specified private registry configuration for the organization", + "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.", + "example": "MAVEN_REPOSITORY_SECRET", + "type": "string" + }, + "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.", + "example": "monalisa", + "type": "string", + "nullable": true + }, + "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.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "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" }, - "url": { - "description": "The URL of the private registry.", - "type": "string", - "format": "uri" - }, - "username": { - "description": "The username to use when authenticating with the private registry.", - "example": "monalisa", - "type": "string", - "nullable": true - }, - "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.", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "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.", + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", "type": "string" }, "created_at": { @@ -170569,7 +173774,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" ], @@ -170675,7 +173880,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -170711,7 +173917,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": { @@ -170729,6 +173935,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" } } }, @@ -213235,6 +216449,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": { @@ -237606,25 +240829,525 @@ } }, { - "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", + "format": "date-time", + "nullable": true + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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", + "format": "uri", + "description": "API URL for the workflow run.", + "nullable": true + }, + "run_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the workflow run.", + "nullable": true + }, + "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", + "format": "uri", + "description": "API URL for the job.", + "nullable": true + }, + "job_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the job.", + "nullable": true + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "concurrency-groups" } } }, @@ -252602,99 +256325,374 @@ } }, { - "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", + "format": "uri", + "description": "API URL for the workflow run.", + "nullable": true + }, + "run_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the workflow run.", + "nullable": true + }, + "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", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease.", + "nullable": true + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease.", + "nullable": true + }, + "job_url": { + "type": "string", + "format": "uri", + "description": "API URL for the job.", + "nullable": true + }, + "job_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the job.", + "nullable": true + }, + "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": { @@ -252718,13 +256716,82 @@ } } } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "workflow-runs" + "subcategory": "concurrency-groups" } } }, @@ -534750,6 +538817,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": { @@ -538613,6 +542689,9 @@ "400": { "description": "Bad request, resolution comment is invalid or the resolution was not changed." }, + "403": { + "description": "Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer." + }, "404": { "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index ec9996952..9ec5cde1d 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -1028,7 +1028,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &671 + - &672 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1118,6 +1118,2525 @@ 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 @@ -11493,7 +14012,7 @@ paths: properties: action: type: string - discussion: &765 + discussion: &766 title: Discussion description: A Discussion in a repository. type: object @@ -12236,7 +14755,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &682 + sub_issues_summary: &683 title: Sub-issues Summary type: object properties: @@ -12349,7 +14868,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &683 + issue_dependencies_summary: &684 title: Issue Dependencies Summary type: object properties: @@ -13793,7 +16312,7 @@ paths: url: type: string format: uri - user: &689 + user: &690 title: Public User description: Public User type: object @@ -19015,7 +21534,7 @@ paths: required: false schema: type: string - - &740 + - &741 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -19161,7 +21680,7 @@ paths: parameters: - *78 - *124 - - &741 + - &742 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 @@ -19273,7 +21792,7 @@ paths: - *124 - *126 - *125 - - &742 + - &743 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -19281,7 +21800,7 @@ paths: schema: type: string - *127 - - &743 + - &744 name: sku description: The SKU to query for usage. in: query @@ -25475,6 +27994,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 @@ -25517,24 +28040,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 example: 1.2.3 @@ -25995,12 +28512,12 @@ paths: required: - subject_digests examples: - default: &721 + default: &722 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &722 + withPredicateType: &723 value: subject_digests: - sha256:abc123 @@ -26058,7 +28575,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &723 + default: &724 value: attestations_subject_digests: - sha256:abc: @@ -38473,7 +40990,7 @@ paths: parameters: - *78 - *260 - - &704 + - &705 name: repo_name description: repo_name parameter in: path @@ -39514,7 +42031,7 @@ paths: - nuget - container - *78 - - &705 + - &706 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -39555,7 +42072,7 @@ paths: default: *267 '403': *29 '401': *25 - '400': &707 + '400': &708 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -40759,6 +43276,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -40827,6 +43345,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 @@ -40864,7 +43391,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: @@ -40957,7 +43484,472 @@ 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. + example: MAVEN_REPOSITORY_SECRET + type: string + 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. + example: monalisa + type: string + 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: &281 + 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: + - *78 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - key_id + - key + properties: + key_id: + description: The identifier for the key. + example: '012345678912345678' + type: string + key: + description: The Base64 encoded public key. + example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + type: string + examples: + default: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + headers: + Link: *70 + '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: + - *78 + - *169 + responses: + '200': + description: The specified private registry configuration for the organization + content: + application/json: + schema: *280 + examples: + default: *281 + '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: + - *78 + - *169 + 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 + nullable: true + 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 @@ -40966,6 +43958,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`. @@ -40998,7 +43991,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` @@ -41016,440 +44009,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. - example: MAVEN_REPOSITORY_SECRET - type: string - 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. - example: monalisa - type: string - 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: &281 - 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: - - *78 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - key_id - - key - properties: - key_id: - description: The identifier for the key. - example: '012345678912345678' - type: string - key: - description: The Base64 encoded public key. - example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - type: string - examples: - default: - value: - key_id: '012345678912345678' - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - headers: - Link: *70 - '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: - - *78 - - *169 - responses: - '200': - description: The specified private registry configuration for the organization - content: - application/json: - schema: *280 - examples: - default: *281 - '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: - - *78 - - *169 - 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 - nullable: true - 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. + 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: - - 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: @@ -41601,7 +44169,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &796 + properties: &797 id: type: number description: The unique identifier of the status update. @@ -41649,7 +44217,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &797 + required: &798 - id - node_id - created_at @@ -42467,7 +45035,7 @@ paths: - updated_at - project_url examples: - default: &727 + default: &728 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -42644,7 +45212,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &728 + items: &729 type: object properties: name: @@ -42681,7 +45249,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &729 + iteration_configuration: &730 type: object description: The configuration for iteration fields. properties: @@ -42731,7 +45299,7 @@ paths: value: name: Due date data_type: date - single_select_field: &730 + single_select_field: &731 summary: Create a single select field value: name: Priority @@ -42758,7 +45326,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &731 + iteration_field: &732 summary: Create an iteration field value: name: Sprint @@ -42784,7 +45352,7 @@ paths: application/json: schema: *288 examples: - text_field: &732 + text_field: &733 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -42793,7 +45361,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: &733 + number_field: &734 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -42802,7 +45370,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: &734 + date_field: &735 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -42811,7 +45379,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: &735 + single_select_field: &736 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -42845,7 +45413,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &736 + iteration_field: &737 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -42891,7 +45459,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *284 - - &737 + - &738 name: field_id description: The unique identifier of the field. in: path @@ -42906,7 +45474,7 @@ paths: application/json: schema: *288 examples: - default: &738 + default: &739 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -44103,7 +46671,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &718 + schema: &719 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -44280,7 +46848,7 @@ paths: parameters: - *284 - *78 - - &739 + - &740 name: view_number description: The number that identifies the project view. in: path @@ -48289,6 +50857,17 @@ paths: schema: type: boolean default: false + - &649 + 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 @@ -48315,14 +50894,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &649 + state: &650 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: &650 + resolution: &651 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -48439,8 +51018,8 @@ paths: pull request. ' - oneOf: &651 - - &653 + oneOf: &652 + - &654 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -48498,7 +51077,7 @@ paths: - blob_url - commit_sha - commit_url - - &654 + - &655 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. @@ -48553,7 +51132,7 @@ paths: - page_url - commit_sha - commit_url - - &655 + - &656 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -48573,7 +51152,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &656 + - &657 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -48593,7 +51172,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &657 + - &658 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -48613,7 +51192,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &658 + - &659 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -48627,7 +51206,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &659 + - &660 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -48641,7 +51220,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &660 + - &661 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -48655,7 +51234,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &661 + - &662 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. @@ -48675,7 +51254,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &662 + - &663 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. @@ -48695,7 +51274,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &663 + - &664 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. @@ -48715,7 +51294,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &664 + - &665 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. @@ -48735,7 +51314,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &665 + - &666 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 request. @@ -49254,7 +51833,7 @@ paths: application/json: schema: type: array - items: &669 + items: &670 description: A repository security advisory. type: object properties: @@ -49545,7 +52124,7 @@ paths: - private_fork additionalProperties: false examples: - default: &670 + default: &671 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -51532,7 +54111,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &685 + response-if-user-is-a-team-maintainer: &686 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -51597,7 +54176,7 @@ paths: application/json: schema: *347 examples: - response-if-users-membership-with-team-is-now-pending: &686 + response-if-users-membership-with-team-is-now-pending: &687 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -51711,7 +54290,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &687 + schema: &688 title: Team Repository description: A team's access to a repository. type: object @@ -52368,7 +54947,7 @@ paths: type: array items: *201 examples: - response-if-child-teams-exist: &688 + response-if-child-teams-exist: &689 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -54200,6 +56779,240 @@ 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: + - *348 + - *349 + - *17 + - *48 + 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 + format: date-time + nullable: true + 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: *70 + '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: + - *348 + - *349 + - 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 + format: uri + description: API URL for the workflow run. + nullable: true + run_html_url: + type: string + format: uri + description: Web URL for the workflow run. + nullable: true + 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 + format: uri + description: API URL for the job. + nullable: true + job_html_url: + type: string + format: uri + description: Web URL for the job. + nullable: true + 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 @@ -57151,6 +59964,192 @@ 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: + - *348 + - *349 + - *386 + - *17 + - *47 + - *48 + 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 + format: uri + description: API URL for the workflow run. + nullable: true + run_html_url: + type: string + format: uri + description: Web URL for the workflow run. + nullable: true + 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 + description: The ID of the job, when the item represents + a job-level or reusable-workflow-level lease. + nullable: true + job_name: + type: string + description: The display name of the job, when the + item represents a job-level or reusable-workflow-level + lease. + nullable: true + job_url: + type: string + format: uri + description: API URL for the job. + nullable: true + job_html_url: + type: string + format: uri + description: Web URL for the job. + nullable: true + 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: *70 + '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 @@ -57590,7 +60589,7 @@ paths: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &759 + properties: &760 url: type: string format: uri @@ -57675,7 +60674,7 @@ paths: nullable: true properties: *83 required: *84 - required: &760 + required: &761 - id - node_id - sha @@ -63284,7 +66283,7 @@ paths: check. type: array items: *93 - deployment: &752 + deployment: &753 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -64196,7 +67195,7 @@ paths: type: string format: date-time nullable: true - head_commit: &780 + head_commit: &781 title: Simple Commit description: A commit. type: object @@ -68467,14 +71466,14 @@ paths: type: integer machines: type: array - items: &694 + items: &695 type: object title: Codespace machine description: A description of the machine powering a codespace. properties: *470 required: *471 examples: - default: &695 + default: &696 value: total_count: 2 machines: @@ -71620,7 +74619,7 @@ paths: application/json: schema: type: array - items: &674 + items: &675 title: Status description: The status of a commit. type: object @@ -73203,7 +76202,7 @@ paths: items: type: object properties: - placeholder_id: &666 + placeholder_id: &667 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -79061,7 +82060,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &788 + last_response: &789 title: Hook Response type: object properties: @@ -80113,7 +83112,7 @@ paths: parameters: - *348 - *349 - - &716 + - &717 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -80547,7 +83546,7 @@ paths: type: array items: *550 examples: - default: &709 + default: &710 value: - id: 1 repository: @@ -94836,6 +97835,7 @@ paths: - *646 - *647 - *648 + - *649 responses: '200': description: Response @@ -94843,7 +97843,7 @@ paths: application/json: schema: type: array - items: &652 + items: &653 type: object properties: number: *179 @@ -94862,8 +97862,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *649 - resolution: *650 + state: *650 + resolution: *651 resolved_at: type: string format: date-time @@ -94969,7 +97969,7 @@ paths: pull request. ' - oneOf: *651 + oneOf: *652 nullable: true has_more_locations: type: boolean @@ -95142,7 +98142,7 @@ paths: description: Response content: application/json: - schema: *652 + schema: *653 examples: default: value: @@ -95206,8 +98206,8 @@ paths: schema: type: object properties: - state: *649 - resolution: *650 + state: *650 + resolution: *651 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -95251,7 +98251,7 @@ paths: description: Response content: application/json: - schema: *652 + schema: *653 examples: default: value: @@ -95318,6 +98318,9 @@ paths: '400': description: Bad request, resolution comment is invalid or the resolution was not changed. + '403': + description: Delegated alert dismissal is enabled and the authenticated + user is not a valid reviewer. '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found @@ -95360,7 +98363,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &810 + items: &811 type: object properties: type: @@ -95386,7 +98389,6 @@ paths: example: commit details: oneOf: - - *653 - *654 - *655 - *656 @@ -95399,6 +98401,7 @@ paths: - *663 - *664 - *665 + - *666 examples: default: value: @@ -95493,14 +98496,14 @@ paths: schema: type: object properties: - reason: &667 + reason: &668 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *666 + placeholder_id: *667 required: - reason - placeholder_id @@ -95517,7 +98520,7 @@ paths: schema: type: object properties: - reason: *667 + reason: *668 expire_at: type: string format: date-time @@ -95579,7 +98582,7 @@ paths: properties: incremental_scans: type: array - items: &668 + items: &669 description: Information on a single scan performed by secret scanning on the repository type: object @@ -95605,15 +98608,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *668 + items: *669 backfill_scans: type: array - items: *668 + items: *669 custom_pattern_backfill_scans: type: array items: allOf: - - *668 + - *669 - type: object properties: pattern_name: @@ -95626,7 +98629,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *668 + items: *669 examples: default: value: @@ -95736,9 +98739,9 @@ paths: application/json: schema: type: array - items: *669 + items: *670 examples: - default: *670 + default: *671 '400': *14 '404': *6 x-github: @@ -95922,9 +98925,9 @@ paths: description: Response content: application/json: - schema: *669 + schema: *670 examples: - default: &672 + default: &673 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -96262,7 +99265,7 @@ paths: description: Response content: application/json: - schema: *669 + schema: *670 examples: default: value: @@ -96411,15 +99414,15 @@ paths: parameters: - *348 - *349 - - *671 + - *672 responses: '200': description: Response content: application/json: - schema: *669 + schema: *670 examples: - default: *672 + default: *673 '403': *29 '404': *6 x-github: @@ -96445,7 +99448,7 @@ paths: parameters: - *348 - *349 - - *671 + - *672 requestBody: required: true content: @@ -96604,10 +99607,10 @@ paths: description: Response content: application/json: - schema: *669 + schema: *670 examples: - default: *672 - add_credit: *672 + default: *673 + add_credit: *673 '403': *29 '404': *6 '422': @@ -96647,7 +99650,7 @@ paths: parameters: - *348 - *349 - - *671 + - *672 responses: '202': *39 '400': *14 @@ -96676,7 +99679,7 @@ paths: parameters: - *348 - *349 - - *671 + - *672 responses: '202': description: Response @@ -96820,7 +99823,7 @@ paths: application/json: schema: type: array - items: &673 + items: &674 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -97193,7 +100196,7 @@ paths: application/json: schema: type: array - items: *673 + items: *674 examples: default: value: @@ -97281,7 +100284,7 @@ paths: description: Response content: application/json: - schema: *674 + schema: *675 examples: default: value: @@ -97375,7 +100378,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &675 + schema: &676 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -97470,7 +100473,7 @@ paths: description: Response content: application/json: - schema: *675 + schema: *676 examples: default: value: @@ -97677,7 +100680,7 @@ paths: description: Response content: application/json: - schema: &676 + schema: &677 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -97689,7 +100692,7 @@ paths: required: - names examples: - default: &677 + default: &678 value: names: - octocat @@ -97744,9 +100747,9 @@ paths: description: Response content: application/json: - schema: *676 + schema: *677 examples: - default: *677 + default: *678 '404': *6 '422': *7 x-github: @@ -97769,7 +100772,7 @@ paths: parameters: - *348 - *349 - - &678 + - &679 name: per description: The time frame to display results for. in: query @@ -97798,7 +100801,7 @@ paths: example: 128 clones: type: array - items: &679 + items: &680 title: Traffic type: object properties: @@ -98039,7 +101042,7 @@ paths: parameters: - *348 - *349 - - *678 + - *679 responses: '200': description: Response @@ -98058,7 +101061,7 @@ paths: example: 3782 views: type: array - items: *679 + items: *680 required: - uniques - count @@ -98830,7 +101833,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &680 + text_matches: &681 title: Search Result Text Matches type: array items: @@ -98992,7 +101995,7 @@ paths: enum: - author-date - committer-date - - &681 + - &682 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 @@ -99120,7 +102123,7 @@ paths: type: number node_id: type: string - text_matches: *680 + text_matches: *681 required: - sha - node_id @@ -99312,7 +102315,7 @@ paths: - interactions - created - updated - - *681 + - *682 - *17 - *19 - name: advanced_search @@ -99426,8 +102429,8 @@ paths: description: type: string nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -99462,7 +102465,7 @@ paths: type: string format: date-time nullable: true - text_matches: *680 + text_matches: *681 pull_request: type: object properties: @@ -99734,7 +102737,7 @@ paths: enum: - created - updated - - *681 + - *682 - *17 - *19 responses: @@ -99778,7 +102781,7 @@ paths: nullable: true score: type: number - text_matches: *680 + text_matches: *681 required: - id - node_id @@ -99863,7 +102866,7 @@ paths: - forks - help-wanted-issues - updated - - *681 + - *682 - *17 - *19 responses: @@ -100111,7 +103114,7 @@ paths: - admin - pull - push - text_matches: *680 + text_matches: *681 temp_clone_token: type: string allow_merge_commit: @@ -100411,7 +103414,7 @@ paths: type: string format: uri nullable: true - text_matches: *680 + text_matches: *681 related: type: array nullable: true @@ -100602,7 +103605,7 @@ paths: - followers - repositories - joined - - *681 + - *682 - *17 - *19 responses: @@ -100706,7 +103709,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *680 + text_matches: *681 blog: type: string nullable: true @@ -100785,7 +103788,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &684 + - &685 name: team_id description: The unique identifier of the team. in: path @@ -100826,7 +103829,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *684 + - *685 requestBody: required: true content: @@ -100926,7 +103929,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *684 + - *685 responses: '204': description: Response @@ -100955,7 +103958,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *684 + - *685 - *17 - *19 responses: @@ -100993,7 +103996,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *684 + - *685 - name: role description: Filters members returned by their role in the team. in: query @@ -101044,7 +104047,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *684 + - *685 - *74 responses: '204': @@ -101081,7 +104084,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *684 + - *685 - *74 responses: '204': @@ -101121,7 +104124,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *684 + - *685 - *74 responses: '204': @@ -101158,7 +104161,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *684 + - *685 - *74 responses: '200': @@ -101167,7 +104170,7 @@ paths: application/json: schema: *347 examples: - response-if-user-is-a-team-maintainer: *685 + response-if-user-is-a-team-maintainer: *686 '404': *6 x-github: githubCloudOnly: false @@ -101200,7 +104203,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *684 + - *685 - *74 requestBody: required: false @@ -101228,7 +104231,7 @@ paths: application/json: schema: *347 examples: - response-if-users-membership-with-team-is-now-pending: *686 + response-if-users-membership-with-team-is-now-pending: *687 '403': description: Forbidden if team synchronization is set up '422': @@ -101262,7 +104265,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *684 + - *685 - *74 responses: '204': @@ -101290,7 +104293,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *684 + - *685 - *17 - *19 responses: @@ -101332,7 +104335,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *684 + - *685 - *348 - *349 responses: @@ -101340,7 +104343,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *687 + schema: *688 examples: alternative-response-with-extra-repository-information: value: @@ -101491,7 +104494,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *684 + - *685 - *348 - *349 requestBody: @@ -101543,7 +104546,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *684 + - *685 - *348 - *349 responses: @@ -101570,7 +104573,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *684 + - *685 - *17 - *19 responses: @@ -101582,7 +104585,7 @@ paths: type: array items: *201 examples: - response-if-child-teams-exist: *688 + response-if-child-teams-exist: *689 headers: Link: *70 '404': *6 @@ -101615,7 +104618,7 @@ paths: application/json: schema: oneOf: - - &690 + - &691 title: Private User description: Private User type: object @@ -101818,7 +104821,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *689 + - *690 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -101971,7 +104974,7 @@ paths: description: Response content: application/json: - schema: *690 + schema: *691 examples: default: value: @@ -102369,7 +105372,7 @@ paths: type: integer secrets: type: array - items: &691 + items: &692 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -102485,7 +105488,7 @@ paths: description: Response content: application/json: - schema: *691 + schema: *692 examples: default: value: @@ -102898,7 +105901,7 @@ paths: description: Response content: application/json: - schema: &692 + schema: &693 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -102939,7 +105942,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &693 + default: &694 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -102984,9 +105987,9 @@ paths: description: Response content: application/json: - schema: *692 + schema: *693 examples: - default: *693 + default: *694 '404': *6 x-github: githubCloudOnly: false @@ -103023,9 +106026,9 @@ paths: type: integer machines: type: array - items: *694 + items: *695 examples: - default: *695 + default: *696 '304': *37 '500': *55 '401': *25 @@ -103964,7 +106967,7 @@ paths: type: array items: *266 examples: - default: &706 + default: &707 value: - id: 197 name: hello_docker @@ -104065,7 +107068,7 @@ paths: application/json: schema: type: array - items: &696 + items: &697 title: Email description: Email type: object @@ -104130,9 +107133,9 @@ paths: application/json: schema: type: array - items: *696 + items: *697 examples: - default: &708 + default: &709 value: - email: octocat@github.com verified: true @@ -104207,7 +107210,7 @@ paths: application/json: schema: type: array - items: *696 + items: *697 examples: default: value: @@ -104463,7 +107466,7 @@ paths: application/json: schema: type: array - items: &697 + items: &698 title: GPG Key description: A unique encryption key type: object @@ -104594,7 +107597,7 @@ paths: - subkeys - revoked examples: - default: &725 + default: &726 value: - id: 3 name: Octocat's GPG Key @@ -104679,9 +107682,9 @@ paths: description: Response content: application/json: - schema: *697 + schema: *698 examples: - default: &698 + default: &699 value: id: 3 name: Octocat's GPG Key @@ -104738,7 +107741,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &699 + - &700 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -104750,9 +107753,9 @@ paths: description: Response content: application/json: - schema: *697 + schema: *698 examples: - default: *698 + default: *699 '404': *6 '304': *37 '403': *29 @@ -104775,7 +107778,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *699 + - *700 responses: '204': description: Response @@ -105233,7 +108236,7 @@ paths: application/json: schema: type: array - items: &700 + items: &701 title: Key description: Key type: object @@ -105334,9 +108337,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *701 examples: - default: &701 + default: &702 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -105375,9 +108378,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *701 examples: - default: *701 + default: *702 '404': *6 '304': *37 '403': *29 @@ -105433,7 +108436,7 @@ paths: application/json: schema: type: array - items: &702 + items: &703 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -105501,7 +108504,7 @@ paths: - account - plan examples: - default: &703 + default: &704 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -105563,9 +108566,9 @@ paths: application/json: schema: type: array - items: *702 + items: *703 examples: - default: *703 + default: *704 headers: Link: *70 '304': *37 @@ -106574,7 +109577,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *260 - - *704 + - *705 responses: '204': description: Response @@ -106689,7 +109692,7 @@ paths: - docker - nuget - container - - *705 + - *706 - *19 - *17 responses: @@ -106701,8 +109704,8 @@ paths: type: array items: *266 examples: - default: *706 - '400': *707 + default: *707 + '400': *708 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106731,7 +109734,7 @@ paths: application/json: schema: *266 examples: - default: &726 + default: &727 value: id: 40201 name: octo-name @@ -107093,9 +110096,9 @@ paths: application/json: schema: type: array - items: *696 + items: *697 examples: - default: *708 + default: *709 headers: Link: *70 '304': *37 @@ -107208,7 +110211,7 @@ paths: type: array items: *82 examples: - default: &715 + default: &716 summary: Default response value: - id: 1296269 @@ -107554,7 +110557,7 @@ paths: type: array items: *550 examples: - default: *709 + default: *710 headers: Link: *70 '304': *37 @@ -107633,7 +110636,7 @@ paths: application/json: schema: type: array - items: &710 + items: &711 title: Social account description: Social media account type: object @@ -107648,7 +110651,7 @@ paths: - provider - url examples: - default: &711 + default: &712 value: - provider: twitter url: https://twitter.com/github @@ -107710,9 +110713,9 @@ paths: application/json: schema: type: array - items: *710 + items: *711 examples: - default: *711 + default: *712 '422': *15 '304': *37 '404': *6 @@ -107799,7 +110802,7 @@ paths: application/json: schema: type: array - items: &712 + items: &713 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -107819,7 +110822,7 @@ paths: - title - created_at examples: - default: &744 + default: &745 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -107883,9 +110886,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: &713 + default: &714 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -107915,7 +110918,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: - - &714 + - &715 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -107927,9 +110930,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: *713 + default: *714 '404': *6 '304': *37 '403': *29 @@ -107952,7 +110955,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: - - *714 + - *715 responses: '204': description: Response @@ -107981,7 +110984,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &745 + - &746 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 @@ -108006,11 +111009,11 @@ paths: type: array items: *82 examples: - default-response: *715 + default-response: *716 application/vnd.github.v3.star+json: schema: type: array - items: &746 + items: &747 title: Starred Repository description: Starred Repository type: object @@ -108379,10 +111382,10 @@ paths: application/json: schema: oneOf: + - *691 - *690 - - *689 examples: - default-response: &719 + default-response: &720 summary: Default response value: login: octocat @@ -108417,7 +111420,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &720 + response-with-git-hub-plan-information: &721 summary: Response with GitHub plan information value: login: octocat @@ -108474,7 +111477,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &717 + - &718 name: user_id description: The unique identifier of the user. in: path @@ -108540,7 +111543,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *716 + - *717 - *17 responses: '200': @@ -108575,7 +111578,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *717 + - *718 - *284 requestBody: required: true @@ -108647,7 +111650,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *718 + schema: *719 examples: table_view: summary: Response for creating a table view @@ -108699,11 +111702,11 @@ paths: application/json: schema: oneOf: + - *691 - *690 - - *689 examples: - default-response: *719 - response-with-git-hub-plan-information: *720 + default-response: *720 + response-with-git-hub-plan-information: *721 '404': *6 x-github: githubCloudOnly: false @@ -108753,8 +111756,8 @@ paths: required: - subject_digests examples: - default: *721 - withPredicateType: *722 + default: *722 + withPredicateType: *723 responses: '200': description: Response @@ -108807,7 +111810,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *723 + default: *724 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -109293,7 +112296,7 @@ paths: application/json: schema: *195 examples: - default: &724 + default: &725 summary: Example response for a user copilot space value: id: 42 @@ -109394,7 +112397,7 @@ paths: application/json: schema: *195 examples: - default: *724 + default: *725 '403': *29 '404': *6 x-github: @@ -109517,7 +112520,7 @@ paths: application/json: schema: *195 examples: - default: *724 + default: *725 '403': *29 '404': *6 '422': *15 @@ -110285,7 +113288,7 @@ paths: type: array items: *266 examples: - default: *706 + default: *707 '403': *29 '401': *25 x-github: @@ -110669,9 +113672,9 @@ paths: application/json: schema: type: array - items: *697 + items: *698 examples: - default: *725 + default: *726 headers: Link: *70 x-github: @@ -110899,7 +113902,7 @@ paths: - docker - nuget - container - - *705 + - *706 - *74 - *19 - *17 @@ -110912,10 +113915,10 @@ paths: type: array items: *266 examples: - default: *706 + default: *707 '403': *29 '401': *25 - '400': *707 + '400': *708 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -110945,7 +113948,7 @@ paths: application/json: schema: *266 examples: - default: *726 + default: *727 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -111294,7 +114297,7 @@ paths: type: array items: *288 examples: - default: *727 + default: *728 headers: Link: *70 '304': *37 @@ -111354,7 +114357,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *728 + items: *729 required: - name - data_type @@ -111370,7 +114373,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *729 + iteration_configuration: *730 required: - name - data_type @@ -111392,8 +114395,8 @@ paths: value: name: Due date data_type: date - single_select_field: *730 - iteration_field: *731 + single_select_field: *731 + iteration_field: *732 responses: '201': description: Response @@ -111401,11 +114404,11 @@ paths: application/json: schema: *288 examples: - text_field: *732 - number_field: *733 - date_field: *734 - single_select_field: *735 - iteration_field: *736 + text_field: *733 + number_field: *734 + date_field: *735 + single_select_field: *736 + iteration_field: *737 '304': *37 '403': *29 '401': *25 @@ -111427,7 +114430,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *284 - - *737 + - *738 - *74 responses: '200': @@ -111436,7 +114439,7 @@ paths: application/json: schema: *288 examples: - default: *738 + default: *739 headers: Link: *70 '304': *37 @@ -111790,7 +114793,7 @@ paths: parameters: - *284 - *74 - - *739 + - *740 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -112065,7 +115068,7 @@ paths: - *124 - *126 - *125 - - *740 + - *741 - *127 responses: '200': @@ -112196,7 +115199,7 @@ paths: parameters: - *74 - *124 - - *741 + - *742 - *125 responses: '200': @@ -112295,9 +115298,9 @@ paths: - *124 - *126 - *125 - - *742 - - *127 - *743 + - *127 + - *744 responses: '200': description: Response when getting a billing usage summary @@ -112431,9 +115434,9 @@ paths: application/json: schema: type: array - items: *710 + items: *711 examples: - default: *711 + default: *712 headers: Link: *70 x-github: @@ -112463,9 +115466,9 @@ paths: application/json: schema: type: array - items: *712 + items: *713 examples: - default: *744 + default: *745 headers: Link: *70 x-github: @@ -112490,7 +115493,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *74 - - *745 + - *746 - *62 - *17 - *19 @@ -112502,11 +115505,11 @@ paths: schema: anyOf: - type: array - items: *746 + items: *747 - type: array items: *82 examples: - default-response: *715 + default-response: *716 headers: Link: *70 x-github: @@ -112665,7 +115668,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &747 + enterprise: &748 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -112723,7 +115726,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &748 + installation: &749 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -112742,7 +115745,7 @@ x-webhooks: required: - id - node_id - organization: &749 + organization: &750 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -112802,13 +115805,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &750 + repository: &751 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &782 + properties: &783 id: description: Unique identifier of the repository example: 42 @@ -113503,7 +116506,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &783 + required: &784 - archive_url - assignees_url - blobs_url @@ -113654,10 +116657,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -113733,11 +116736,11 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - rule: &751 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 + rule: &752 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) @@ -113960,11 +116963,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - rule: *751 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 + rule: *752 sender: *4 required: - action @@ -114147,11 +117150,11 @@ x-webhooks: - everyone required: - from - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - rule: *751 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 + rule: *752 sender: *4 required: - action @@ -114235,7 +117238,7 @@ x-webhooks: type: string enum: - completed - check_run: &753 + check_run: &754 title: CheckRun description: A check performed on the code of a given code change type: object @@ -114326,7 +117329,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *752 + deployment: *753 details_url: example: https://example.com type: string @@ -114411,10 +117414,10 @@ x-webhooks: - output - app - pull_requests - installation: *748 - enterprise: *747 - organization: *749 - repository: *750 + installation: *749 + enterprise: *748 + organization: *750 + repository: *751 sender: *4 required: - check_run @@ -114805,11 +117808,11 @@ x-webhooks: type: string enum: - created - check_run: *753 - installation: *748 - enterprise: *747 - organization: *749 - repository: *750 + check_run: *754 + installation: *749 + enterprise: *748 + organization: *750 + repository: *751 sender: *4 required: - check_run @@ -115203,11 +118206,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *753 - installation: *748 - enterprise: *747 - organization: *749 - repository: *750 + check_run: *754 + installation: *749 + enterprise: *748 + organization: *750 + repository: *751 requested_action: description: The action requested by the user. type: object @@ -115610,11 +118613,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *753 - installation: *748 - enterprise: *747 - organization: *749 - repository: *750 + check_run: *754 + installation: *749 + enterprise: *748 + organization: *750 + repository: *751 sender: *4 required: - check_run @@ -116584,10 +119587,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -117276,10 +120279,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -117962,10 +120965,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -118276,20 +121279,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &754 + commit_oid: &755 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: *747 - installation: *748 - organization: *749 - ref: &755 + enterprise: *748 + installation: *749 + organization: *750 + ref: &756 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: *750 + repository: *751 sender: *4 required: - action @@ -118684,12 +121687,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *754 - enterprise: *747 - installation: *748 - organization: *749 - ref: *755 - repository: *750 + commit_oid: *755 + enterprise: *748 + installation: *749 + organization: *750 + ref: *756 + repository: *751 sender: *4 required: - action @@ -118955,12 +121958,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *754 - enterprise: *747 - installation: *748 - organization: *749 - ref: *755 - repository: *750 + commit_oid: *755 + enterprise: *748 + installation: *749 + organization: *750 + ref: *756 + repository: *751 sender: *4 required: - action @@ -119292,12 +122295,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *754 - enterprise: *747 - installation: *748 - organization: *749 - ref: *755 - repository: *750 + commit_oid: *755 + enterprise: *748 + installation: *749 + organization: *750 + ref: *756 + repository: *751 sender: *4 required: - action @@ -119571,16 +122574,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 ref: 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 nullable: true - repository: *750 + repository: *751 sender: *4 required: - action @@ -119817,12 +122820,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *754 - enterprise: *747 - installation: *748 - organization: *749 - ref: *755 - repository: *750 + commit_oid: *755 + enterprise: *748 + installation: *749 + organization: *750 + ref: *756 + repository: *751 sender: *4 required: - action @@ -120133,10 +123136,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -120391,10 +123394,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -120474,18 +123477,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *749 - pusher_type: &756 + organization: *750 + pusher_type: &757 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &757 + ref: &758 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -120495,7 +123498,7 @@ x-webhooks: enum: - tag - branch - repository: *750 + repository: *751 sender: *4 required: - ref @@ -120578,9 +123581,9 @@ x-webhooks: enum: - created definition: *296 - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 sender: *4 required: - action @@ -120665,9 +123668,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 sender: *4 required: - action @@ -120745,9 +123748,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *296 - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 sender: *4 required: - action @@ -120825,9 +123828,9 @@ x-webhooks: enum: - updated definition: *296 - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 sender: *4 required: - action @@ -120904,10 +123907,10 @@ x-webhooks: type: string enum: - updated - enterprise: *747 - installation: *748 - repository: *750 - organization: *749 + enterprise: *748 + installation: *749 + repository: *751 + organization: *750 sender: *4 new_property_values: type: array @@ -120992,18 +123995,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *747 - installation: *748 - organization: *749 - pusher_type: *756 - ref: *757 + enterprise: *748 + installation: *749 + organization: *750 + pusher_type: *757 + ref: *758 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *750 + repository: *751 sender: *4 required: - ref @@ -121084,10 +124087,10 @@ x-webhooks: enum: - assignees_changed alert: *505 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + installation: *749 + organization: *750 + enterprise: *748 + repository: *751 sender: *4 required: - action @@ -121168,10 +124171,10 @@ x-webhooks: enum: - auto_dismissed alert: *505 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + installation: *749 + organization: *750 + enterprise: *748 + repository: *751 sender: *4 required: - action @@ -121253,10 +124256,10 @@ x-webhooks: enum: - auto_reopened alert: *505 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + installation: *749 + organization: *750 + enterprise: *748 + repository: *751 sender: *4 required: - action @@ -121338,10 +124341,10 @@ x-webhooks: enum: - created alert: *505 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + installation: *749 + organization: *750 + enterprise: *748 + repository: *751 sender: *4 required: - action @@ -121421,10 +124424,10 @@ x-webhooks: enum: - dismissed alert: *505 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + installation: *749 + organization: *750 + enterprise: *748 + repository: *751 sender: *4 required: - action @@ -121504,10 +124507,10 @@ x-webhooks: enum: - fixed alert: *505 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + installation: *749 + organization: *750 + enterprise: *748 + repository: *751 sender: *4 required: - action @@ -121588,10 +124591,10 @@ x-webhooks: enum: - reintroduced alert: *505 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + installation: *749 + organization: *750 + enterprise: *748 + repository: *751 sender: *4 required: - action @@ -121671,10 +124674,10 @@ x-webhooks: enum: - reopened alert: *505 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + installation: *749 + organization: *750 + enterprise: *748 + repository: *751 sender: *4 required: - action @@ -121751,9 +124754,9 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - key: &758 + enterprise: *748 + installation: *749 + key: &759 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -121789,8 +124792,8 @@ x-webhooks: - verified - created_at - read_only - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -121867,11 +124870,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - key: *758 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + key: *759 + organization: *750 + repository: *751 sender: *4 required: - action @@ -122427,12 +125430,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - workflow: &764 + workflow: &765 title: Workflow type: object nullable: true @@ -123173,15 +126176,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *759 - required: *760 + properties: *760 + required: *761 nullable: true pull_requests: type: array items: *602 - repository: *750 - organization: *749 - installation: *748 + repository: *751 + organization: *750 + installation: *749 sender: *4 responses: '200': @@ -123252,7 +126255,7 @@ x-webhooks: type: string enum: - approved - approver: &761 + approver: &762 type: object properties: avatar_url: @@ -123295,11 +126298,11 @@ x-webhooks: type: string comment: type: string - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - reviewers: &762 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 + reviewers: &763 type: array items: type: object @@ -123378,7 +126381,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &763 + workflow_job_run: &764 type: object properties: conclusion: @@ -124109,18 +127112,18 @@ x-webhooks: type: string enum: - rejected - approver: *761 + approver: *762 comment: type: string - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - reviewers: *762 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 + reviewers: *763 sender: *4 since: type: string - workflow_job_run: *763 + workflow_job_run: *764 workflow_job_runs: type: array items: @@ -124824,13 +127827,13 @@ x-webhooks: type: string enum: - requested - enterprise: *747 + enterprise: *748 environment: type: string - installation: *748 - organization: *749 - repository: *750 - requestor: &769 + installation: *749 + organization: *750 + repository: *751 + requestor: &770 title: User type: object nullable: true @@ -126719,12 +129722,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - workflow: *764 + workflow: *765 workflow_run: title: Deployment Workflow Run type: object @@ -127404,7 +130407,7 @@ x-webhooks: type: string enum: - answered - answer: &767 + answer: &768 type: object properties: author_association: @@ -127561,11 +130564,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -127692,11 +130695,11 @@ x-webhooks: - from required: - category - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -127779,11 +130782,11 @@ x-webhooks: type: string enum: - closed - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -127865,7 +130868,7 @@ x-webhooks: type: string enum: - created - comment: &766 + comment: &767 type: object properties: author_association: @@ -128022,11 +131025,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128109,12 +131112,12 @@ x-webhooks: type: string enum: - deleted - comment: *766 - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + comment: *767 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128209,12 +131212,12 @@ x-webhooks: - from required: - body - comment: *766 - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + comment: *767 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128298,11 +131301,11 @@ x-webhooks: type: string enum: - created - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128384,11 +131387,11 @@ x-webhooks: type: string enum: - deleted - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128488,11 +131491,11 @@ x-webhooks: type: string required: - from - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128574,10 +131577,10 @@ x-webhooks: type: string enum: - labeled - discussion: *765 - enterprise: *747 - installation: *748 - label: &768 + discussion: *766 + enterprise: *748 + installation: *749 + label: &769 title: Label type: object properties: @@ -128609,8 +131612,8 @@ x-webhooks: - color - default - description - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128693,11 +131696,11 @@ x-webhooks: type: string enum: - locked - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128779,11 +131782,11 @@ x-webhooks: type: string enum: - pinned - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128865,11 +131868,11 @@ x-webhooks: type: string enum: - reopened - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128954,16 +131957,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *765 - new_repository: *750 + new_discussion: *766 + new_repository: *751 required: - new_discussion - new_repository - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -129046,10 +132049,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *765 - old_answer: *767 - organization: *749 - repository: *750 + discussion: *766 + old_answer: *768 + organization: *750 + repository: *751 sender: *4 required: - action @@ -129131,12 +132134,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *765 - enterprise: *747 - installation: *748 - label: *768 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + label: *769 + organization: *750 + repository: *751 sender: *4 required: - action @@ -129219,11 +132222,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -129305,11 +132308,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -129382,7 +132385,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *747 + enterprise: *748 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -130042,9 +133045,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - forkee @@ -130190,9 +133193,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 pages: description: The pages that were updated. type: array @@ -130229,7 +133232,7 @@ x-webhooks: - action - sha - html_url - repository: *750 + repository: *751 sender: *4 required: - pages @@ -130305,10 +133308,10 @@ x-webhooks: type: string enum: - created - enterprise: *747 + enterprise: *748 installation: *22 - organization: *749 - repositories: &770 + organization: *750 + repositories: &771 description: An array of repository objects that the installation can access. type: array @@ -130334,8 +133337,8 @@ x-webhooks: - name - full_name - private - repository: *750 - requester: *769 + repository: *751 + requester: *770 sender: *4 required: - action @@ -130410,11 +133413,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 + enterprise: *748 installation: *22 - organization: *749 - repositories: *770 - repository: *750 + organization: *750 + repositories: *771 + repository: *751 requester: nullable: true sender: *4 @@ -130490,11 +133493,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *747 + enterprise: *748 installation: *22 - organization: *749 - repositories: *770 - repository: *750 + organization: *750 + repositories: *771 + repository: *751 requester: nullable: true sender: *4 @@ -130570,10 +133573,10 @@ x-webhooks: type: string enum: - added - enterprise: *747 + enterprise: *748 installation: *22 - organization: *749 - repositories_added: &771 + organization: *750 + repositories_added: &772 description: An array of repository objects, which were added to the installation. type: array @@ -130619,15 +133622,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *750 - repository_selection: &772 + repository: *751 + repository_selection: &773 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *769 + requester: *770 sender: *4 required: - action @@ -130706,10 +133709,10 @@ x-webhooks: type: string enum: - removed - enterprise: *747 + enterprise: *748 installation: *22 - organization: *749 - repositories_added: *771 + organization: *750 + repositories_added: *772 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -130736,9 +133739,9 @@ x-webhooks: - name - full_name - private - repository: *750 - repository_selection: *772 - requester: *769 + repository: *751 + repository_selection: *773 + requester: *770 sender: *4 required: - action @@ -130817,11 +133820,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *747 + enterprise: *748 installation: *22 - organization: *749 - repositories: *770 - repository: *750 + organization: *750 + repositories: *771 + repository: *751 requester: nullable: true sender: *4 @@ -130999,10 +134002,10 @@ x-webhooks: type: string required: - from - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 target_type: type: string @@ -131081,11 +134084,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *747 + enterprise: *748 installation: *22 - organization: *749 - repositories: *770 - repository: *750 + organization: *750 + repositories: *771 + repository: *751 requester: nullable: true sender: *4 @@ -131345,8 +134348,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -132135,8 +135138,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132485,8 +135488,8 @@ x-webhooks: - state - locked - assignee - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -132566,7 +135569,7 @@ x-webhooks: type: string enum: - deleted - comment: &773 + comment: &774 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -132739,8 +135742,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -133525,8 +136528,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133877,8 +136880,8 @@ x-webhooks: - state - locked - assignee - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -133958,7 +136961,7 @@ x-webhooks: type: string enum: - edited - changes: &802 + changes: &803 description: The changes to the comment. type: object properties: @@ -133970,9 +136973,9 @@ x-webhooks: type: string required: - from - comment: *773 - enterprise: *747 - installation: *748 + comment: *774 + enterprise: *748 + installation: *749 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -134760,8 +137763,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135110,8 +138113,8 @@ x-webhooks: - state - locked - assignee - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -135192,9 +138195,9 @@ x-webhooks: type: string enum: - pinned - comment: *773 - enterprise: *747 - installation: *748 + comment: *774 + enterprise: *748 + installation: *749 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -135984,8 +138987,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136336,8 +139339,8 @@ x-webhooks: - state - locked - assignee - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -136417,9 +139420,9 @@ x-webhooks: type: string enum: - unpinned - comment: *773 - enterprise: *747 - installation: *748 + comment: *774 + enterprise: *748 + installation: *749 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -137209,8 +140212,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137561,8 +140564,8 @@ x-webhooks: - state - locked - assignee - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -137651,9 +140654,9 @@ x-webhooks: type: number blocking_issue: *88 blocking_issue_repo: *82 - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -137742,9 +140745,9 @@ x-webhooks: type: number blocking_issue: *88 blocking_issue_repo: *82 - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -137832,9 +140835,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *88 - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -137923,9 +140926,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *88 - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -138005,10 +141008,10 @@ x-webhooks: type: string enum: - assigned - assignee: *769 - enterprise: *747 - installation: *748 - issue: &774 + assignee: *770 + enterprise: *748 + installation: *749 + issue: &775 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -138800,8 +141803,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -138921,8 +141924,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -139002,8 +142005,8 @@ x-webhooks: type: string enum: - closed - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -139800,8 +142803,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -140056,8 +143059,8 @@ x-webhooks: required: - state - closed_at - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -140136,8 +143139,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -140925,8 +143928,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -141045,8 +144048,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -141125,8 +144128,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141936,8 +144939,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -142035,7 +145038,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &775 + milestone: &776 title: Milestone description: A collection of related issues and pull requests. type: object @@ -142173,8 +145176,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -142273,8 +145276,8 @@ x-webhooks: type: string required: - from - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -143066,8 +146069,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -143187,9 +146190,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *768 - organization: *749 - repository: *750 + label: *769 + organization: *750 + repository: *751 sender: *4 required: - action @@ -143269,9 +146272,9 @@ x-webhooks: type: string enum: - field_added - enterprise: *747 - installation: *748 - issue: *774 + enterprise: *748 + installation: *749 + issue: *775 issue_field: type: object description: The issue field whose value was set or updated on the @@ -143380,8 +146383,8 @@ x-webhooks: - id required: - from - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -143461,9 +146464,9 @@ x-webhooks: type: string enum: - field_removed - enterprise: *747 - installation: *748 - issue: *774 + enterprise: *748 + installation: *749 + issue: *775 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -143521,8 +146524,8 @@ x-webhooks: nullable: true required: - id - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -143602,8 +146605,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144394,8 +147397,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -144515,9 +147518,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *768 - organization: *749 - repository: *750 + label: *769 + organization: *750 + repository: *751 sender: *4 required: - action @@ -144597,8 +147600,8 @@ x-webhooks: type: string enum: - locked - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -145413,8 +148416,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -145511,8 +148514,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -145591,8 +148594,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -146401,8 +149404,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -146499,9 +149502,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *775 - organization: *749 - repository: *750 + milestone: *776 + organization: *750 + repository: *751 sender: *4 required: - action @@ -147364,8 +150367,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -147949,8 +150952,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -148734,8 +151737,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -148862,8 +151865,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -148943,9 +151946,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *747 - installation: *748 - issue: &776 + enterprise: *748 + installation: *749 + issue: &777 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -149731,8 +152734,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -149851,8 +152854,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -149931,8 +152934,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -150745,8 +153748,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -150844,8 +153847,8 @@ x-webhooks: user_view_type: type: string type: *248 - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -151714,8 +154717,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -152313,11 +155316,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *747 - installation: *748 - issue: *776 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + issue: *777 + organization: *750 + repository: *751 sender: *4 required: - action @@ -152397,12 +155400,12 @@ x-webhooks: type: string enum: - typed - enterprise: *747 - installation: *748 - issue: *774 + enterprise: *748 + installation: *749 + issue: *775 type: *248 - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -152483,7 +155486,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &805 + assignee: &806 title: User type: object nullable: true @@ -152553,11 +155556,11 @@ x-webhooks: required: - login - id - enterprise: *747 - installation: *748 - issue: *774 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + issue: *775 + organization: *750 + repository: *751 sender: *4 required: - action @@ -152636,12 +155639,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *747 - installation: *748 - issue: *774 - label: *768 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + issue: *775 + label: *769 + organization: *750 + repository: *751 sender: *4 required: - action @@ -152721,8 +155724,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -153535,8 +156538,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -153633,8 +156636,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -153714,11 +156717,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *747 - installation: *748 - issue: *776 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + issue: *777 + organization: *750 + repository: *751 sender: *4 required: - action @@ -153797,12 +156800,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *747 - installation: *748 - issue: *774 + enterprise: *748 + installation: *749 + issue: *775 type: *248 - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -153882,11 +156885,11 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - label: *768 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + label: *769 + organization: *750 + repository: *751 sender: *4 required: - action @@ -153964,11 +156967,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - label: *768 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + label: *769 + organization: *750 + repository: *751 sender: *4 required: - action @@ -154078,11 +157081,11 @@ x-webhooks: type: string required: - from - enterprise: *747 - installation: *748 - label: *768 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + label: *769 + organization: *750 + repository: *751 sender: *4 required: - action @@ -154164,9 +157167,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *747 - installation: *748 - marketplace_purchase: &777 + enterprise: *748 + installation: *749 + marketplace_purchase: &778 title: Marketplace Purchase type: object required: @@ -154249,8 +157252,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *749 - previous_marketplace_purchase: &778 + organization: *750 + previous_marketplace_purchase: &779 title: Marketplace Purchase type: object properties: @@ -154330,7 +157333,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *750 + repository: *751 sender: *4 required: - action @@ -154410,10 +157413,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *747 - installation: *748 - marketplace_purchase: *777 - organization: *749 + enterprise: *748 + installation: *749 + marketplace_purchase: *778 + organization: *750 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -154496,7 +157499,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *750 + repository: *751 sender: *4 required: - action @@ -154578,10 +157581,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *747 - installation: *748 - marketplace_purchase: *777 - organization: *749 + enterprise: *748 + installation: *749 + marketplace_purchase: *778 + organization: *750 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -154663,7 +157666,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *750 + repository: *751 sender: *4 required: - action @@ -154744,8 +157747,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 marketplace_purchase: title: Marketplace Purchase type: object @@ -154827,9 +157830,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *749 - previous_marketplace_purchase: *778 - repository: *750 + organization: *750 + previous_marketplace_purchase: *779 + repository: *751 sender: *4 required: - action @@ -154909,12 +157912,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *747 - installation: *748 - marketplace_purchase: *777 - organization: *749 - previous_marketplace_purchase: *778 - repository: *750 + enterprise: *748 + installation: *749 + marketplace_purchase: *778 + organization: *750 + previous_marketplace_purchase: *779 + repository: *751 sender: *4 required: - action @@ -155016,11 +158019,11 @@ x-webhooks: type: string required: - to - enterprise: *747 - installation: *748 - member: *769 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + member: *770 + organization: *750 + repository: *751 sender: *4 required: - action @@ -155120,11 +158123,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *747 - installation: *748 - member: *769 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + member: *770 + organization: *750 + repository: *751 sender: *4 required: - action @@ -155203,11 +158206,11 @@ x-webhooks: type: string enum: - removed - enterprise: *747 - installation: *748 - member: *769 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + member: *770 + organization: *750 + repository: *751 sender: *4 required: - action @@ -155285,11 +158288,11 @@ x-webhooks: type: string enum: - added - enterprise: *747 - installation: *748 - member: *769 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + member: *770 + organization: *750 + repository: *751 scope: description: The scope of the membership. Currently, can only be `team`. @@ -155365,7 +158368,7 @@ x-webhooks: required: - login - id - team: &779 + team: &780 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -155588,11 +158591,11 @@ x-webhooks: type: string enum: - removed - enterprise: *747 - installation: *748 - member: *769 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + member: *770 + organization: *750 + repository: *751 scope: description: The scope of the membership. Currently, can only be `team`. @@ -155669,7 +158672,7 @@ x-webhooks: required: - login - id - team: *779 + team: *780 required: - action - scope @@ -155751,8 +158754,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *748 - merge_group: &781 + installation: *749 + merge_group: &782 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -155771,15 +158774,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *780 + head_commit: *781 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -155865,10 +158868,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *748 - merge_group: *781 - organization: *749 - repository: *750 + installation: *749 + merge_group: *782 + organization: *750 + repository: *751 sender: *4 required: - action @@ -155941,7 +158944,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 + enterprise: *748 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -156050,16 +159053,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *748 - organization: *749 + installation: *749 + organization: *750 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *782 - required: *783 + properties: *783 + required: *784 nullable: true sender: *4 required: @@ -156140,11 +159143,11 @@ x-webhooks: type: string enum: - closed - enterprise: *747 - installation: *748 - milestone: *775 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + milestone: *776 + organization: *750 + repository: *751 sender: *4 required: - action @@ -156223,9 +159226,9 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - milestone: &784 + enterprise: *748 + installation: *749 + milestone: &785 title: Milestone description: A collection of related issues and pull requests. type: object @@ -156362,8 +159365,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -156442,11 +159445,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - milestone: *775 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + milestone: *776 + organization: *750 + repository: *751 sender: *4 required: - action @@ -156556,11 +159559,11 @@ x-webhooks: type: string required: - from - enterprise: *747 - installation: *748 - milestone: *775 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + milestone: *776 + organization: *750 + repository: *751 sender: *4 required: - action @@ -156640,11 +159643,11 @@ x-webhooks: type: string enum: - opened - enterprise: *747 - installation: *748 - milestone: *784 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + milestone: *785 + organization: *750 + repository: *751 sender: *4 required: - action @@ -156723,11 +159726,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *769 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + blocked_user: *770 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -156806,11 +159809,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *769 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + blocked_user: *770 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -156889,9 +159892,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - membership: &785 + enterprise: *748 + installation: *749 + membership: &786 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -156998,8 +160001,8 @@ x-webhooks: - role - organization_url - user - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -157077,11 +160080,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *747 - installation: *748 - membership: *785 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + membership: *786 + organization: *750 + repository: *751 sender: *4 required: - action @@ -157160,8 +160163,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -157277,10 +160280,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 - user: *769 + user: *770 required: - action - invitation @@ -157358,11 +160361,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *747 - installation: *748 - membership: *785 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + membership: *786 + organization: *750 + repository: *751 sender: *4 required: - action @@ -157449,11 +160452,11 @@ x-webhooks: properties: from: type: string - enterprise: *747 - installation: *748 - membership: *785 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + membership: *786 + organization: *750 + repository: *751 sender: *4 required: - action @@ -157530,9 +160533,9 @@ x-webhooks: type: string enum: - published - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 package: description: Information about the package. type: object @@ -158031,7 +161034,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &786 + items: &787 title: Ruby Gems metadata type: object properties: @@ -158126,7 +161129,7 @@ x-webhooks: - owner - package_version - registry - repository: *750 + repository: *751 sender: *4 required: - action @@ -158202,9 +161205,9 @@ x-webhooks: type: string enum: - updated - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 package: description: Information about the package. type: object @@ -158557,7 +161560,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *786 + items: *787 source_url: type: string format: uri @@ -158627,7 +161630,7 @@ x-webhooks: - owner - package_version - registry - repository: *750 + repository: *751 sender: *4 required: - action @@ -158803,12 +161806,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *747 + enterprise: *748 id: type: integer - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - id @@ -158885,7 +161888,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &787 + personal_access_token_request: &788 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -159031,10 +162034,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *747 - organization: *749 + enterprise: *748 + organization: *750 sender: *4 - installation: *748 + installation: *749 required: - action - personal_access_token_request @@ -159111,11 +162114,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *787 - enterprise: *747 - organization: *749 + personal_access_token_request: *788 + enterprise: *748 + organization: *750 sender: *4 - installation: *748 + installation: *749 required: - action - personal_access_token_request @@ -159191,11 +162194,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *787 - enterprise: *747 - organization: *749 + personal_access_token_request: *788 + enterprise: *748 + organization: *750 sender: *4 - installation: *748 + installation: *749 required: - action - personal_access_token_request @@ -159270,11 +162273,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *787 - organization: *749 - enterprise: *747 + personal_access_token_request: *788 + organization: *750 + enterprise: *748 sender: *4 - installation: *748 + installation: *749 required: - action - personal_access_token_request @@ -159379,7 +162382,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *788 + last_response: *789 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -159411,8 +162414,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 zen: description: Random string of GitHub zen. @@ -159657,10 +162660,10 @@ x-webhooks: - from required: - note - enterprise: *747 - installation: *748 - organization: *749 - project_card: &789 + enterprise: *748 + installation: *749 + organization: *750 + project_card: &790 title: Project Card type: object properties: @@ -159779,7 +162782,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *750 + repository: *751 sender: *4 required: - action @@ -159860,11 +162863,11 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - project_card: *789 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + project_card: *790 + repository: *751 sender: *4 required: - action @@ -159944,9 +162947,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 project_card: title: Project Card type: object @@ -160074,8 +163077,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *782 - required: *783 + properties: *783 + required: *784 nullable: true sender: *4 required: @@ -160169,11 +163172,11 @@ x-webhooks: - from required: - note - enterprise: *747 - installation: *748 - organization: *749 - project_card: *789 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + project_card: *790 + repository: *751 sender: *4 required: - action @@ -160267,9 +163270,9 @@ x-webhooks: - from required: - column_id - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 project_card: allOf: - title: Project Card @@ -160459,7 +163462,7 @@ x-webhooks: type: string required: - after_id - repository: *750 + repository: *751 sender: *4 required: - action @@ -160539,10 +163542,10 @@ x-webhooks: type: string enum: - closed - enterprise: *747 - installation: *748 - organization: *749 - project: &791 + enterprise: *748 + installation: *749 + organization: *750 + project: &792 title: Project type: object properties: @@ -160666,7 +163669,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *750 + repository: *751 sender: *4 required: - action @@ -160746,10 +163749,10 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - project_column: &790 + enterprise: *748 + installation: *749 + organization: *750 + project_column: &791 title: Project Column type: object properties: @@ -160788,7 +163791,7 @@ x-webhooks: - name - created_at - updated_at - repository: *750 + repository: *751 sender: *4 required: - action @@ -160867,18 +163870,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - project_column: *790 + enterprise: *748 + installation: *749 + organization: *750 + project_column: *791 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *782 - required: *783 + properties: *783 + required: *784 nullable: true sender: *4 required: @@ -160968,11 +163971,11 @@ x-webhooks: type: string required: - from - enterprise: *747 - installation: *748 - organization: *749 - project_column: *790 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + project_column: *791 + repository: *751 sender: *4 required: - action @@ -161052,11 +164055,11 @@ x-webhooks: type: string enum: - moved - enterprise: *747 - installation: *748 - organization: *749 - project_column: *790 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + project_column: *791 + repository: *751 sender: *4 required: - action @@ -161136,11 +164139,11 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - project: *791 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + project: *792 + repository: *751 sender: *4 required: - action @@ -161220,18 +164223,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - project: *791 + enterprise: *748 + installation: *749 + organization: *750 + project: *792 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *782 - required: *783 + properties: *783 + required: *784 nullable: true sender: *4 required: @@ -161333,11 +164336,11 @@ x-webhooks: type: string required: - from - enterprise: *747 - installation: *748 - organization: *749 - project: *791 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + project: *792 + repository: *751 sender: *4 required: - action @@ -161416,11 +164419,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *747 - installation: *748 - organization: *749 - project: *791 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + project: *792 + repository: *751 sender: *4 required: - action @@ -161501,8 +164504,8 @@ x-webhooks: type: string enum: - closed - installation: *748 - organization: *749 + installation: *749 + organization: *750 projects_v2: *282 sender: *4 required: @@ -161584,8 +164587,8 @@ x-webhooks: type: string enum: - created - installation: *748 - organization: *749 + installation: *749 + organization: *750 projects_v2: *282 sender: *4 required: @@ -161667,8 +164670,8 @@ x-webhooks: type: string enum: - deleted - installation: *748 - organization: *749 + installation: *749 + organization: *750 projects_v2: *282 sender: *4 required: @@ -161786,8 +164789,8 @@ x-webhooks: type: string to: type: string - installation: *748 - organization: *749 + installation: *749 + organization: *750 projects_v2: *282 sender: *4 required: @@ -161871,7 +164874,7 @@ x-webhooks: type: string enum: - archived - changes: &795 + changes: &796 type: object properties: archived_at: @@ -161885,9 +164888,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *748 - organization: *749 - projects_v2_item: &792 + installation: *749 + organization: *750 + projects_v2_item: &793 title: Projects v2 Item description: An item belonging to a project type: object @@ -162022,9 +165025,9 @@ x-webhooks: nullable: true to: type: string - installation: *748 - organization: *749 - projects_v2_item: *792 + installation: *749 + organization: *750 + projects_v2_item: *793 sender: *4 required: - action @@ -162106,9 +165109,9 @@ x-webhooks: type: string enum: - created - installation: *748 - organization: *749 - projects_v2_item: *792 + installation: *749 + organization: *750 + projects_v2_item: *793 sender: *4 required: - action @@ -162189,9 +165192,9 @@ x-webhooks: type: string enum: - deleted - installation: *748 - organization: *749 - projects_v2_item: *792 + installation: *749 + organization: *750 + projects_v2_item: *793 sender: *4 required: - action @@ -162297,7 +165300,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &793 + - &794 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -162319,7 +165322,7 @@ x-webhooks: required: - id - name - - &794 + - &795 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -162353,8 +165356,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *793 - *794 + - *795 required: - field_value - type: object @@ -162370,9 +165373,9 @@ x-webhooks: nullable: true required: - body - installation: *748 - organization: *749 - projects_v2_item: *792 + installation: *749 + organization: *750 + projects_v2_item: *793 sender: *4 required: - action @@ -162467,9 +165470,9 @@ x-webhooks: to: type: string nullable: true - installation: *748 - organization: *749 - projects_v2_item: *792 + installation: *749 + organization: *750 + projects_v2_item: *793 sender: *4 required: - action @@ -162552,10 +165555,10 @@ x-webhooks: type: string enum: - restored - changes: *795 - installation: *748 - organization: *749 - projects_v2_item: *792 + changes: *796 + installation: *749 + organization: *750 + projects_v2_item: *793 sender: *4 required: - action @@ -162637,8 +165640,8 @@ x-webhooks: type: string enum: - reopened - installation: *748 - organization: *749 + installation: *749 + organization: *750 projects_v2: *282 sender: *4 required: @@ -162720,14 +165723,14 @@ x-webhooks: type: string enum: - created - installation: *748 - organization: *749 - projects_v2_status_update: &798 + installation: *749 + organization: *750 + projects_v2_status_update: &799 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *796 - required: *797 + properties: *797 + required: *798 sender: *4 required: - action @@ -162808,9 +165811,9 @@ x-webhooks: type: string enum: - deleted - installation: *748 - organization: *749 - projects_v2_status_update: *798 + installation: *749 + organization: *750 + projects_v2_status_update: *799 sender: *4 required: - action @@ -162946,9 +165949,9 @@ x-webhooks: type: string format: date nullable: true - installation: *748 - organization: *749 - projects_v2_status_update: *798 + installation: *749 + organization: *750 + projects_v2_status_update: *799 sender: *4 required: - action @@ -163019,10 +166022,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - repository @@ -163099,13 +166102,13 @@ x-webhooks: type: string enum: - assigned - assignee: *769 - enterprise: *747 - installation: *748 - number: &799 + assignee: *770 + enterprise: *748 + installation: *749 + number: &800 description: The pull request number. type: integer - organization: *749 + organization: *750 pull_request: title: Pull Request type: object @@ -165410,7 +168413,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 sender: *4 required: - action @@ -165492,11 +168495,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 number: type: integer - organization: *749 + organization: *750 pull_request: title: Pull Request type: object @@ -167796,7 +170799,7 @@ x-webhooks: - draft reason: type: string - repository: *750 + repository: *751 sender: *4 required: - action @@ -167878,11 +170881,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 number: type: integer - organization: *749 + organization: *750 pull_request: title: Pull Request type: object @@ -170182,7 +173185,7 @@ x-webhooks: - draft reason: type: string - repository: *750 + repository: *751 sender: *4 required: - action @@ -170264,11 +173267,11 @@ x-webhooks: type: string enum: - closed - enterprise: *747 - installation: *748 - number: *799 - organization: *749 - pull_request: &800 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 + pull_request: &801 allOf: - *602 - type: object @@ -170332,7 +173335,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *750 + repository: *751 sender: *4 required: - action @@ -170413,12 +173416,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *747 - installation: *748 - number: *799 - organization: *749 - pull_request: *800 - repository: *750 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 + pull_request: *801 + repository: *751 sender: *4 required: - action @@ -170498,11 +173501,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *747 + enterprise: *748 milestone: *586 - number: *799 - organization: *749 - pull_request: &801 + number: *800 + organization: *750 + pull_request: &802 title: Pull Request type: object properties: @@ -172787,7 +175790,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 sender: *4 required: - action @@ -172866,11 +175869,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 number: type: integer - organization: *749 + organization: *750 pull_request: title: Pull Request type: object @@ -175174,7 +178177,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *750 + repository: *751 sender: *4 required: - action @@ -175298,12 +178301,12 @@ x-webhooks: type: string required: - from - enterprise: *747 - installation: *748 - number: *799 - organization: *749 - pull_request: *800 - repository: *750 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 + pull_request: *801 + repository: *751 sender: *4 required: - action @@ -175383,11 +178386,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 number: type: integer - organization: *749 + organization: *750 pull_request: title: Pull Request type: object @@ -177676,7 +180679,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 sender: *4 required: - action @@ -177756,11 +180759,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *747 - installation: *748 - label: *768 - number: *799 - organization: *749 + enterprise: *748 + installation: *749 + label: *769 + number: *800 + organization: *750 pull_request: title: Pull Request type: object @@ -180064,7 +183067,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 sender: *4 required: - action @@ -180145,10 +183148,10 @@ x-webhooks: type: string enum: - locked - enterprise: *747 - installation: *748 - number: *799 - organization: *749 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 pull_request: title: Pull Request type: object @@ -182450,7 +185453,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 sender: *4 required: - action @@ -182530,12 +185533,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *747 + enterprise: *748 milestone: *586 - number: *799 - organization: *749 - pull_request: *801 - repository: *750 + number: *800 + organization: *750 + pull_request: *802 + repository: *751 sender: *4 required: - action @@ -182614,12 +185617,12 @@ x-webhooks: type: string enum: - opened - enterprise: *747 - installation: *748 - number: *799 - organization: *749 - pull_request: *800 - repository: *750 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 + pull_request: *801 + repository: *751 sender: *4 required: - action @@ -182700,12 +185703,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *747 - installation: *748 - number: *799 - organization: *749 - pull_request: *800 - repository: *750 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 + pull_request: *801 + repository: *751 sender: *4 required: - action @@ -182785,12 +185788,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *747 - installation: *748 - number: *799 - organization: *749 - pull_request: *800 - repository: *750 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 + pull_request: *801 + repository: *751 sender: *4 required: - action @@ -183156,9 +186159,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 pull_request: type: object properties: @@ -185350,7 +188353,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *750 + repository: *751 sender: *4 required: - action @@ -185430,7 +188433,7 @@ x-webhooks: type: string enum: - deleted - comment: &803 + comment: &804 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -185715,9 +188718,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 pull_request: type: object properties: @@ -187897,7 +190900,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *750 + repository: *751 sender: *4 required: - action @@ -187977,11 +190980,11 @@ x-webhooks: type: string enum: - edited - changes: *802 - comment: *803 - enterprise: *747 - installation: *748 - organization: *749 + changes: *803 + comment: *804 + enterprise: *748 + installation: *749 + organization: *750 pull_request: type: object properties: @@ -190164,7 +193167,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *750 + repository: *751 sender: *4 required: - action @@ -190245,9 +193248,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 pull_request: title: Simple Pull Request type: object @@ -192442,7 +195445,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *750 + repository: *751 review: description: The review that was affected. type: object @@ -192689,9 +195692,9 @@ x-webhooks: type: string required: - from - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 pull_request: title: Simple Pull Request type: object @@ -194745,8 +197748,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *750 - review: &804 + repository: *751 + review: &805 description: The review that was affected. type: object properties: @@ -194979,12 +197982,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 number: description: The pull request number. type: integer - organization: *749 + organization: *750 pull_request: title: Pull Request type: object @@ -197289,7 +200292,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 requested_reviewer: title: User type: object @@ -197373,12 +200376,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 number: description: The pull request number. type: integer - organization: *749 + organization: *750 pull_request: title: Pull Request type: object @@ -199690,7 +202693,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 requested_team: title: Team description: Groups of organization members that gives permissions @@ -199882,12 +202885,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 number: description: The pull request number. type: integer - organization: *749 + organization: *750 pull_request: title: Pull Request type: object @@ -202194,7 +205197,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 requested_reviewer: title: User type: object @@ -202279,12 +205282,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 number: description: The pull request number. type: integer - organization: *749 + organization: *750 pull_request: title: Pull Request type: object @@ -204582,7 +207585,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 requested_team: title: Team description: Groups of organization members that gives permissions @@ -204763,9 +207766,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 pull_request: title: Simple Pull Request type: object @@ -206962,8 +209965,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *750 - review: *804 + repository: *751 + review: *805 sender: *4 required: - action @@ -207043,9 +210046,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 pull_request: title: Simple Pull Request type: object @@ -209137,7 +212140,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *750 + repository: *751 sender: *4 thread: type: object @@ -209524,9 +212527,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 pull_request: title: Simple Pull Request type: object @@ -211604,7 +214607,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *750 + repository: *751 sender: *4 thread: type: object @@ -211994,10 +214997,10 @@ x-webhooks: type: string before: type: string - enterprise: *747 - installation: *748 - number: *799 - organization: *749 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 pull_request: title: Pull Request type: object @@ -214290,7 +217293,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 sender: *4 required: - action @@ -214372,11 +217375,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *805 - enterprise: *747 - installation: *748 - number: *799 - organization: *749 + assignee: *806 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 pull_request: title: Pull Request type: object @@ -216681,7 +219684,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 sender: *4 required: - action @@ -216760,11 +219763,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *747 - installation: *748 - label: *768 - number: *799 - organization: *749 + enterprise: *748 + installation: *749 + label: *769 + number: *800 + organization: *750 pull_request: title: Pull Request type: object @@ -219059,7 +222062,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 sender: *4 required: - action @@ -219140,10 +222143,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *747 - installation: *748 - number: *799 - organization: *749 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 pull_request: title: Pull Request type: object @@ -221430,7 +224433,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 sender: *4 required: - action @@ -221630,7 +224633,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *747 + enterprise: *748 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -221722,8 +224725,8 @@ x-webhooks: - url - author - committer - installation: *748 - organization: *749 + installation: *749 + organization: *750 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -222309,9 +225312,9 @@ x-webhooks: type: string enum: - published - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 registry_package: type: object properties: @@ -222757,7 +225760,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *786 + items: *787 summary: type: string tag_name: @@ -222811,7 +225814,7 @@ x-webhooks: - owner - package_version - registry - repository: *750 + repository: *751 sender: *4 required: - action @@ -222889,9 +225892,9 @@ x-webhooks: type: string enum: - updated - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 registry_package: type: object properties: @@ -223199,7 +226202,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *786 + items: *787 summary: type: string tag_name: @@ -223248,7 +226251,7 @@ x-webhooks: - owner - package_version - registry - repository: *750 + repository: *751 sender: *4 required: - action @@ -223325,10 +226328,10 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - release: &806 + enterprise: *748 + installation: *749 + organization: *750 + release: &807 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -223646,7 +226649,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *750 + repository: *751 sender: *4 required: - action @@ -223723,11 +226726,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - release: *806 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + release: *807 + repository: *751 sender: *4 required: - action @@ -223844,11 +226847,11 @@ x-webhooks: type: boolean required: - to - enterprise: *747 - installation: *748 - organization: *749 - release: *806 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + release: *807 + repository: *751 sender: *4 required: - action @@ -223926,9 +226929,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -224250,7 +227253,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *750 + repository: *751 sender: *4 required: - action @@ -224326,10 +227329,10 @@ x-webhooks: type: string enum: - published - enterprise: *747 - installation: *748 - organization: *749 - release: &807 + enterprise: *748 + installation: *749 + organization: *750 + release: &808 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -224648,7 +227651,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *750 + repository: *751 sender: *4 required: - action @@ -224724,11 +227727,11 @@ x-webhooks: type: string enum: - released - enterprise: *747 - installation: *748 - organization: *749 - release: *806 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + release: *807 + repository: *751 sender: *4 required: - action @@ -224804,11 +227807,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *747 - installation: *748 - organization: *749 - release: *807 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + release: *808 + repository: *751 sender: *4 required: - action @@ -224884,11 +227887,11 @@ x-webhooks: type: string enum: - published - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - repository_advisory: *669 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 + repository_advisory: *670 sender: *4 required: - action @@ -224964,11 +227967,11 @@ x-webhooks: type: string enum: - reported - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - repository_advisory: *669 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 + repository_advisory: *670 sender: *4 required: - action @@ -225044,10 +228047,10 @@ x-webhooks: type: string enum: - archived - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -225124,10 +228127,10 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -225205,10 +228208,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -225292,10 +228295,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -225407,10 +228410,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -225482,10 +228485,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 status: type: string @@ -225566,10 +228569,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -225646,10 +228649,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -225743,10 +228746,10 @@ x-webhooks: - name required: - repository - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -225826,10 +228829,10 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 repository_ruleset: *330 sender: *4 required: @@ -225908,10 +228911,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 repository_ruleset: *330 sender: *4 required: @@ -225990,10 +228993,10 @@ x-webhooks: type: string enum: - edited - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 repository_ruleset: *330 changes: type: object @@ -226298,10 +229301,10 @@ x-webhooks: - from required: - owner - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -226379,10 +229382,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -226460,7 +229463,7 @@ x-webhooks: type: string enum: - create - alert: &808 + alert: &809 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -226582,10 +229585,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -226791,10 +229794,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -226872,11 +229875,11 @@ x-webhooks: type: string enum: - reopen - alert: *808 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *809 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -227075,10 +230078,10 @@ x-webhooks: enum: - fixed - open - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -227156,7 +230159,7 @@ x-webhooks: type: string enum: - assigned - alert: &809 + alert: &810 type: object properties: number: *179 @@ -227299,10 +230302,10 @@ x-webhooks: required: *21 nullable: true assignee: *4 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -227380,11 +230383,11 @@ x-webhooks: type: string enum: - created - alert: *809 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *810 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -227465,11 +230468,11 @@ x-webhooks: type: string enum: - created - alert: *809 - installation: *748 - location: *810 - organization: *749 - repository: *750 + alert: *810 + installation: *749 + location: *811 + organization: *750 + repository: *751 sender: *4 required: - location @@ -227707,11 +230710,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *809 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *810 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -227789,11 +230792,11 @@ x-webhooks: type: string enum: - reopened - alert: *809 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *810 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -227871,11 +230874,11 @@ x-webhooks: type: string enum: - resolved - alert: *809 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *810 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -227953,12 +230956,12 @@ x-webhooks: type: string enum: - unassigned - alert: *809 + alert: *810 assignee: *4 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -228036,11 +231039,11 @@ x-webhooks: type: string enum: - validated - alert: *809 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *810 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -228166,10 +231169,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *750 - enterprise: *747 - installation: *748 - organization: *749 + repository: *751 + enterprise: *748 + installation: *749 + organization: *750 sender: *4 required: - action @@ -228247,11 +231250,11 @@ x-webhooks: type: string enum: - published - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - security_advisory: &811 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 + security_advisory: &812 description: The details of the security advisory, including summary, description, and severity. type: object @@ -228434,11 +231437,11 @@ x-webhooks: type: string enum: - updated - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - security_advisory: *811 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 + security_advisory: *812 sender: *4 required: - action @@ -228511,10 +231514,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -228699,9 +231702,9 @@ x-webhooks: type: object properties: security_and_analysis: *303 - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 repository: *351 sender: *4 required: @@ -228780,12 +231783,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - sponsorship: &812 + sponsorship: &813 type: object properties: created_at: @@ -229086,12 +232089,12 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - sponsorship: *812 + sponsorship: *813 required: - action - sponsorship @@ -229179,12 +232182,12 @@ x-webhooks: type: string required: - from - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - sponsorship: *812 + sponsorship: *813 required: - action - changes @@ -229261,17 +232264,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &813 + effective_date: &814 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: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - sponsorship: *812 + sponsorship: *813 required: - action - sponsorship @@ -229345,7 +232348,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &814 + changes: &815 type: object properties: tier: @@ -229389,13 +232392,13 @@ x-webhooks: - from required: - tier - effective_date: *813 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + effective_date: *814 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - sponsorship: *812 + sponsorship: *813 required: - action - changes @@ -229472,13 +232475,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *814 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + changes: *815 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - sponsorship: *812 + sponsorship: *813 required: - action - changes @@ -229552,10 +232555,10 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -229638,10 +232641,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -230061,15 +233064,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *747 + enterprise: *748 id: description: The unique identifier of the status. type: integer - installation: *748 + installation: *749 name: type: string - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 sha: description: The Commit SHA. @@ -230184,9 +233187,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *88 - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -230276,9 +233279,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *88 - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -230368,9 +233371,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *88 - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -230460,9 +233463,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *88 - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -230539,12 +233542,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - team: &815 + team: &816 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -230767,9 +233770,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 repository: title: Repository description: A git repository @@ -231227,7 +234230,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *815 + team: *816 required: - action - team @@ -231303,9 +234306,9 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 repository: title: Repository description: A git repository @@ -231763,7 +234766,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *815 + team: *816 required: - action - team @@ -231840,9 +234843,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 repository: title: Repository description: A git repository @@ -232300,7 +235303,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *815 + team: *816 required: - action - team @@ -232444,9 +235447,9 @@ x-webhooks: - from required: - permissions - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 repository: title: Repository description: A git repository @@ -232904,7 +235907,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *815 + team: *816 required: - action - changes @@ -232982,9 +235985,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 repository: title: Repository description: A git repository @@ -233442,7 +236445,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *815 + team: *816 required: - action - team @@ -233518,10 +236521,10 @@ x-webhooks: type: string enum: - started - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -233594,16 +236597,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *747 + enterprise: *748 inputs: type: object nullable: true additionalProperties: true - installation: *748 - organization: *749 + installation: *749 + organization: *750 ref: type: string - repository: *750 + repository: *751 sender: *4 workflow: type: string @@ -233685,10 +236688,10 @@ x-webhooks: type: string enum: - completed - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 workflow_job: allOf: @@ -234004,10 +237007,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 workflow_job: allOf: @@ -234346,10 +237349,10 @@ x-webhooks: type: string enum: - queued - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 workflow_job: type: object @@ -234563,10 +237566,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 workflow_job: type: object @@ -234782,12 +237785,12 @@ x-webhooks: type: string enum: - completed - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - workflow: *764 + workflow: *765 workflow_run: title: Workflow Run type: object @@ -235786,12 +238789,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - workflow: *764 + workflow: *765 workflow_run: title: Workflow Run type: object @@ -236775,12 +239778,12 @@ x-webhooks: type: string enum: - requested - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - workflow: *764 + workflow: *765 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index 1442e11df..4af1200e6 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -1964,6 +1964,3164 @@ } } }, + "/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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", @@ -89402,7 +92560,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" ], @@ -89461,20 +92619,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, "example": "1.2.3" @@ -164303,7 +167461,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -164384,6 +167543,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" @@ -164528,7 +167695,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" ], @@ -164617,7 +167784,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", @@ -164625,7 +167792,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -164661,7 +167829,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": { @@ -164679,6 +167847,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": [ @@ -164737,6 +167913,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" + } } } } @@ -164786,7 +167973,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -164873,412 +168061,429 @@ "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": { - "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": { - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "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": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "key_id", - "key" - ], - "properties": { - "key_id": { - "description": "The identifier for the key.", - "example": "012345678912345678", - "type": "string" - }, - "key": { - "description": "The Base64 encoded public key.", - "example": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "type": "string" - } - } - }, - "examples": { - "default": { - "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "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" - } - } - } - } - } - } - }, - "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": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The specified private registry configuration for the organization", - "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.", - "example": "MAVEN_REPOSITORY_SECRET", - "type": "string" - }, - "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" - ], + "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": { + "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": { + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key_id", + "key" + ], + "properties": { + "key_id": { + "description": "The identifier for the key.", + "example": "012345678912345678", + "type": "string" + }, + "key": { + "description": "The Base64 encoded public key.", + "example": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "type": "string" + } + } + }, + "examples": { + "default": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "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" + } + } + } + } + } + } + }, + "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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "The specified private registry configuration for the organization", + "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.", + "example": "MAVEN_REPOSITORY_SECRET", + "type": "string" + }, + "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.", + "example": "monalisa", + "type": "string", + "nullable": true + }, + "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.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "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" }, - "url": { - "description": "The URL of the private registry.", - "type": "string", - "format": "uri" - }, - "username": { - "description": "The username to use when authenticating with the private registry.", - "example": "monalisa", - "type": "string", - "nullable": true - }, - "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.", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "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.", + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", "type": "string" }, "created_at": { @@ -165349,7 +168554,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" ], @@ -165455,7 +168660,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -165491,7 +168697,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": { @@ -165509,6 +168715,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" } } }, @@ -207403,6 +210617,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": { @@ -231576,25 +234799,525 @@ } }, { - "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", + "format": "date-time", + "nullable": true + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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", + "format": "uri", + "description": "API URL for the workflow run.", + "nullable": true + }, + "run_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the workflow run.", + "nullable": true + }, + "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", + "format": "uri", + "description": "API URL for the job.", + "nullable": true + }, + "job_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the job.", + "nullable": true + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "concurrency-groups" } } }, @@ -246520,99 +250243,374 @@ } }, { - "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", + "format": "uri", + "description": "API URL for the workflow run.", + "nullable": true + }, + "run_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the workflow run.", + "nullable": true + }, + "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", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease.", + "nullable": true + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease.", + "nullable": true + }, + "job_url": { + "type": "string", + "format": "uri", + "description": "API URL for the job.", + "nullable": true + }, + "job_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the job.", + "nullable": true + }, + "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": { @@ -246636,13 +250634,82 @@ } } } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "workflow-runs" + "subcategory": "concurrency-groups" } } }, @@ -524092,6 +528159,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": { @@ -527955,6 +532031,9 @@ "400": { "description": "Bad request, resolution comment is invalid or the resolution was not changed." }, + "403": { + "description": "Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer." + }, "404": { "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index ef0e28ddf..4bb3ae7a3 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -999,7 +999,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &671 + - &672 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1086,6 +1086,2525 @@ 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 @@ -11423,7 +13942,7 @@ paths: properties: action: type: string - discussion: &765 + discussion: &766 title: Discussion description: A Discussion in a repository. type: object @@ -12159,7 +14678,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &682 + sub_issues_summary: &683 title: Sub-issues Summary type: object properties: @@ -12272,7 +14791,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &683 + issue_dependencies_summary: &684 title: Issue Dependencies Summary type: object properties: @@ -18709,7 +21228,7 @@ paths: required: false schema: type: string - - &740 + - &741 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -18855,7 +21374,7 @@ paths: parameters: - *78 - *124 - - &741 + - &742 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 @@ -18967,7 +21486,7 @@ paths: - *124 - *126 - *125 - - &742 + - &743 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -18975,7 +21494,7 @@ paths: schema: type: string - *127 - - &743 + - &744 name: sku description: The SKU to query for usage. in: query @@ -25160,6 +27679,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 @@ -25202,24 +27725,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 example: 1.2.3 @@ -25680,12 +28197,12 @@ paths: required: - subject_digests examples: - default: &721 + default: &722 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &722 + withPredicateType: &723 value: subject_digests: - sha256:abc123 @@ -25729,7 +28246,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &723 + default: &724 value: attestations_subject_digests: - sha256:abc: @@ -38127,7 +40644,7 @@ paths: parameters: - *78 - *260 - - &703 + - &704 name: repo_name description: repo_name parameter in: path @@ -39055,7 +41572,7 @@ paths: - nuget - container - *78 - - &704 + - &705 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -39096,7 +41613,7 @@ paths: default: *267 '403': *29 '401': *25 - '400': &706 + '400': &707 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -40411,6 +42928,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -40479,6 +42997,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 @@ -40516,7 +43043,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: @@ -40609,7 +43136,472 @@ 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. + example: MAVEN_REPOSITORY_SECRET + type: string + 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. + example: monalisa + type: string + 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: &281 + 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: + - *78 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - key_id + - key + properties: + key_id: + description: The identifier for the key. + example: '012345678912345678' + type: string + key: + description: The Base64 encoded public key. + example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + type: string + examples: + default: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + headers: + Link: *70 + '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: + - *78 + - *169 + responses: + '200': + description: The specified private registry configuration for the organization + content: + application/json: + schema: *280 + examples: + default: *281 + '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: + - *78 + - *169 + 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 + nullable: true + 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 @@ -40618,6 +43610,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`. @@ -40650,7 +43643,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` @@ -40668,440 +43661,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. - example: MAVEN_REPOSITORY_SECRET - type: string - 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. - example: monalisa - type: string - 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: &281 - 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: - - *78 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - key_id - - key - properties: - key_id: - description: The identifier for the key. - example: '012345678912345678' - type: string - key: - description: The Base64 encoded public key. - example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - type: string - examples: - default: - value: - key_id: '012345678912345678' - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - headers: - Link: *70 - '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: - - *78 - - *169 - responses: - '200': - description: The specified private registry configuration for the organization - content: - application/json: - schema: *280 - examples: - default: *281 - '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: - - *78 - - *169 - 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 - nullable: true - 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. + 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: - - 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: @@ -41253,7 +43821,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &796 + properties: &797 id: type: number description: The unique identifier of the status update. @@ -41301,7 +43869,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &797 + required: &798 - id - node_id - created_at @@ -42106,7 +44674,7 @@ paths: - updated_at - project_url examples: - default: &727 + default: &728 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -42283,7 +44851,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &728 + items: &729 type: object properties: name: @@ -42320,7 +44888,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &729 + iteration_configuration: &730 type: object description: The configuration for iteration fields. properties: @@ -42370,7 +44938,7 @@ paths: value: name: Due date data_type: date - single_select_field: &730 + single_select_field: &731 summary: Create a single select field value: name: Priority @@ -42397,7 +44965,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &731 + iteration_field: &732 summary: Create an iteration field value: name: Sprint @@ -42423,7 +44991,7 @@ paths: application/json: schema: *288 examples: - text_field: &732 + text_field: &733 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -42432,7 +45000,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: &733 + number_field: &734 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -42441,7 +45009,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: &734 + date_field: &735 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -42450,7 +45018,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: &735 + single_select_field: &736 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -42484,7 +45052,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &736 + iteration_field: &737 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -42530,7 +45098,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *284 - - &737 + - &738 name: field_id description: The unique identifier of the field. in: path @@ -42545,7 +45113,7 @@ paths: application/json: schema: *288 examples: - default: &738 + default: &739 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -43742,7 +46310,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &718 + schema: &719 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -43919,7 +46487,7 @@ paths: parameters: - *284 - *78 - - &739 + - &740 name: view_number description: The number that identifies the project view. in: path @@ -47922,6 +50490,17 @@ paths: schema: type: boolean default: false + - &649 + 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 @@ -47948,14 +50527,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &649 + state: &650 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: &650 + resolution: &651 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -48072,8 +50651,8 @@ paths: pull request. ' - oneOf: &651 - - &653 + oneOf: &652 + - &654 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -48131,7 +50710,7 @@ paths: - blob_url - commit_sha - commit_url - - &654 + - &655 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. @@ -48186,7 +50765,7 @@ paths: - page_url - commit_sha - commit_url - - &655 + - &656 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -48206,7 +50785,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &656 + - &657 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -48226,7 +50805,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &657 + - &658 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -48246,7 +50825,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &658 + - &659 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -48260,7 +50839,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &659 + - &660 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -48274,7 +50853,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &660 + - &661 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -48288,7 +50867,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &661 + - &662 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. @@ -48308,7 +50887,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &662 + - &663 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. @@ -48328,7 +50907,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &663 + - &664 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. @@ -48348,7 +50927,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &664 + - &665 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. @@ -48368,7 +50947,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &665 + - &666 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 request. @@ -48887,7 +51466,7 @@ paths: application/json: schema: type: array - items: &669 + items: &670 description: A repository security advisory. type: object properties: @@ -49159,7 +51738,7 @@ paths: - private_fork additionalProperties: false examples: - default: &670 + default: &671 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -51138,7 +53717,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &685 + response-if-user-is-a-team-maintainer: &686 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -51203,7 +53782,7 @@ paths: application/json: schema: *347 examples: - response-if-users-membership-with-team-is-now-pending: &686 + response-if-users-membership-with-team-is-now-pending: &687 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -51317,7 +53896,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &687 + schema: &688 title: Team Repository description: A team's access to a repository. type: object @@ -51967,7 +54546,7 @@ paths: type: array items: *201 examples: - response-if-child-teams-exist: &688 + response-if-child-teams-exist: &689 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -53791,6 +56370,240 @@ 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: + - *348 + - *349 + - *17 + - *48 + 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 + format: date-time + nullable: true + 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: *70 + '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: + - *348 + - *349 + - 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 + format: uri + description: API URL for the workflow run. + nullable: true + run_html_url: + type: string + format: uri + description: Web URL for the workflow run. + nullable: true + 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 + format: uri + description: API URL for the job. + nullable: true + job_html_url: + type: string + format: uri + description: Web URL for the job. + nullable: true + 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 @@ -56742,6 +59555,192 @@ 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: + - *348 + - *349 + - *386 + - *17 + - *47 + - *48 + 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 + format: uri + description: API URL for the workflow run. + nullable: true + run_html_url: + type: string + format: uri + description: Web URL for the workflow run. + nullable: true + 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 + description: The ID of the job, when the item represents + a job-level or reusable-workflow-level lease. + nullable: true + job_name: + type: string + description: The display name of the job, when the + item represents a job-level or reusable-workflow-level + lease. + nullable: true + job_url: + type: string + format: uri + description: API URL for the job. + nullable: true + job_html_url: + type: string + format: uri + description: Web URL for the job. + nullable: true + 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: *70 + '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 @@ -57181,7 +60180,7 @@ paths: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &759 + properties: &760 url: type: string format: uri @@ -57266,7 +60265,7 @@ paths: nullable: true properties: *83 required: *84 - required: &760 + required: &761 - id - node_id - sha @@ -62852,7 +65851,7 @@ paths: check. type: array items: *93 - deployment: &752 + deployment: &753 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -63764,7 +66763,7 @@ paths: type: string format: date-time nullable: true - head_commit: &780 + head_commit: &781 title: Simple Commit description: A commit. type: object @@ -68033,14 +71032,14 @@ paths: type: integer machines: type: array - items: &693 + items: &694 type: object title: Codespace machine description: A description of the machine powering a codespace. properties: *470 required: *471 examples: - default: &694 + default: &695 value: total_count: 2 machines: @@ -71186,7 +74185,7 @@ paths: application/json: schema: type: array - items: &674 + items: &675 title: Status description: The status of a commit. type: object @@ -72769,7 +75768,7 @@ paths: items: type: object properties: - placeholder_id: &666 + placeholder_id: &667 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -78627,7 +81626,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &788 + last_response: &789 title: Hook Response type: object properties: @@ -79679,7 +82678,7 @@ paths: parameters: - *348 - *349 - - &716 + - &717 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -80113,7 +83112,7 @@ paths: type: array items: *550 examples: - default: &708 + default: &709 value: - id: 1 repository: @@ -94299,6 +97298,7 @@ paths: - *646 - *647 - *648 + - *649 responses: '200': description: Response @@ -94306,7 +97306,7 @@ paths: application/json: schema: type: array - items: &652 + items: &653 type: object properties: number: *179 @@ -94325,8 +97325,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *649 - resolution: *650 + state: *650 + resolution: *651 resolved_at: type: string format: date-time @@ -94432,7 +97432,7 @@ paths: pull request. ' - oneOf: *651 + oneOf: *652 nullable: true has_more_locations: type: boolean @@ -94605,7 +97605,7 @@ paths: description: Response content: application/json: - schema: *652 + schema: *653 examples: default: value: @@ -94669,8 +97669,8 @@ paths: schema: type: object properties: - state: *649 - resolution: *650 + state: *650 + resolution: *651 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -94714,7 +97714,7 @@ paths: description: Response content: application/json: - schema: *652 + schema: *653 examples: default: value: @@ -94781,6 +97781,9 @@ paths: '400': description: Bad request, resolution comment is invalid or the resolution was not changed. + '403': + description: Delegated alert dismissal is enabled and the authenticated + user is not a valid reviewer. '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found @@ -94823,7 +97826,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &810 + items: &811 type: object properties: type: @@ -94849,7 +97852,6 @@ paths: example: commit details: oneOf: - - *653 - *654 - *655 - *656 @@ -94862,6 +97864,7 @@ paths: - *663 - *664 - *665 + - *666 examples: default: value: @@ -94956,14 +97959,14 @@ paths: schema: type: object properties: - reason: &667 + reason: &668 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *666 + placeholder_id: *667 required: - reason - placeholder_id @@ -94980,7 +97983,7 @@ paths: schema: type: object properties: - reason: *667 + reason: *668 expire_at: type: string format: date-time @@ -95042,7 +98045,7 @@ paths: properties: incremental_scans: type: array - items: &668 + items: &669 description: Information on a single scan performed by secret scanning on the repository type: object @@ -95068,15 +98071,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *668 + items: *669 backfill_scans: type: array - items: *668 + items: *669 custom_pattern_backfill_scans: type: array items: allOf: - - *668 + - *669 - type: object properties: pattern_name: @@ -95089,7 +98092,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *668 + items: *669 examples: default: value: @@ -95199,9 +98202,9 @@ paths: application/json: schema: type: array - items: *669 + items: *670 examples: - default: *670 + default: *671 '400': *14 '404': *6 x-github: @@ -95385,9 +98388,9 @@ paths: description: Response content: application/json: - schema: *669 + schema: *670 examples: - default: &672 + default: &673 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -95722,7 +98725,7 @@ paths: description: Response content: application/json: - schema: *669 + schema: *670 examples: default: value: @@ -95870,15 +98873,15 @@ paths: parameters: - *348 - *349 - - *671 + - *672 responses: '200': description: Response content: application/json: - schema: *669 + schema: *670 examples: - default: *672 + default: *673 '403': *29 '404': *6 x-github: @@ -95904,7 +98907,7 @@ paths: parameters: - *348 - *349 - - *671 + - *672 requestBody: required: true content: @@ -96063,10 +99066,10 @@ paths: description: Response content: application/json: - schema: *669 + schema: *670 examples: - default: *672 - add_credit: *672 + default: *673 + add_credit: *673 '403': *29 '404': *6 '422': @@ -96106,7 +99109,7 @@ paths: parameters: - *348 - *349 - - *671 + - *672 responses: '202': *39 '400': *14 @@ -96135,7 +99138,7 @@ paths: parameters: - *348 - *349 - - *671 + - *672 responses: '202': description: Response @@ -96279,7 +99282,7 @@ paths: application/json: schema: type: array - items: &673 + items: &674 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -96652,7 +99655,7 @@ paths: application/json: schema: type: array - items: *673 + items: *674 examples: default: value: @@ -96740,7 +99743,7 @@ paths: description: Response content: application/json: - schema: *674 + schema: *675 examples: default: value: @@ -96834,7 +99837,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &675 + schema: &676 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -96929,7 +99932,7 @@ paths: description: Response content: application/json: - schema: *675 + schema: *676 examples: default: value: @@ -97136,7 +100139,7 @@ paths: description: Response content: application/json: - schema: &676 + schema: &677 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -97148,7 +100151,7 @@ paths: required: - names examples: - default: &677 + default: &678 value: names: - octocat @@ -97203,9 +100206,9 @@ paths: description: Response content: application/json: - schema: *676 + schema: *677 examples: - default: *677 + default: *678 '404': *6 '422': *7 x-github: @@ -97228,7 +100231,7 @@ paths: parameters: - *348 - *349 - - &678 + - &679 name: per description: The time frame to display results for. in: query @@ -97257,7 +100260,7 @@ paths: example: 128 clones: type: array - items: &679 + items: &680 title: Traffic type: object properties: @@ -97498,7 +100501,7 @@ paths: parameters: - *348 - *349 - - *678 + - *679 responses: '200': description: Response @@ -97517,7 +100520,7 @@ paths: example: 3782 views: type: array - items: *679 + items: *680 required: - uniques - count @@ -98288,7 +101291,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &680 + text_matches: &681 title: Search Result Text Matches type: array items: @@ -98450,7 +101453,7 @@ paths: enum: - author-date - committer-date - - &681 + - &682 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 @@ -98578,7 +101581,7 @@ paths: type: number node_id: type: string - text_matches: *680 + text_matches: *681 required: - sha - node_id @@ -98770,7 +101773,7 @@ paths: - interactions - created - updated - - *681 + - *682 - *17 - *19 - name: advanced_search @@ -98884,8 +101887,8 @@ paths: description: type: string nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -98913,7 +101916,7 @@ paths: type: string format: date-time nullable: true - text_matches: *680 + text_matches: *681 pull_request: type: object properties: @@ -99183,7 +102186,7 @@ paths: enum: - created - updated - - *681 + - *682 - *17 - *19 responses: @@ -99227,7 +102230,7 @@ paths: nullable: true score: type: number - text_matches: *680 + text_matches: *681 required: - id - node_id @@ -99312,7 +102315,7 @@ paths: - forks - help-wanted-issues - updated - - *681 + - *682 - *17 - *19 responses: @@ -99560,7 +102563,7 @@ paths: - admin - pull - push - text_matches: *680 + text_matches: *681 temp_clone_token: type: string allow_merge_commit: @@ -99860,7 +102863,7 @@ paths: type: string format: uri nullable: true - text_matches: *680 + text_matches: *681 related: type: array nullable: true @@ -100051,7 +103054,7 @@ paths: - followers - repositories - joined - - *681 + - *682 - *17 - *19 responses: @@ -100155,7 +103158,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *680 + text_matches: *681 blog: type: string nullable: true @@ -100234,7 +103237,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &684 + - &685 name: team_id description: The unique identifier of the team. in: path @@ -100275,7 +103278,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *684 + - *685 requestBody: required: true content: @@ -100375,7 +103378,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *684 + - *685 responses: '204': description: Response @@ -100404,7 +103407,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *684 + - *685 - *17 - *19 responses: @@ -100442,7 +103445,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *684 + - *685 - name: role description: Filters members returned by their role in the team. in: query @@ -100493,7 +103496,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *684 + - *685 - *74 responses: '204': @@ -100530,7 +103533,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *684 + - *685 - *74 responses: '204': @@ -100570,7 +103573,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *684 + - *685 - *74 responses: '204': @@ -100607,7 +103610,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *684 + - *685 - *74 responses: '200': @@ -100616,7 +103619,7 @@ paths: application/json: schema: *347 examples: - response-if-user-is-a-team-maintainer: *685 + response-if-user-is-a-team-maintainer: *686 '404': *6 x-github: githubCloudOnly: false @@ -100649,7 +103652,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *684 + - *685 - *74 requestBody: required: false @@ -100677,7 +103680,7 @@ paths: application/json: schema: *347 examples: - response-if-users-membership-with-team-is-now-pending: *686 + response-if-users-membership-with-team-is-now-pending: *687 '403': description: Forbidden if team synchronization is set up '422': @@ -100711,7 +103714,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *684 + - *685 - *74 responses: '204': @@ -100739,7 +103742,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *684 + - *685 - *17 - *19 responses: @@ -100781,7 +103784,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *684 + - *685 - *348 - *349 responses: @@ -100789,7 +103792,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *687 + schema: *688 examples: alternative-response-with-extra-repository-information: value: @@ -100939,7 +103942,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *684 + - *685 - *348 - *349 requestBody: @@ -100991,7 +103994,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *684 + - *685 - *348 - *349 responses: @@ -101018,7 +104021,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *684 + - *685 - *17 - *19 responses: @@ -101030,7 +104033,7 @@ paths: type: array items: *201 examples: - response-if-child-teams-exist: *688 + response-if-child-teams-exist: *689 headers: Link: *70 '404': *6 @@ -101063,7 +104066,7 @@ paths: application/json: schema: oneOf: - - &689 + - &690 title: Private User description: Private User type: object @@ -101266,7 +104269,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - &715 + - &716 title: Public User description: Public User type: object @@ -101578,7 +104581,7 @@ paths: description: Response content: application/json: - schema: *689 + schema: *690 examples: default: value: @@ -101976,7 +104979,7 @@ paths: type: integer secrets: type: array - items: &690 + items: &691 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -102092,7 +105095,7 @@ paths: description: Response content: application/json: - schema: *690 + schema: *691 examples: default: value: @@ -102505,7 +105508,7 @@ paths: description: Response content: application/json: - schema: &691 + schema: &692 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -102546,7 +105549,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &692 + default: &693 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -102591,9 +105594,9 @@ paths: description: Response content: application/json: - schema: *691 + schema: *692 examples: - default: *692 + default: *693 '404': *6 x-github: githubCloudOnly: false @@ -102630,9 +105633,9 @@ paths: type: integer machines: type: array - items: *693 + items: *694 examples: - default: *694 + default: *695 '304': *37 '500': *55 '401': *25 @@ -103571,7 +106574,7 @@ paths: type: array items: *266 examples: - default: &705 + default: &706 value: - id: 197 name: hello_docker @@ -103672,7 +106675,7 @@ paths: application/json: schema: type: array - items: &695 + items: &696 title: Email description: Email type: object @@ -103737,9 +106740,9 @@ paths: application/json: schema: type: array - items: *695 + items: *696 examples: - default: &707 + default: &708 value: - email: octocat@github.com verified: true @@ -103814,7 +106817,7 @@ paths: application/json: schema: type: array - items: *695 + items: *696 examples: default: value: @@ -104070,7 +107073,7 @@ paths: application/json: schema: type: array - items: &696 + items: &697 title: GPG Key description: A unique encryption key type: object @@ -104201,7 +107204,7 @@ paths: - subkeys - revoked examples: - default: &725 + default: &726 value: - id: 3 name: Octocat's GPG Key @@ -104286,9 +107289,9 @@ paths: description: Response content: application/json: - schema: *696 + schema: *697 examples: - default: &697 + default: &698 value: id: 3 name: Octocat's GPG Key @@ -104345,7 +107348,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &698 + - &699 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -104357,9 +107360,9 @@ paths: description: Response content: application/json: - schema: *696 + schema: *697 examples: - default: *697 + default: *698 '404': *6 '304': *37 '403': *29 @@ -104382,7 +107385,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *698 + - *699 responses: '204': description: Response @@ -104840,7 +107843,7 @@ paths: application/json: schema: type: array - items: &699 + items: &700 title: Key description: Key type: object @@ -104941,9 +107944,9 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: - default: &700 + default: &701 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -104982,9 +107985,9 @@ paths: description: Response content: application/json: - schema: *699 + schema: *700 examples: - default: *700 + default: *701 '404': *6 '304': *37 '403': *29 @@ -105040,7 +108043,7 @@ paths: application/json: schema: type: array - items: &701 + items: &702 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -105108,7 +108111,7 @@ paths: - account - plan examples: - default: &702 + default: &703 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -105170,9 +108173,9 @@ paths: application/json: schema: type: array - items: *701 + items: *702 examples: - default: *702 + default: *703 headers: Link: *70 '304': *37 @@ -106181,7 +109184,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *260 - - *703 + - *704 responses: '204': description: Response @@ -106294,7 +109297,7 @@ paths: - docker - nuget - container - - *704 + - *705 - *19 - *17 responses: @@ -106306,8 +109309,8 @@ paths: type: array items: *266 examples: - default: *705 - '400': *706 + default: *706 + '400': *707 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106336,7 +109339,7 @@ paths: application/json: schema: *266 examples: - default: &726 + default: &727 value: id: 40201 name: octo-name @@ -106698,9 +109701,9 @@ paths: application/json: schema: type: array - items: *695 + items: *696 examples: - default: *707 + default: *708 headers: Link: *70 '304': *37 @@ -106813,7 +109816,7 @@ paths: type: array items: *82 examples: - default: &714 + default: &715 summary: Default response value: - id: 1296269 @@ -107160,7 +110163,7 @@ paths: type: array items: *550 examples: - default: *708 + default: *709 headers: Link: *70 '304': *37 @@ -107240,7 +110243,7 @@ paths: application/json: schema: type: array - items: &709 + items: &710 title: Social account description: Social media account type: object @@ -107255,7 +110258,7 @@ paths: - provider - url examples: - default: &710 + default: &711 value: - provider: twitter url: https://twitter.com/github @@ -107317,9 +110320,9 @@ paths: application/json: schema: type: array - items: *709 + items: *710 examples: - default: *710 + default: *711 '422': *15 '304': *37 '404': *6 @@ -107406,7 +110409,7 @@ paths: application/json: schema: type: array - items: &711 + items: &712 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -107426,7 +110429,7 @@ paths: - title - created_at examples: - default: &744 + default: &745 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -107490,9 +110493,9 @@ paths: description: Response content: application/json: - schema: *711 + schema: *712 examples: - default: &712 + default: &713 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -107522,7 +110525,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: - - &713 + - &714 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -107534,9 +110537,9 @@ paths: description: Response content: application/json: - schema: *711 + schema: *712 examples: - default: *712 + default: *713 '404': *6 '304': *37 '403': *29 @@ -107559,7 +110562,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: - - *713 + - *714 responses: '204': description: Response @@ -107588,7 +110591,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &745 + - &746 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 @@ -107613,11 +110616,11 @@ paths: type: array items: *82 examples: - default-response: *714 + default-response: *715 application/vnd.github.v3.star+json: schema: type: array - items: &746 + items: &747 title: Starred Repository description: Starred Repository type: object @@ -107986,10 +110989,10 @@ paths: application/json: schema: oneOf: - - *689 - - *715 + - *690 + - *716 examples: - default-response: &719 + default-response: &720 summary: Default response value: login: octocat @@ -108024,7 +111027,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &720 + response-with-git-hub-plan-information: &721 summary: Response with GitHub plan information value: login: octocat @@ -108081,7 +111084,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &717 + - &718 name: user_id description: The unique identifier of the user. in: path @@ -108147,7 +111150,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *716 + - *717 - *17 responses: '200': @@ -108182,7 +111185,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *717 + - *718 - *284 requestBody: required: true @@ -108254,7 +111257,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *718 + schema: *719 examples: table_view: summary: Response for creating a table view @@ -108306,11 +111309,11 @@ paths: application/json: schema: oneOf: - - *689 - - *715 + - *690 + - *716 examples: - default-response: *719 - response-with-git-hub-plan-information: *720 + default-response: *720 + response-with-git-hub-plan-information: *721 '404': *6 x-github: githubCloudOnly: false @@ -108360,8 +111363,8 @@ paths: required: - subject_digests examples: - default: *721 - withPredicateType: *722 + default: *722 + withPredicateType: *723 responses: '200': description: Response @@ -108400,7 +111403,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *723 + default: *724 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108870,7 +111873,7 @@ paths: application/json: schema: *195 examples: - default: &724 + default: &725 summary: Example response for a user copilot space value: id: 42 @@ -108971,7 +111974,7 @@ paths: application/json: schema: *195 examples: - default: *724 + default: *725 '403': *29 '404': *6 x-github: @@ -109094,7 +112097,7 @@ paths: application/json: schema: *195 examples: - default: *724 + default: *725 '403': *29 '404': *6 '422': *15 @@ -109862,7 +112865,7 @@ paths: type: array items: *266 examples: - default: *705 + default: *706 '403': *29 '401': *25 x-github: @@ -110246,9 +113249,9 @@ paths: application/json: schema: type: array - items: *696 + items: *697 examples: - default: *725 + default: *726 headers: Link: *70 x-github: @@ -110476,7 +113479,7 @@ paths: - docker - nuget - container - - *704 + - *705 - *74 - *19 - *17 @@ -110489,10 +113492,10 @@ paths: type: array items: *266 examples: - default: *705 + default: *706 '403': *29 '401': *25 - '400': *706 + '400': *707 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -110522,7 +113525,7 @@ paths: application/json: schema: *266 examples: - default: *726 + default: *727 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -110871,7 +113874,7 @@ paths: type: array items: *288 examples: - default: *727 + default: *728 headers: Link: *70 '304': *37 @@ -110931,7 +113934,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *728 + items: *729 required: - name - data_type @@ -110947,7 +113950,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *729 + iteration_configuration: *730 required: - name - data_type @@ -110969,8 +113972,8 @@ paths: value: name: Due date data_type: date - single_select_field: *730 - iteration_field: *731 + single_select_field: *731 + iteration_field: *732 responses: '201': description: Response @@ -110978,11 +113981,11 @@ paths: application/json: schema: *288 examples: - text_field: *732 - number_field: *733 - date_field: *734 - single_select_field: *735 - iteration_field: *736 + text_field: *733 + number_field: *734 + date_field: *735 + single_select_field: *736 + iteration_field: *737 '304': *37 '403': *29 '401': *25 @@ -111004,7 +114007,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *284 - - *737 + - *738 - *74 responses: '200': @@ -111013,7 +114016,7 @@ paths: application/json: schema: *288 examples: - default: *738 + default: *739 headers: Link: *70 '304': *37 @@ -111367,7 +114370,7 @@ paths: parameters: - *284 - *74 - - *739 + - *740 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -111642,7 +114645,7 @@ paths: - *124 - *126 - *125 - - *740 + - *741 - *127 responses: '200': @@ -111773,7 +114776,7 @@ paths: parameters: - *74 - *124 - - *741 + - *742 - *125 responses: '200': @@ -111872,9 +114875,9 @@ paths: - *124 - *126 - *125 - - *742 - - *127 - *743 + - *127 + - *744 responses: '200': description: Response when getting a billing usage summary @@ -112008,9 +115011,9 @@ paths: application/json: schema: type: array - items: *709 + items: *710 examples: - default: *710 + default: *711 headers: Link: *70 x-github: @@ -112040,9 +115043,9 @@ paths: application/json: schema: type: array - items: *711 + items: *712 examples: - default: *744 + default: *745 headers: Link: *70 x-github: @@ -112067,7 +115070,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *74 - - *745 + - *746 - *62 - *17 - *19 @@ -112079,11 +115082,11 @@ paths: schema: anyOf: - type: array - items: *746 + items: *747 - type: array items: *82 examples: - default-response: *714 + default-response: *715 headers: Link: *70 x-github: @@ -112242,7 +115245,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &747 + enterprise: &748 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -112300,7 +115303,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &748 + installation: &749 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -112319,7 +115322,7 @@ x-webhooks: required: - id - node_id - organization: &749 + organization: &750 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -112379,13 +115382,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &750 + repository: &751 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &782 + properties: &783 id: description: Unique identifier of the repository example: 42 @@ -113069,7 +116072,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &783 + required: &784 - archive_url - assignees_url - blobs_url @@ -113220,10 +116223,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -113299,11 +116302,11 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - rule: &751 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 + rule: &752 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) @@ -113526,11 +116529,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - rule: *751 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 + rule: *752 sender: *4 required: - action @@ -113713,11 +116716,11 @@ x-webhooks: - everyone required: - from - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - rule: *751 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 + rule: *752 sender: *4 required: - action @@ -113801,7 +116804,7 @@ x-webhooks: type: string enum: - completed - check_run: &753 + check_run: &754 title: CheckRun description: A check performed on the code of a given code change type: object @@ -113892,7 +116895,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *752 + deployment: *753 details_url: example: https://example.com type: string @@ -113977,10 +116980,10 @@ x-webhooks: - output - app - pull_requests - installation: *748 - enterprise: *747 - organization: *749 - repository: *750 + installation: *749 + enterprise: *748 + organization: *750 + repository: *751 sender: *4 required: - check_run @@ -114371,11 +117374,11 @@ x-webhooks: type: string enum: - created - check_run: *753 - installation: *748 - enterprise: *747 - organization: *749 - repository: *750 + check_run: *754 + installation: *749 + enterprise: *748 + organization: *750 + repository: *751 sender: *4 required: - check_run @@ -114769,11 +117772,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *753 - installation: *748 - enterprise: *747 - organization: *749 - repository: *750 + check_run: *754 + installation: *749 + enterprise: *748 + organization: *750 + repository: *751 requested_action: description: The action requested by the user. type: object @@ -115176,11 +118179,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *753 - installation: *748 - enterprise: *747 - organization: *749 - repository: *750 + check_run: *754 + installation: *749 + enterprise: *748 + organization: *750 + repository: *751 sender: *4 required: - check_run @@ -116150,10 +119153,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -116842,10 +119845,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -117528,10 +120531,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -117842,20 +120845,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &754 + commit_oid: &755 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: *747 - installation: *748 - organization: *749 - ref: &755 + enterprise: *748 + installation: *749 + organization: *750 + ref: &756 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: *750 + repository: *751 sender: *4 required: - action @@ -118250,12 +121253,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *754 - enterprise: *747 - installation: *748 - organization: *749 - ref: *755 - repository: *750 + commit_oid: *755 + enterprise: *748 + installation: *749 + organization: *750 + ref: *756 + repository: *751 sender: *4 required: - action @@ -118521,12 +121524,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *754 - enterprise: *747 - installation: *748 - organization: *749 - ref: *755 - repository: *750 + commit_oid: *755 + enterprise: *748 + installation: *749 + organization: *750 + ref: *756 + repository: *751 sender: *4 required: - action @@ -118858,12 +121861,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *754 - enterprise: *747 - installation: *748 - organization: *749 - ref: *755 - repository: *750 + commit_oid: *755 + enterprise: *748 + installation: *749 + organization: *750 + ref: *756 + repository: *751 sender: *4 required: - action @@ -119137,16 +122140,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 ref: 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 nullable: true - repository: *750 + repository: *751 sender: *4 required: - action @@ -119383,12 +122386,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *754 - enterprise: *747 - installation: *748 - organization: *749 - ref: *755 - repository: *750 + commit_oid: *755 + enterprise: *748 + installation: *749 + organization: *750 + ref: *756 + repository: *751 sender: *4 required: - action @@ -119699,10 +122702,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -119957,10 +122960,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -120040,18 +123043,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *749 - pusher_type: &756 + organization: *750 + pusher_type: &757 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &757 + ref: &758 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -120061,7 +123064,7 @@ x-webhooks: enum: - tag - branch - repository: *750 + repository: *751 sender: *4 required: - ref @@ -120144,9 +123147,9 @@ x-webhooks: enum: - created definition: *296 - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 sender: *4 required: - action @@ -120231,9 +123234,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 sender: *4 required: - action @@ -120311,9 +123314,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *296 - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 sender: *4 required: - action @@ -120391,9 +123394,9 @@ x-webhooks: enum: - updated definition: *296 - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 sender: *4 required: - action @@ -120470,10 +123473,10 @@ x-webhooks: type: string enum: - updated - enterprise: *747 - installation: *748 - repository: *750 - organization: *749 + enterprise: *748 + installation: *749 + repository: *751 + organization: *750 sender: *4 new_property_values: type: array @@ -120558,18 +123561,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *747 - installation: *748 - organization: *749 - pusher_type: *756 - ref: *757 + enterprise: *748 + installation: *749 + organization: *750 + pusher_type: *757 + ref: *758 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *750 + repository: *751 sender: *4 required: - ref @@ -120650,10 +123653,10 @@ x-webhooks: enum: - assignees_changed alert: *505 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + installation: *749 + organization: *750 + enterprise: *748 + repository: *751 sender: *4 required: - action @@ -120734,10 +123737,10 @@ x-webhooks: enum: - auto_dismissed alert: *505 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + installation: *749 + organization: *750 + enterprise: *748 + repository: *751 sender: *4 required: - action @@ -120819,10 +123822,10 @@ x-webhooks: enum: - auto_reopened alert: *505 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + installation: *749 + organization: *750 + enterprise: *748 + repository: *751 sender: *4 required: - action @@ -120904,10 +123907,10 @@ x-webhooks: enum: - created alert: *505 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + installation: *749 + organization: *750 + enterprise: *748 + repository: *751 sender: *4 required: - action @@ -120987,10 +123990,10 @@ x-webhooks: enum: - dismissed alert: *505 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + installation: *749 + organization: *750 + enterprise: *748 + repository: *751 sender: *4 required: - action @@ -121070,10 +124073,10 @@ x-webhooks: enum: - fixed alert: *505 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + installation: *749 + organization: *750 + enterprise: *748 + repository: *751 sender: *4 required: - action @@ -121154,10 +124157,10 @@ x-webhooks: enum: - reintroduced alert: *505 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + installation: *749 + organization: *750 + enterprise: *748 + repository: *751 sender: *4 required: - action @@ -121237,10 +124240,10 @@ x-webhooks: enum: - reopened alert: *505 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + installation: *749 + organization: *750 + enterprise: *748 + repository: *751 sender: *4 required: - action @@ -121317,9 +124320,9 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - key: &758 + enterprise: *748 + installation: *749 + key: &759 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -121355,8 +124358,8 @@ x-webhooks: - verified - created_at - read_only - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -121433,11 +124436,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - key: *758 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + key: *759 + organization: *750 + repository: *751 sender: *4 required: - action @@ -121993,12 +124996,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - workflow: &764 + workflow: &765 title: Workflow type: object nullable: true @@ -122739,15 +125742,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *759 - required: *760 + properties: *760 + required: *761 nullable: true pull_requests: type: array items: *602 - repository: *750 - organization: *749 - installation: *748 + repository: *751 + organization: *750 + installation: *749 sender: *4 responses: '200': @@ -122818,7 +125821,7 @@ x-webhooks: type: string enum: - approved - approver: &761 + approver: &762 type: object properties: avatar_url: @@ -122861,11 +125864,11 @@ x-webhooks: type: string comment: type: string - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - reviewers: &762 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 + reviewers: &763 type: array items: type: object @@ -122944,7 +125947,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &763 + workflow_job_run: &764 type: object properties: conclusion: @@ -123675,18 +126678,18 @@ x-webhooks: type: string enum: - rejected - approver: *761 + approver: *762 comment: type: string - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - reviewers: *762 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 + reviewers: *763 sender: *4 since: type: string - workflow_job_run: *763 + workflow_job_run: *764 workflow_job_runs: type: array items: @@ -124390,13 +127393,13 @@ x-webhooks: type: string enum: - requested - enterprise: *747 + enterprise: *748 environment: type: string - installation: *748 - organization: *749 - repository: *750 - requestor: &769 + installation: *749 + organization: *750 + repository: *751 + requestor: &770 title: User type: object nullable: true @@ -126285,12 +129288,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - workflow: *764 + workflow: *765 workflow_run: title: Deployment Workflow Run type: object @@ -126970,7 +129973,7 @@ x-webhooks: type: string enum: - answered - answer: &767 + answer: &768 type: object properties: author_association: @@ -127127,11 +130130,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -127258,11 +130261,11 @@ x-webhooks: - from required: - category - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -127345,11 +130348,11 @@ x-webhooks: type: string enum: - closed - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -127431,7 +130434,7 @@ x-webhooks: type: string enum: - created - comment: &766 + comment: &767 type: object properties: author_association: @@ -127588,11 +130591,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -127675,12 +130678,12 @@ x-webhooks: type: string enum: - deleted - comment: *766 - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + comment: *767 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -127775,12 +130778,12 @@ x-webhooks: - from required: - body - comment: *766 - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + comment: *767 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -127864,11 +130867,11 @@ x-webhooks: type: string enum: - created - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -127950,11 +130953,11 @@ x-webhooks: type: string enum: - deleted - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128054,11 +131057,11 @@ x-webhooks: type: string required: - from - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128140,10 +131143,10 @@ x-webhooks: type: string enum: - labeled - discussion: *765 - enterprise: *747 - installation: *748 - label: &768 + discussion: *766 + enterprise: *748 + installation: *749 + label: &769 title: Label type: object properties: @@ -128175,8 +131178,8 @@ x-webhooks: - color - default - description - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128259,11 +131262,11 @@ x-webhooks: type: string enum: - locked - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128345,11 +131348,11 @@ x-webhooks: type: string enum: - pinned - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128431,11 +131434,11 @@ x-webhooks: type: string enum: - reopened - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128520,16 +131523,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *765 - new_repository: *750 + new_discussion: *766 + new_repository: *751 required: - new_discussion - new_repository - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128612,10 +131615,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *765 - old_answer: *767 - organization: *749 - repository: *750 + discussion: *766 + old_answer: *768 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128697,12 +131700,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *765 - enterprise: *747 - installation: *748 - label: *768 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + label: *769 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128785,11 +131788,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128871,11 +131874,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *765 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *766 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -128948,7 +131951,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *747 + enterprise: *748 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -129608,9 +132611,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - forkee @@ -129756,9 +132759,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 pages: description: The pages that were updated. type: array @@ -129795,7 +132798,7 @@ x-webhooks: - action - sha - html_url - repository: *750 + repository: *751 sender: *4 required: - pages @@ -129871,10 +132874,10 @@ x-webhooks: type: string enum: - created - enterprise: *747 + enterprise: *748 installation: *22 - organization: *749 - repositories: &770 + organization: *750 + repositories: &771 description: An array of repository objects that the installation can access. type: array @@ -129900,8 +132903,8 @@ x-webhooks: - name - full_name - private - repository: *750 - requester: *769 + repository: *751 + requester: *770 sender: *4 required: - action @@ -129976,11 +132979,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 + enterprise: *748 installation: *22 - organization: *749 - repositories: *770 - repository: *750 + organization: *750 + repositories: *771 + repository: *751 requester: nullable: true sender: *4 @@ -130056,11 +133059,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *747 + enterprise: *748 installation: *22 - organization: *749 - repositories: *770 - repository: *750 + organization: *750 + repositories: *771 + repository: *751 requester: nullable: true sender: *4 @@ -130136,10 +133139,10 @@ x-webhooks: type: string enum: - added - enterprise: *747 + enterprise: *748 installation: *22 - organization: *749 - repositories_added: &771 + organization: *750 + repositories_added: &772 description: An array of repository objects, which were added to the installation. type: array @@ -130185,15 +133188,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *750 - repository_selection: &772 + repository: *751 + repository_selection: &773 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *769 + requester: *770 sender: *4 required: - action @@ -130272,10 +133275,10 @@ x-webhooks: type: string enum: - removed - enterprise: *747 + enterprise: *748 installation: *22 - organization: *749 - repositories_added: *771 + organization: *750 + repositories_added: *772 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -130302,9 +133305,9 @@ x-webhooks: - name - full_name - private - repository: *750 - repository_selection: *772 - requester: *769 + repository: *751 + repository_selection: *773 + requester: *770 sender: *4 required: - action @@ -130383,11 +133386,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *747 + enterprise: *748 installation: *22 - organization: *749 - repositories: *770 - repository: *750 + organization: *750 + repositories: *771 + repository: *751 requester: nullable: true sender: *4 @@ -130565,10 +133568,10 @@ x-webhooks: type: string required: - from - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 target_type: type: string @@ -130647,11 +133650,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *747 + enterprise: *748 installation: *22 - organization: *749 - repositories: *770 - repository: *750 + organization: *750 + repositories: *771 + repository: *751 requester: nullable: true sender: *4 @@ -130911,8 +133914,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -131701,8 +134704,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132051,8 +135054,8 @@ x-webhooks: - state - locked - assignee - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -132132,7 +135135,7 @@ x-webhooks: type: string enum: - deleted - comment: &773 + comment: &774 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -132305,8 +135308,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -133091,8 +136094,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133443,8 +136446,8 @@ x-webhooks: - state - locked - assignee - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -133524,7 +136527,7 @@ x-webhooks: type: string enum: - edited - changes: &802 + changes: &803 description: The changes to the comment. type: object properties: @@ -133536,9 +136539,9 @@ x-webhooks: type: string required: - from - comment: *773 - enterprise: *747 - installation: *748 + comment: *774 + enterprise: *748 + installation: *749 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -134326,8 +137329,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134676,8 +137679,8 @@ x-webhooks: - state - locked - assignee - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -134758,9 +137761,9 @@ x-webhooks: type: string enum: - pinned - comment: *773 - enterprise: *747 - installation: *748 + comment: *774 + enterprise: *748 + installation: *749 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -135550,8 +138553,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135902,8 +138905,8 @@ x-webhooks: - state - locked - assignee - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -135983,9 +138986,9 @@ x-webhooks: type: string enum: - unpinned - comment: *773 - enterprise: *747 - installation: *748 + comment: *774 + enterprise: *748 + installation: *749 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -136775,8 +139778,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137127,8 +140130,8 @@ x-webhooks: - state - locked - assignee - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -137217,9 +140220,9 @@ x-webhooks: type: number blocking_issue: *88 blocking_issue_repo: *82 - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -137308,9 +140311,9 @@ x-webhooks: type: number blocking_issue: *88 blocking_issue_repo: *82 - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -137398,9 +140401,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *88 - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -137489,9 +140492,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *88 - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -137571,10 +140574,10 @@ x-webhooks: type: string enum: - assigned - assignee: *769 - enterprise: *747 - installation: *748 - issue: &774 + assignee: *770 + enterprise: *748 + installation: *749 + issue: &775 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -138366,8 +141369,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -138487,8 +141490,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -138568,8 +141571,8 @@ x-webhooks: type: string enum: - closed - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -139366,8 +142369,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -139622,8 +142625,8 @@ x-webhooks: required: - state - closed_at - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -139702,8 +142705,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -140491,8 +143494,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -140611,8 +143614,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -140691,8 +143694,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141502,8 +144505,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -141601,7 +144604,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &775 + milestone: &776 title: Milestone description: A collection of related issues and pull requests. type: object @@ -141739,8 +144742,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -141839,8 +144842,8 @@ x-webhooks: type: string required: - from - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142632,8 +145635,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -142753,9 +145756,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *768 - organization: *749 - repository: *750 + label: *769 + organization: *750 + repository: *751 sender: *4 required: - action @@ -142835,9 +145838,9 @@ x-webhooks: type: string enum: - field_added - enterprise: *747 - installation: *748 - issue: *774 + enterprise: *748 + installation: *749 + issue: *775 issue_field: type: object description: The issue field whose value was set or updated on the @@ -142946,8 +145949,8 @@ x-webhooks: - id required: - from - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -143027,9 +146030,9 @@ x-webhooks: type: string enum: - field_removed - enterprise: *747 - installation: *748 - issue: *774 + enterprise: *748 + installation: *749 + issue: *775 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -143087,8 +146090,8 @@ x-webhooks: nullable: true required: - id - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -143168,8 +146171,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -143960,8 +146963,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -144081,9 +147084,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *768 - organization: *749 - repository: *750 + label: *769 + organization: *750 + repository: *751 sender: *4 required: - action @@ -144163,8 +147166,8 @@ x-webhooks: type: string enum: - locked - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144979,8 +147982,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -145077,8 +148080,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -145157,8 +148160,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -145967,8 +148970,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -146065,9 +149068,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *775 - organization: *749 - repository: *750 + milestone: *776 + organization: *750 + repository: *751 sender: *4 required: - action @@ -146930,8 +149933,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -147515,8 +150518,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -148300,8 +151303,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -148428,8 +151431,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -148509,9 +151512,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *747 - installation: *748 - issue: &776 + enterprise: *748 + installation: *749 + issue: &777 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -149297,8 +152300,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -149417,8 +152420,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -149497,8 +152500,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -150311,8 +153314,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -150410,8 +153413,8 @@ x-webhooks: user_view_type: type: string type: *248 - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -151280,8 +154283,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -151879,11 +154882,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *747 - installation: *748 - issue: *776 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + issue: *777 + organization: *750 + repository: *751 sender: *4 required: - action @@ -151963,12 +154966,12 @@ x-webhooks: type: string enum: - typed - enterprise: *747 - installation: *748 - issue: *774 + enterprise: *748 + installation: *749 + issue: *775 type: *248 - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -152049,7 +155052,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &805 + assignee: &806 title: User type: object nullable: true @@ -152119,11 +155122,11 @@ x-webhooks: required: - login - id - enterprise: *747 - installation: *748 - issue: *774 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + issue: *775 + organization: *750 + repository: *751 sender: *4 required: - action @@ -152202,12 +155205,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *747 - installation: *748 - issue: *774 - label: *768 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + issue: *775 + label: *769 + organization: *750 + repository: *751 sender: *4 required: - action @@ -152287,8 +155290,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -153101,8 +156104,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *682 - issue_dependencies_summary: *683 + sub_issues_summary: *683 + issue_dependencies_summary: *684 issue_field_values: type: array items: *563 @@ -153199,8 +156202,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -153280,11 +156283,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *747 - installation: *748 - issue: *776 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + issue: *777 + organization: *750 + repository: *751 sender: *4 required: - action @@ -153363,12 +156366,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *747 - installation: *748 - issue: *774 + enterprise: *748 + installation: *749 + issue: *775 type: *248 - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -153448,11 +156451,11 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - label: *768 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + label: *769 + organization: *750 + repository: *751 sender: *4 required: - action @@ -153530,11 +156533,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - label: *768 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + label: *769 + organization: *750 + repository: *751 sender: *4 required: - action @@ -153644,11 +156647,11 @@ x-webhooks: type: string required: - from - enterprise: *747 - installation: *748 - label: *768 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + label: *769 + organization: *750 + repository: *751 sender: *4 required: - action @@ -153730,9 +156733,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *747 - installation: *748 - marketplace_purchase: &777 + enterprise: *748 + installation: *749 + marketplace_purchase: &778 title: Marketplace Purchase type: object required: @@ -153815,8 +156818,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *749 - previous_marketplace_purchase: &778 + organization: *750 + previous_marketplace_purchase: &779 title: Marketplace Purchase type: object properties: @@ -153896,7 +156899,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *750 + repository: *751 sender: *4 required: - action @@ -153976,10 +156979,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *747 - installation: *748 - marketplace_purchase: *777 - organization: *749 + enterprise: *748 + installation: *749 + marketplace_purchase: *778 + organization: *750 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -154062,7 +157065,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *750 + repository: *751 sender: *4 required: - action @@ -154144,10 +157147,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *747 - installation: *748 - marketplace_purchase: *777 - organization: *749 + enterprise: *748 + installation: *749 + marketplace_purchase: *778 + organization: *750 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -154229,7 +157232,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *750 + repository: *751 sender: *4 required: - action @@ -154310,8 +157313,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 marketplace_purchase: title: Marketplace Purchase type: object @@ -154393,9 +157396,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *749 - previous_marketplace_purchase: *778 - repository: *750 + organization: *750 + previous_marketplace_purchase: *779 + repository: *751 sender: *4 required: - action @@ -154475,12 +157478,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *747 - installation: *748 - marketplace_purchase: *777 - organization: *749 - previous_marketplace_purchase: *778 - repository: *750 + enterprise: *748 + installation: *749 + marketplace_purchase: *778 + organization: *750 + previous_marketplace_purchase: *779 + repository: *751 sender: *4 required: - action @@ -154582,11 +157585,11 @@ x-webhooks: type: string required: - to - enterprise: *747 - installation: *748 - member: *769 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + member: *770 + organization: *750 + repository: *751 sender: *4 required: - action @@ -154686,11 +157689,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *747 - installation: *748 - member: *769 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + member: *770 + organization: *750 + repository: *751 sender: *4 required: - action @@ -154769,11 +157772,11 @@ x-webhooks: type: string enum: - removed - enterprise: *747 - installation: *748 - member: *769 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + member: *770 + organization: *750 + repository: *751 sender: *4 required: - action @@ -154851,11 +157854,11 @@ x-webhooks: type: string enum: - added - enterprise: *747 - installation: *748 - member: *769 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + member: *770 + organization: *750 + repository: *751 scope: description: The scope of the membership. Currently, can only be `team`. @@ -154931,7 +157934,7 @@ x-webhooks: required: - login - id - team: &779 + team: &780 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -155154,11 +158157,11 @@ x-webhooks: type: string enum: - removed - enterprise: *747 - installation: *748 - member: *769 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + member: *770 + organization: *750 + repository: *751 scope: description: The scope of the membership. Currently, can only be `team`. @@ -155235,7 +158238,7 @@ x-webhooks: required: - login - id - team: *779 + team: *780 required: - action - scope @@ -155317,8 +158320,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *748 - merge_group: &781 + installation: *749 + merge_group: &782 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -155337,15 +158340,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *780 + head_commit: *781 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -155431,10 +158434,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *748 - merge_group: *781 - organization: *749 - repository: *750 + installation: *749 + merge_group: *782 + organization: *750 + repository: *751 sender: *4 required: - action @@ -155507,7 +158510,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 + enterprise: *748 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -155616,16 +158619,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *748 - organization: *749 + installation: *749 + organization: *750 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *782 - required: *783 + properties: *783 + required: *784 nullable: true sender: *4 required: @@ -155706,11 +158709,11 @@ x-webhooks: type: string enum: - closed - enterprise: *747 - installation: *748 - milestone: *775 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + milestone: *776 + organization: *750 + repository: *751 sender: *4 required: - action @@ -155789,9 +158792,9 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - milestone: &784 + enterprise: *748 + installation: *749 + milestone: &785 title: Milestone description: A collection of related issues and pull requests. type: object @@ -155928,8 +158931,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -156008,11 +159011,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - milestone: *775 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + milestone: *776 + organization: *750 + repository: *751 sender: *4 required: - action @@ -156122,11 +159125,11 @@ x-webhooks: type: string required: - from - enterprise: *747 - installation: *748 - milestone: *775 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + milestone: *776 + organization: *750 + repository: *751 sender: *4 required: - action @@ -156206,11 +159209,11 @@ x-webhooks: type: string enum: - opened - enterprise: *747 - installation: *748 - milestone: *784 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + milestone: *785 + organization: *750 + repository: *751 sender: *4 required: - action @@ -156289,11 +159292,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *769 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + blocked_user: *770 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -156372,11 +159375,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *769 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + blocked_user: *770 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -156455,9 +159458,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - membership: &785 + enterprise: *748 + installation: *749 + membership: &786 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -156564,8 +159567,8 @@ x-webhooks: - role - organization_url - user - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 required: - action @@ -156643,11 +159646,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *747 - installation: *748 - membership: *785 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + membership: *786 + organization: *750 + repository: *751 sender: *4 required: - action @@ -156726,8 +159729,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -156843,10 +159846,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 - user: *769 + user: *770 required: - action - invitation @@ -156924,11 +159927,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *747 - installation: *748 - membership: *785 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + membership: *786 + organization: *750 + repository: *751 sender: *4 required: - action @@ -157015,11 +160018,11 @@ x-webhooks: properties: from: type: string - enterprise: *747 - installation: *748 - membership: *785 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + membership: *786 + organization: *750 + repository: *751 sender: *4 required: - action @@ -157096,9 +160099,9 @@ x-webhooks: type: string enum: - published - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 package: description: Information about the package. type: object @@ -157597,7 +160600,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &786 + items: &787 title: Ruby Gems metadata type: object properties: @@ -157692,7 +160695,7 @@ x-webhooks: - owner - package_version - registry - repository: *750 + repository: *751 sender: *4 required: - action @@ -157768,9 +160771,9 @@ x-webhooks: type: string enum: - updated - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 package: description: Information about the package. type: object @@ -158123,7 +161126,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *786 + items: *787 source_url: type: string format: uri @@ -158193,7 +161196,7 @@ x-webhooks: - owner - package_version - registry - repository: *750 + repository: *751 sender: *4 required: - action @@ -158369,12 +161372,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *747 + enterprise: *748 id: type: integer - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - id @@ -158451,7 +161454,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &787 + personal_access_token_request: &788 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -158597,10 +161600,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *747 - organization: *749 + enterprise: *748 + organization: *750 sender: *4 - installation: *748 + installation: *749 required: - action - personal_access_token_request @@ -158677,11 +161680,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *787 - enterprise: *747 - organization: *749 + personal_access_token_request: *788 + enterprise: *748 + organization: *750 sender: *4 - installation: *748 + installation: *749 required: - action - personal_access_token_request @@ -158757,11 +161760,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *787 - enterprise: *747 - organization: *749 + personal_access_token_request: *788 + enterprise: *748 + organization: *750 sender: *4 - installation: *748 + installation: *749 required: - action - personal_access_token_request @@ -158836,11 +161839,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *787 - organization: *749 - enterprise: *747 + personal_access_token_request: *788 + organization: *750 + enterprise: *748 sender: *4 - installation: *748 + installation: *749 required: - action - personal_access_token_request @@ -158945,7 +161948,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *788 + last_response: *789 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -158977,8 +161980,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 zen: description: Random string of GitHub zen. @@ -159223,10 +162226,10 @@ x-webhooks: - from required: - note - enterprise: *747 - installation: *748 - organization: *749 - project_card: &789 + enterprise: *748 + installation: *749 + organization: *750 + project_card: &790 title: Project Card type: object properties: @@ -159345,7 +162348,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *750 + repository: *751 sender: *4 required: - action @@ -159426,11 +162429,11 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - project_card: *789 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + project_card: *790 + repository: *751 sender: *4 required: - action @@ -159510,9 +162513,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 project_card: title: Project Card type: object @@ -159640,8 +162643,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *782 - required: *783 + properties: *783 + required: *784 nullable: true sender: *4 required: @@ -159735,11 +162738,11 @@ x-webhooks: - from required: - note - enterprise: *747 - installation: *748 - organization: *749 - project_card: *789 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + project_card: *790 + repository: *751 sender: *4 required: - action @@ -159833,9 +162836,9 @@ x-webhooks: - from required: - column_id - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 project_card: allOf: - title: Project Card @@ -160025,7 +163028,7 @@ x-webhooks: type: string required: - after_id - repository: *750 + repository: *751 sender: *4 required: - action @@ -160105,10 +163108,10 @@ x-webhooks: type: string enum: - closed - enterprise: *747 - installation: *748 - organization: *749 - project: &791 + enterprise: *748 + installation: *749 + organization: *750 + project: &792 title: Project type: object properties: @@ -160232,7 +163235,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *750 + repository: *751 sender: *4 required: - action @@ -160312,10 +163315,10 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - project_column: &790 + enterprise: *748 + installation: *749 + organization: *750 + project_column: &791 title: Project Column type: object properties: @@ -160354,7 +163357,7 @@ x-webhooks: - name - created_at - updated_at - repository: *750 + repository: *751 sender: *4 required: - action @@ -160433,18 +163436,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - project_column: *790 + enterprise: *748 + installation: *749 + organization: *750 + project_column: *791 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *782 - required: *783 + properties: *783 + required: *784 nullable: true sender: *4 required: @@ -160534,11 +163537,11 @@ x-webhooks: type: string required: - from - enterprise: *747 - installation: *748 - organization: *749 - project_column: *790 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + project_column: *791 + repository: *751 sender: *4 required: - action @@ -160618,11 +163621,11 @@ x-webhooks: type: string enum: - moved - enterprise: *747 - installation: *748 - organization: *749 - project_column: *790 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + project_column: *791 + repository: *751 sender: *4 required: - action @@ -160702,11 +163705,11 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - project: *791 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + project: *792 + repository: *751 sender: *4 required: - action @@ -160786,18 +163789,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - project: *791 + enterprise: *748 + installation: *749 + organization: *750 + project: *792 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *782 - required: *783 + properties: *783 + required: *784 nullable: true sender: *4 required: @@ -160899,11 +163902,11 @@ x-webhooks: type: string required: - from - enterprise: *747 - installation: *748 - organization: *749 - project: *791 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + project: *792 + repository: *751 sender: *4 required: - action @@ -160982,11 +163985,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *747 - installation: *748 - organization: *749 - project: *791 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + project: *792 + repository: *751 sender: *4 required: - action @@ -161067,8 +164070,8 @@ x-webhooks: type: string enum: - closed - installation: *748 - organization: *749 + installation: *749 + organization: *750 projects_v2: *282 sender: *4 required: @@ -161150,8 +164153,8 @@ x-webhooks: type: string enum: - created - installation: *748 - organization: *749 + installation: *749 + organization: *750 projects_v2: *282 sender: *4 required: @@ -161233,8 +164236,8 @@ x-webhooks: type: string enum: - deleted - installation: *748 - organization: *749 + installation: *749 + organization: *750 projects_v2: *282 sender: *4 required: @@ -161352,8 +164355,8 @@ x-webhooks: type: string to: type: string - installation: *748 - organization: *749 + installation: *749 + organization: *750 projects_v2: *282 sender: *4 required: @@ -161437,7 +164440,7 @@ x-webhooks: type: string enum: - archived - changes: &795 + changes: &796 type: object properties: archived_at: @@ -161451,9 +164454,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *748 - organization: *749 - projects_v2_item: &792 + installation: *749 + organization: *750 + projects_v2_item: &793 title: Projects v2 Item description: An item belonging to a project type: object @@ -161588,9 +164591,9 @@ x-webhooks: nullable: true to: type: string - installation: *748 - organization: *749 - projects_v2_item: *792 + installation: *749 + organization: *750 + projects_v2_item: *793 sender: *4 required: - action @@ -161672,9 +164675,9 @@ x-webhooks: type: string enum: - created - installation: *748 - organization: *749 - projects_v2_item: *792 + installation: *749 + organization: *750 + projects_v2_item: *793 sender: *4 required: - action @@ -161755,9 +164758,9 @@ x-webhooks: type: string enum: - deleted - installation: *748 - organization: *749 - projects_v2_item: *792 + installation: *749 + organization: *750 + projects_v2_item: *793 sender: *4 required: - action @@ -161863,7 +164866,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &793 + - &794 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -161885,7 +164888,7 @@ x-webhooks: required: - id - name - - &794 + - &795 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -161919,8 +164922,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *793 - *794 + - *795 required: - field_value - type: object @@ -161936,9 +164939,9 @@ x-webhooks: nullable: true required: - body - installation: *748 - organization: *749 - projects_v2_item: *792 + installation: *749 + organization: *750 + projects_v2_item: *793 sender: *4 required: - action @@ -162033,9 +165036,9 @@ x-webhooks: to: type: string nullable: true - installation: *748 - organization: *749 - projects_v2_item: *792 + installation: *749 + organization: *750 + projects_v2_item: *793 sender: *4 required: - action @@ -162118,10 +165121,10 @@ x-webhooks: type: string enum: - restored - changes: *795 - installation: *748 - organization: *749 - projects_v2_item: *792 + changes: *796 + installation: *749 + organization: *750 + projects_v2_item: *793 sender: *4 required: - action @@ -162203,8 +165206,8 @@ x-webhooks: type: string enum: - reopened - installation: *748 - organization: *749 + installation: *749 + organization: *750 projects_v2: *282 sender: *4 required: @@ -162286,14 +165289,14 @@ x-webhooks: type: string enum: - created - installation: *748 - organization: *749 - projects_v2_status_update: &798 + installation: *749 + organization: *750 + projects_v2_status_update: &799 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *796 - required: *797 + properties: *797 + required: *798 sender: *4 required: - action @@ -162374,9 +165377,9 @@ x-webhooks: type: string enum: - deleted - installation: *748 - organization: *749 - projects_v2_status_update: *798 + installation: *749 + organization: *750 + projects_v2_status_update: *799 sender: *4 required: - action @@ -162512,9 +165515,9 @@ x-webhooks: type: string format: date nullable: true - installation: *748 - organization: *749 - projects_v2_status_update: *798 + installation: *749 + organization: *750 + projects_v2_status_update: *799 sender: *4 required: - action @@ -162585,10 +165588,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - repository @@ -162665,13 +165668,13 @@ x-webhooks: type: string enum: - assigned - assignee: *769 - enterprise: *747 - installation: *748 - number: &799 + assignee: *770 + enterprise: *748 + installation: *749 + number: &800 description: The pull request number. type: integer - organization: *749 + organization: *750 pull_request: title: Pull Request type: object @@ -164958,7 +167961,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 sender: *4 required: - action @@ -165040,11 +168043,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 number: type: integer - organization: *749 + organization: *750 pull_request: title: Pull Request type: object @@ -167326,7 +170329,7 @@ x-webhooks: - draft reason: type: string - repository: *750 + repository: *751 sender: *4 required: - action @@ -167408,11 +170411,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 number: type: integer - organization: *749 + organization: *750 pull_request: title: Pull Request type: object @@ -169694,7 +172697,7 @@ x-webhooks: - draft reason: type: string - repository: *750 + repository: *751 sender: *4 required: - action @@ -169776,11 +172779,11 @@ x-webhooks: type: string enum: - closed - enterprise: *747 - installation: *748 - number: *799 - organization: *749 - pull_request: &800 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 + pull_request: &801 allOf: - *602 - type: object @@ -169844,7 +172847,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *750 + repository: *751 sender: *4 required: - action @@ -169925,12 +172928,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *747 - installation: *748 - number: *799 - organization: *749 - pull_request: *800 - repository: *750 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 + pull_request: *801 + repository: *751 sender: *4 required: - action @@ -170010,11 +173013,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *747 + enterprise: *748 milestone: *586 - number: *799 - organization: *749 - pull_request: &801 + number: *800 + organization: *750 + pull_request: &802 title: Pull Request type: object properties: @@ -172295,7 +175298,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 sender: *4 required: - action @@ -172374,11 +175377,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 number: type: integer - organization: *749 + organization: *750 pull_request: title: Pull Request type: object @@ -174678,7 +177681,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *750 + repository: *751 sender: *4 required: - action @@ -174802,12 +177805,12 @@ x-webhooks: type: string required: - from - enterprise: *747 - installation: *748 - number: *799 - organization: *749 - pull_request: *800 - repository: *750 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 + pull_request: *801 + repository: *751 sender: *4 required: - action @@ -174887,11 +177890,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 number: type: integer - organization: *749 + organization: *750 pull_request: title: Pull Request type: object @@ -177176,7 +180179,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 sender: *4 required: - action @@ -177256,11 +180259,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *747 - installation: *748 - label: *768 - number: *799 - organization: *749 + enterprise: *748 + installation: *749 + label: *769 + number: *800 + organization: *750 pull_request: title: Pull Request type: object @@ -179546,7 +182549,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 sender: *4 required: - action @@ -179627,10 +182630,10 @@ x-webhooks: type: string enum: - locked - enterprise: *747 - installation: *748 - number: *799 - organization: *749 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 pull_request: title: Pull Request type: object @@ -181914,7 +184917,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 sender: *4 required: - action @@ -181994,12 +184997,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *747 + enterprise: *748 milestone: *586 - number: *799 - organization: *749 - pull_request: *801 - repository: *750 + number: *800 + organization: *750 + pull_request: *802 + repository: *751 sender: *4 required: - action @@ -182078,12 +185081,12 @@ x-webhooks: type: string enum: - opened - enterprise: *747 - installation: *748 - number: *799 - organization: *749 - pull_request: *800 - repository: *750 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 + pull_request: *801 + repository: *751 sender: *4 required: - action @@ -182164,12 +185167,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *747 - installation: *748 - number: *799 - organization: *749 - pull_request: *800 - repository: *750 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 + pull_request: *801 + repository: *751 sender: *4 required: - action @@ -182249,12 +185252,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *747 - installation: *748 - number: *799 - organization: *749 - pull_request: *800 - repository: *750 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 + pull_request: *801 + repository: *751 sender: *4 required: - action @@ -182620,9 +185623,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 pull_request: type: object properties: @@ -184796,7 +187799,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *750 + repository: *751 sender: *4 required: - action @@ -184876,7 +187879,7 @@ x-webhooks: type: string enum: - deleted - comment: &803 + comment: &804 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -185161,9 +188164,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 pull_request: type: object properties: @@ -187325,7 +190328,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *750 + repository: *751 sender: *4 required: - action @@ -187405,11 +190408,11 @@ x-webhooks: type: string enum: - edited - changes: *802 - comment: *803 - enterprise: *747 - installation: *748 - organization: *749 + changes: *803 + comment: *804 + enterprise: *748 + installation: *749 + organization: *750 pull_request: type: object properties: @@ -189574,7 +192577,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *750 + repository: *751 sender: *4 required: - action @@ -189655,9 +192658,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 pull_request: title: Simple Pull Request type: object @@ -191834,7 +194837,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *750 + repository: *751 review: description: The review that was affected. type: object @@ -192081,9 +195084,9 @@ x-webhooks: type: string required: - from - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 pull_request: title: Simple Pull Request type: object @@ -194133,8 +197136,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *750 - review: &804 + repository: *751 + review: &805 description: The review that was affected. type: object properties: @@ -194367,12 +197370,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 number: description: The pull request number. type: integer - organization: *749 + organization: *750 pull_request: title: Pull Request type: object @@ -196659,7 +199662,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 requested_reviewer: title: User type: object @@ -196743,12 +199746,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 number: description: The pull request number. type: integer - organization: *749 + organization: *750 pull_request: title: Pull Request type: object @@ -199042,7 +202045,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 requested_team: title: Team description: Groups of organization members that gives permissions @@ -199234,12 +202237,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 number: description: The pull request number. type: integer - organization: *749 + organization: *750 pull_request: title: Pull Request type: object @@ -201528,7 +204531,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 requested_reviewer: title: User type: object @@ -201613,12 +204616,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *747 - installation: *748 + enterprise: *748 + installation: *749 number: description: The pull request number. type: integer - organization: *749 + organization: *750 pull_request: title: Pull Request type: object @@ -203898,7 +206901,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 requested_team: title: Team description: Groups of organization members that gives permissions @@ -204079,9 +207082,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 pull_request: title: Simple Pull Request type: object @@ -206260,8 +209263,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *750 - review: *804 + repository: *751 + review: *805 sender: *4 required: - action @@ -206341,9 +209344,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 pull_request: title: Simple Pull Request type: object @@ -208431,7 +211434,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *750 + repository: *751 sender: *4 thread: type: object @@ -208818,9 +211821,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 pull_request: title: Simple Pull Request type: object @@ -210894,7 +213897,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *750 + repository: *751 sender: *4 thread: type: object @@ -211284,10 +214287,10 @@ x-webhooks: type: string before: type: string - enterprise: *747 - installation: *748 - number: *799 - organization: *749 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 pull_request: title: Pull Request type: object @@ -213562,7 +216565,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 sender: *4 required: - action @@ -213644,11 +216647,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *805 - enterprise: *747 - installation: *748 - number: *799 - organization: *749 + assignee: *806 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 pull_request: title: Pull Request type: object @@ -215935,7 +218938,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 sender: *4 required: - action @@ -216014,11 +219017,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *747 - installation: *748 - label: *768 - number: *799 - organization: *749 + enterprise: *748 + installation: *749 + label: *769 + number: *800 + organization: *750 pull_request: title: Pull Request type: object @@ -218295,7 +221298,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 sender: *4 required: - action @@ -218376,10 +221379,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *747 - installation: *748 - number: *799 - organization: *749 + enterprise: *748 + installation: *749 + number: *800 + organization: *750 pull_request: title: Pull Request type: object @@ -220648,7 +223651,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *751 sender: *4 required: - action @@ -220848,7 +223851,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *747 + enterprise: *748 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -220940,8 +223943,8 @@ x-webhooks: - url - author - committer - installation: *748 - organization: *749 + installation: *749 + organization: *750 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -221527,9 +224530,9 @@ x-webhooks: type: string enum: - published - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 registry_package: type: object properties: @@ -221975,7 +224978,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *786 + items: *787 summary: type: string tag_name: @@ -222029,7 +225032,7 @@ x-webhooks: - owner - package_version - registry - repository: *750 + repository: *751 sender: *4 required: - action @@ -222107,9 +225110,9 @@ x-webhooks: type: string enum: - updated - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 registry_package: type: object properties: @@ -222417,7 +225420,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *786 + items: *787 summary: type: string tag_name: @@ -222466,7 +225469,7 @@ x-webhooks: - owner - package_version - registry - repository: *750 + repository: *751 sender: *4 required: - action @@ -222543,10 +225546,10 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - release: &806 + enterprise: *748 + installation: *749 + organization: *750 + release: &807 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -222864,7 +225867,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *750 + repository: *751 sender: *4 required: - action @@ -222941,11 +225944,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - release: *806 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + release: *807 + repository: *751 sender: *4 required: - action @@ -223062,11 +226065,11 @@ x-webhooks: type: boolean required: - to - enterprise: *747 - installation: *748 - organization: *749 - release: *806 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + release: *807 + repository: *751 sender: *4 required: - action @@ -223144,9 +226147,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -223468,7 +226471,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *750 + repository: *751 sender: *4 required: - action @@ -223544,10 +226547,10 @@ x-webhooks: type: string enum: - published - enterprise: *747 - installation: *748 - organization: *749 - release: &807 + enterprise: *748 + installation: *749 + organization: *750 + release: &808 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -223866,7 +226869,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *750 + repository: *751 sender: *4 required: - action @@ -223942,11 +226945,11 @@ x-webhooks: type: string enum: - released - enterprise: *747 - installation: *748 - organization: *749 - release: *806 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + release: *807 + repository: *751 sender: *4 required: - action @@ -224022,11 +227025,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *747 - installation: *748 - organization: *749 - release: *807 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + release: *808 + repository: *751 sender: *4 required: - action @@ -224102,11 +227105,11 @@ x-webhooks: type: string enum: - published - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - repository_advisory: *669 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 + repository_advisory: *670 sender: *4 required: - action @@ -224182,11 +227185,11 @@ x-webhooks: type: string enum: - reported - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - repository_advisory: *669 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 + repository_advisory: *670 sender: *4 required: - action @@ -224262,10 +227265,10 @@ x-webhooks: type: string enum: - archived - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -224342,10 +227345,10 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -224423,10 +227426,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -224510,10 +227513,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -224625,10 +227628,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -224700,10 +227703,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 status: type: string @@ -224784,10 +227787,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -224864,10 +227867,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -224961,10 +227964,10 @@ x-webhooks: - name required: - repository - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -225044,10 +228047,10 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 repository_ruleset: *330 sender: *4 required: @@ -225126,10 +228129,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 repository_ruleset: *330 sender: *4 required: @@ -225208,10 +228211,10 @@ x-webhooks: type: string enum: - edited - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 repository_ruleset: *330 changes: type: object @@ -225516,10 +228519,10 @@ x-webhooks: - from required: - owner - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -225597,10 +228600,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -225678,7 +228681,7 @@ x-webhooks: type: string enum: - create - alert: &808 + alert: &809 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -225800,10 +228803,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -226009,10 +229012,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -226090,11 +229093,11 @@ x-webhooks: type: string enum: - reopen - alert: *808 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *809 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -226293,10 +229296,10 @@ x-webhooks: enum: - fixed - open - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -226374,7 +229377,7 @@ x-webhooks: type: string enum: - assigned - alert: &809 + alert: &810 type: object properties: number: *179 @@ -226517,10 +229520,10 @@ x-webhooks: required: *21 nullable: true assignee: *4 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -226598,11 +229601,11 @@ x-webhooks: type: string enum: - created - alert: *809 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *810 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -226683,11 +229686,11 @@ x-webhooks: type: string enum: - created - alert: *809 - installation: *748 - location: *810 - organization: *749 - repository: *750 + alert: *810 + installation: *749 + location: *811 + organization: *750 + repository: *751 sender: *4 required: - location @@ -226925,11 +229928,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *809 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *810 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -227007,11 +230010,11 @@ x-webhooks: type: string enum: - reopened - alert: *809 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *810 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -227089,11 +230092,11 @@ x-webhooks: type: string enum: - resolved - alert: *809 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *810 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -227171,12 +230174,12 @@ x-webhooks: type: string enum: - unassigned - alert: *809 + alert: *810 assignee: *4 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -227254,11 +230257,11 @@ x-webhooks: type: string enum: - validated - alert: *809 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *810 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -227384,10 +230387,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *750 - enterprise: *747 - installation: *748 - organization: *749 + repository: *751 + enterprise: *748 + installation: *749 + organization: *750 sender: *4 required: - action @@ -227465,11 +230468,11 @@ x-webhooks: type: string enum: - published - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - security_advisory: &811 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 + security_advisory: &812 description: The details of the security advisory, including summary, description, and severity. type: object @@ -227640,11 +230643,11 @@ x-webhooks: type: string enum: - updated - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - security_advisory: *811 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 + security_advisory: *812 sender: *4 required: - action @@ -227717,10 +230720,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -227893,9 +230896,9 @@ x-webhooks: type: object properties: security_and_analysis: *303 - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 repository: *351 sender: *4 required: @@ -227974,12 +230977,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - sponsorship: &812 + sponsorship: &813 type: object properties: created_at: @@ -228280,12 +231283,12 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - sponsorship: *812 + sponsorship: *813 required: - action - sponsorship @@ -228373,12 +231376,12 @@ x-webhooks: type: string required: - from - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - sponsorship: *812 + sponsorship: *813 required: - action - changes @@ -228455,17 +231458,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &813 + effective_date: &814 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: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - sponsorship: *812 + sponsorship: *813 required: - action - sponsorship @@ -228539,7 +231542,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &814 + changes: &815 type: object properties: tier: @@ -228583,13 +231586,13 @@ x-webhooks: - from required: - tier - effective_date: *813 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + effective_date: *814 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - sponsorship: *812 + sponsorship: *813 required: - action - changes @@ -228666,13 +231669,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *814 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + changes: *815 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - sponsorship: *812 + sponsorship: *813 required: - action - changes @@ -228746,10 +231749,10 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -228832,10 +231835,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -229255,15 +232258,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *747 + enterprise: *748 id: description: The unique identifier of the status. type: integer - installation: *748 + installation: *749 name: type: string - organization: *749 - repository: *750 + organization: *750 + repository: *751 sender: *4 sha: description: The Commit SHA. @@ -229378,9 +232381,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *88 - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -229470,9 +232473,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *88 - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -229562,9 +232565,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *88 - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -229654,9 +232657,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *88 - installation: *748 - organization: *749 - repository: *750 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -229733,12 +232736,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - team: &815 + team: &816 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -229961,9 +232964,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 repository: title: Repository description: A git repository @@ -230421,7 +233424,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *815 + team: *816 required: - action - team @@ -230497,9 +233500,9 @@ x-webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 repository: title: Repository description: A git repository @@ -230957,7 +233960,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *815 + team: *816 required: - action - team @@ -231034,9 +234037,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 repository: title: Repository description: A git repository @@ -231494,7 +234497,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *815 + team: *816 required: - action - team @@ -231638,9 +234641,9 @@ x-webhooks: - from required: - permissions - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 repository: title: Repository description: A git repository @@ -232098,7 +235101,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *815 + team: *816 required: - action - changes @@ -232176,9 +235179,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *748 + installation: *749 + organization: *750 repository: title: Repository description: A git repository @@ -232636,7 +235639,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *815 + team: *816 required: - action - team @@ -232712,10 +235715,10 @@ x-webhooks: type: string enum: - started - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 required: - action @@ -232788,16 +235791,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *747 + enterprise: *748 inputs: type: object nullable: true additionalProperties: true - installation: *748 - organization: *749 + installation: *749 + organization: *750 ref: type: string - repository: *750 + repository: *751 sender: *4 workflow: type: string @@ -232879,10 +235882,10 @@ x-webhooks: type: string enum: - completed - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 workflow_job: allOf: @@ -233198,10 +236201,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 workflow_job: allOf: @@ -233540,10 +236543,10 @@ x-webhooks: type: string enum: - queued - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 workflow_job: type: object @@ -233757,10 +236760,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 workflow_job: type: object @@ -233976,12 +236979,12 @@ x-webhooks: type: string enum: - completed - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - workflow: *764 + workflow: *765 workflow_run: title: Workflow Run type: object @@ -234980,12 +237983,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - workflow: *764 + workflow: *765 workflow_run: title: Workflow Run type: object @@ -235969,12 +238972,12 @@ x-webhooks: type: string enum: - requested - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *748 + installation: *749 + organization: *750 + repository: *751 sender: *4 - workflow: *764 + workflow: *765 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 5119ba920..6994b4e70 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -2152,6 +2152,3164 @@ } } }, + "/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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", @@ -94844,7 +98002,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" ], @@ -94903,20 +98061,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, "example": "1.2.3" @@ -174520,7 +177678,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -174601,6 +177760,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" @@ -174745,7 +177912,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" ], @@ -174834,7 +178001,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", @@ -174842,7 +178009,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -174878,7 +178046,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": { @@ -174896,6 +178064,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": [ @@ -174954,6 +178130,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" + } } } } @@ -175003,7 +178190,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -175090,412 +178278,429 @@ "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": { - "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": { - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "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": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "key_id", - "key" - ], - "properties": { - "key_id": { - "description": "The identifier for the key.", - "example": "012345678912345678", - "type": "string" - }, - "key": { - "description": "The Base64 encoded public key.", - "example": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", - "type": "string" - } - } - }, - "examples": { - "default": { - "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "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" - } - } - } - } - } - } - }, - "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": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The specified private registry configuration for the organization", - "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.", - "example": "MAVEN_REPOSITORY_SECRET", - "type": "string" - }, - "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" - ], + "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": { + "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": { + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key_id", + "key" + ], + "properties": { + "key_id": { + "description": "The identifier for the key.", + "example": "012345678912345678", + "type": "string" + }, + "key": { + "description": "The Base64 encoded public key.", + "example": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "type": "string" + } + } + }, + "examples": { + "default": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "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" + } + } + } + } + } + } + }, + "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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "The specified private registry configuration for the organization", + "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.", + "example": "MAVEN_REPOSITORY_SECRET", + "type": "string" + }, + "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.", + "example": "monalisa", + "type": "string", + "nullable": true + }, + "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.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "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" }, - "url": { - "description": "The URL of the private registry.", - "type": "string", - "format": "uri" - }, - "username": { - "description": "The username to use when authenticating with the private registry.", - "example": "monalisa", - "type": "string", - "nullable": true - }, - "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.", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "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.", + "service_account": { + "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).", "type": "string" }, "created_at": { @@ -175566,7 +178771,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" ], @@ -175672,7 +178877,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -175708,7 +178914,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": { @@ -175726,6 +178932,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" } } }, @@ -219567,6 +222781,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": { @@ -244823,25 +248046,525 @@ } }, { - "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", + "format": "date-time", + "nullable": true + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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", + "format": "uri", + "description": "API URL for the workflow run.", + "nullable": true + }, + "run_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the workflow run.", + "nullable": true + }, + "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", + "format": "uri", + "description": "API URL for the job.", + "nullable": true + }, + "job_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the job.", + "nullable": true + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "concurrency-groups" } } }, @@ -260091,99 +263814,374 @@ } }, { - "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", + "format": "uri", + "description": "API URL for the workflow run.", + "nullable": true + }, + "run_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the workflow run.", + "nullable": true + }, + "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", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease.", + "nullable": true + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease.", + "nullable": true + }, + "job_url": { + "type": "string", + "format": "uri", + "description": "API URL for the job.", + "nullable": true + }, + "job_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the job.", + "nullable": true + }, + "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": { @@ -260207,13 +264205,82 @@ } } } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "workflow-runs" + "subcategory": "concurrency-groups" } } }, @@ -548554,6 +552621,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": { @@ -552417,6 +556493,9 @@ "400": { "description": "Bad request, resolution comment is invalid or the resolution was not changed." }, + "403": { + "description": "Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer." + }, "404": { "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index c5b6a3f96..fbaa9850c 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -1079,7 +1079,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &674 + - &675 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1175,6 +1175,2525 @@ 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 @@ -11666,7 +14185,7 @@ paths: properties: action: type: string - discussion: &768 + discussion: &769 title: Discussion description: A Discussion in a repository. type: object @@ -12409,7 +14928,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &685 + sub_issues_summary: &686 title: Sub-issues Summary type: object properties: @@ -12522,7 +15041,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &686 + issue_dependencies_summary: &687 title: Issue Dependencies Summary type: object properties: @@ -14038,7 +16557,7 @@ paths: url: type: string format: uri - user: &692 + user: &693 title: Public User description: Public User type: object @@ -19280,7 +21799,7 @@ paths: required: false schema: type: string - - &743 + - &744 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -19426,7 +21945,7 @@ paths: parameters: - *78 - *124 - - &744 + - &745 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 @@ -19538,7 +22057,7 @@ paths: - *124 - *126 - *125 - - &745 + - &746 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -19546,7 +22065,7 @@ paths: schema: type: string - *127 - - &746 + - &747 name: sku description: The SKU to query for usage. in: query @@ -25768,6 +28287,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 @@ -25810,24 +28333,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 example: 1.2.3 @@ -26288,12 +28805,12 @@ paths: required: - subject_digests examples: - default: &724 + default: &725 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &725 + withPredicateType: &726 value: subject_digests: - sha256:abc123 @@ -26351,7 +28868,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &726 + default: &727 value: attestations_subject_digests: - sha256:abc: @@ -38827,7 +41344,7 @@ paths: parameters: - *78 - *261 - - &707 + - &708 name: repo_name description: repo_name parameter in: path @@ -39886,7 +42403,7 @@ paths: - nuget - container - *78 - - &708 + - &709 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -39927,7 +42444,7 @@ paths: default: *268 '403': *29 '401': *25 - '400': &710 + '400': &711 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -41131,6 +43648,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -41199,6 +43717,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 @@ -41236,7 +43763,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: @@ -41329,7 +43856,472 @@ 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. + example: MAVEN_REPOSITORY_SECRET + type: string + 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. + example: monalisa + type: string + 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: &282 + 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: + - *78 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - key_id + - key + properties: + key_id: + description: The identifier for the key. + example: '012345678912345678' + type: string + key: + description: The Base64 encoded public key. + example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + type: string + examples: + default: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + headers: + Link: *70 + '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: + - *78 + - *169 + responses: + '200': + description: The specified private registry configuration for the organization + content: + application/json: + schema: *281 + examples: + default: *282 + '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: + - *78 + - *169 + 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 + nullable: true + 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 @@ -41338,6 +44330,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`. @@ -41370,7 +44363,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` @@ -41388,440 +44381,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. - example: MAVEN_REPOSITORY_SECRET - type: string - 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. - example: monalisa - type: string - 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: &282 - 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: - - *78 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - key_id - - key - properties: - key_id: - description: The identifier for the key. - example: '012345678912345678' - type: string - key: - description: The Base64 encoded public key. - example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - type: string - examples: - default: - value: - key_id: '012345678912345678' - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - headers: - Link: *70 - '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: - - *78 - - *169 - responses: - '200': - description: The specified private registry configuration for the organization - content: - application/json: - schema: *281 - examples: - default: *282 - '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: - - *78 - - *169 - 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 - nullable: true - 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. + 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: - - 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: @@ -41973,7 +44541,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &800 + properties: &801 id: type: number description: The unique identifier of the status update. @@ -42021,7 +44589,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &801 + required: &802 - id - node_id - created_at @@ -42911,7 +45479,7 @@ paths: - updated_at - project_url examples: - default: &730 + default: &731 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -43088,7 +45656,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &731 + items: &732 type: object properties: name: @@ -43125,7 +45693,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &732 + iteration_configuration: &733 type: object description: The configuration for iteration fields. properties: @@ -43175,7 +45743,7 @@ paths: value: name: Due date data_type: date - single_select_field: &733 + single_select_field: &734 summary: Create a single select field value: name: Priority @@ -43202,7 +45770,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &734 + iteration_field: &735 summary: Create an iteration field value: name: Sprint @@ -43228,7 +45796,7 @@ paths: application/json: schema: *289 examples: - text_field: &735 + text_field: &736 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -43237,7 +45805,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: &736 + number_field: &737 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -43246,7 +45814,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: &737 + date_field: &738 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -43255,7 +45823,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: &738 + single_select_field: &739 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -43289,7 +45857,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &739 + iteration_field: &740 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -43335,7 +45903,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *285 - - &740 + - &741 name: field_id description: The unique identifier of the field. in: path @@ -43350,7 +45918,7 @@ paths: application/json: schema: *289 examples: - default: &741 + default: &742 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -44547,7 +47115,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &721 + schema: &722 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -44724,7 +47292,7 @@ paths: parameters: - *285 - *78 - - &742 + - &743 name: view_number description: The number that identifies the project view. in: path @@ -48757,6 +51325,17 @@ paths: schema: type: boolean default: false + - &652 + 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 @@ -48783,14 +51362,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &652 + state: &653 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: &653 + resolution: &654 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -48907,8 +51486,8 @@ paths: pull request. ' - oneOf: &654 - - &656 + oneOf: &655 + - &657 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -48966,7 +51545,7 @@ paths: - blob_url - commit_sha - commit_url - - &657 + - &658 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. @@ -49021,7 +51600,7 @@ paths: - page_url - commit_sha - commit_url - - &658 + - &659 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -49041,7 +51620,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &659 + - &660 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -49061,7 +51640,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &660 + - &661 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -49081,7 +51660,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &661 + - &662 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -49095,7 +51674,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &662 + - &663 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -49109,7 +51688,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &663 + - &664 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -49123,7 +51702,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &664 + - &665 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. @@ -49143,7 +51722,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &665 + - &666 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. @@ -49163,7 +51742,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &666 + - &667 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. @@ -49183,7 +51762,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &667 + - &668 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. @@ -49203,7 +51782,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &668 + - &669 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 request. @@ -49722,7 +52301,7 @@ paths: application/json: schema: type: array - items: &672 + items: &673 description: A repository security advisory. type: object properties: @@ -50045,7 +52624,7 @@ paths: - private_fork version: '2026-03-10' examples: - default: &673 + default: &674 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -52043,7 +54622,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &688 + response-if-user-is-a-team-maintainer: &689 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -52108,7 +54687,7 @@ paths: application/json: schema: *349 examples: - response-if-users-membership-with-team-is-now-pending: &689 + response-if-users-membership-with-team-is-now-pending: &690 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -52222,7 +54801,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &690 + schema: &691 title: Team Repository description: A team's access to a repository. type: object @@ -52964,7 +55543,7 @@ paths: type: array items: *201 examples: - response-if-child-teams-exist: &691 + response-if-child-teams-exist: &692 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -54816,6 +57395,240 @@ 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: + - *350 + - *351 + - *17 + - *48 + 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 + format: date-time + nullable: true + 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: *70 + '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: + - *350 + - *351 + - 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 + format: uri + description: API URL for the workflow run. + nullable: true + run_html_url: + type: string + format: uri + description: Web URL for the workflow run. + nullable: true + 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 + format: uri + description: API URL for the job. + nullable: true + job_html_url: + type: string + format: uri + description: Web URL for the job. + nullable: true + 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 @@ -57767,6 +60580,192 @@ 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: + - *350 + - *351 + - *388 + - *17 + - *47 + - *48 + 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 + format: uri + description: API URL for the workflow run. + nullable: true + run_html_url: + type: string + format: uri + description: Web URL for the workflow run. + nullable: true + 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 + description: The ID of the job, when the item represents + a job-level or reusable-workflow-level lease. + nullable: true + job_name: + type: string + description: The display name of the job, when the + item represents a job-level or reusable-workflow-level + lease. + nullable: true + job_url: + type: string + format: uri + description: API URL for the job. + nullable: true + job_html_url: + type: string + format: uri + description: Web URL for the job. + nullable: true + 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: *70 + '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 @@ -58206,7 +61205,7 @@ paths: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &762 + properties: &763 url: type: string format: uri @@ -58291,7 +61290,7 @@ paths: nullable: true properties: *83 required: *84 - required: &763 + required: &764 - id - node_id - sha @@ -63925,7 +66924,7 @@ paths: check. type: array items: *93 - deployment: &755 + deployment: &756 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -64837,7 +67836,7 @@ paths: type: string format: date-time nullable: true - head_commit: &783 + head_commit: &784 title: Simple Commit description: A commit. type: object @@ -69125,14 +72124,14 @@ paths: type: integer machines: type: array - items: &697 + items: &698 type: object title: Codespace machine description: A description of the machine powering a codespace. properties: *472 required: *473 examples: - default: &698 + default: &699 value: total_count: 2 machines: @@ -72278,7 +75277,7 @@ paths: application/json: schema: type: array - items: &677 + items: &678 title: Status description: The status of a commit. type: object @@ -73891,7 +76890,7 @@ paths: items: type: object properties: - placeholder_id: &669 + placeholder_id: &670 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -79749,7 +82748,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &792 + last_response: &793 title: Hook Response type: object properties: @@ -80801,7 +83800,7 @@ paths: parameters: - *350 - *351 - - &719 + - &720 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -81235,7 +84234,7 @@ paths: type: array items: *552 examples: - default: &712 + default: &713 value: - id: 1 repository: @@ -95673,6 +98672,7 @@ paths: - *649 - *650 - *651 + - *652 responses: '200': description: Response @@ -95680,7 +98680,7 @@ paths: application/json: schema: type: array - items: &655 + items: &656 type: object properties: number: *179 @@ -95699,8 +98699,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *652 - resolution: *653 + state: *653 + resolution: *654 resolved_at: type: string format: date-time @@ -95806,7 +98806,7 @@ paths: pull request. ' - oneOf: *654 + oneOf: *655 nullable: true has_more_locations: type: boolean @@ -95979,7 +98979,7 @@ paths: description: Response content: application/json: - schema: *655 + schema: *656 examples: default: value: @@ -96043,8 +99043,8 @@ paths: schema: type: object properties: - state: *652 - resolution: *653 + state: *653 + resolution: *654 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -96088,7 +99088,7 @@ paths: description: Response content: application/json: - schema: *655 + schema: *656 examples: default: value: @@ -96155,6 +99155,9 @@ paths: '400': description: Bad request, resolution comment is invalid or the resolution was not changed. + '403': + description: Delegated alert dismissal is enabled and the authenticated + user is not a valid reviewer. '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found @@ -96197,7 +99200,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &814 + items: &815 type: object properties: type: @@ -96223,7 +99226,6 @@ paths: example: commit details: oneOf: - - *656 - *657 - *658 - *659 @@ -96236,6 +99238,7 @@ paths: - *666 - *667 - *668 + - *669 examples: default: value: @@ -96330,14 +99333,14 @@ paths: schema: type: object properties: - reason: &670 + reason: &671 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *669 + placeholder_id: *670 required: - reason - placeholder_id @@ -96354,7 +99357,7 @@ paths: schema: type: object properties: - reason: *670 + reason: *671 expire_at: type: string format: date-time @@ -96416,7 +99419,7 @@ paths: properties: incremental_scans: type: array - items: &671 + items: &672 description: Information on a single scan performed by secret scanning on the repository type: object @@ -96442,15 +99445,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *671 + items: *672 backfill_scans: type: array - items: *671 + items: *672 custom_pattern_backfill_scans: type: array items: allOf: - - *671 + - *672 - type: object properties: pattern_name: @@ -96463,7 +99466,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *671 + items: *672 examples: default: value: @@ -96573,9 +99576,9 @@ paths: application/json: schema: type: array - items: *672 + items: *673 examples: - default: *673 + default: *674 '400': *14 '404': *6 x-github: @@ -96759,9 +99762,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: &675 + default: &676 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -97105,7 +100108,7 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: default: value: @@ -97260,15 +100263,15 @@ paths: parameters: - *350 - *351 - - *674 + - *675 responses: '200': description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: *675 + default: *676 '403': *29 '404': *6 x-github: @@ -97294,7 +100297,7 @@ paths: parameters: - *350 - *351 - - *674 + - *675 requestBody: required: true content: @@ -97453,10 +100456,10 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: *675 - add_credit: *675 + default: *676 + add_credit: *676 '403': *29 '404': *6 '422': @@ -97496,7 +100499,7 @@ paths: parameters: - *350 - *351 - - *674 + - *675 responses: '202': *39 '400': *14 @@ -97525,7 +100528,7 @@ paths: parameters: - *350 - *351 - - *674 + - *675 responses: '202': description: Response @@ -97669,7 +100672,7 @@ paths: application/json: schema: type: array - items: &676 + items: &677 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -98042,7 +101045,7 @@ paths: application/json: schema: type: array - items: *676 + items: *677 examples: default: value: @@ -98130,7 +101133,7 @@ paths: description: Response content: application/json: - schema: *677 + schema: *678 examples: default: value: @@ -98224,7 +101227,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &678 + schema: &679 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -98319,7 +101322,7 @@ paths: description: Response content: application/json: - schema: *678 + schema: *679 examples: default: value: @@ -98526,7 +101529,7 @@ paths: description: Response content: application/json: - schema: &679 + schema: &680 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -98538,7 +101541,7 @@ paths: required: - names examples: - default: &680 + default: &681 value: names: - octocat @@ -98593,9 +101596,9 @@ paths: description: Response content: application/json: - schema: *679 + schema: *680 examples: - default: *680 + default: *681 '404': *6 '422': *7 x-github: @@ -98618,7 +101621,7 @@ paths: parameters: - *350 - *351 - - &681 + - &682 name: per description: The time frame to display results for. in: query @@ -98647,7 +101650,7 @@ paths: example: 128 clones: type: array - items: &682 + items: &683 title: Traffic type: object properties: @@ -98888,7 +101891,7 @@ paths: parameters: - *350 - *351 - - *681 + - *682 responses: '200': description: Response @@ -98907,7 +101910,7 @@ paths: example: 3782 views: type: array - items: *682 + items: *683 required: - uniques - count @@ -99685,7 +102688,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &683 + text_matches: &684 title: Search Result Text Matches type: array items: @@ -99847,7 +102850,7 @@ paths: enum: - author-date - committer-date - - &684 + - &685 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 @@ -99975,7 +102978,7 @@ paths: type: number node_id: type: string - text_matches: *683 + text_matches: *684 required: - sha - node_id @@ -100167,7 +103170,7 @@ paths: - interactions - created - updated - - *684 + - *685 - *17 - *19 - name: advanced_search @@ -100281,8 +103284,8 @@ paths: description: type: string nullable: true - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 issue_field_values: type: array items: *566 @@ -100317,7 +103320,7 @@ paths: type: string format: date-time nullable: true - text_matches: *683 + text_matches: *684 pull_request: type: object properties: @@ -100623,7 +103626,7 @@ paths: enum: - created - updated - - *684 + - *685 - *17 - *19 responses: @@ -100667,7 +103670,7 @@ paths: nullable: true score: type: number - text_matches: *683 + text_matches: *684 required: - id - node_id @@ -100752,7 +103755,7 @@ paths: - forks - help-wanted-issues - updated - - *684 + - *685 - *17 - *19 responses: @@ -101000,7 +104003,7 @@ paths: - admin - pull - push - text_matches: *683 + text_matches: *684 temp_clone_token: type: string allow_merge_commit: @@ -101300,7 +104303,7 @@ paths: type: string format: uri nullable: true - text_matches: *683 + text_matches: *684 related: type: array nullable: true @@ -101491,7 +104494,7 @@ paths: - followers - repositories - joined - - *684 + - *685 - *17 - *19 responses: @@ -101595,7 +104598,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *683 + text_matches: *684 blog: type: string nullable: true @@ -101674,7 +104677,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &687 + - &688 name: team_id description: The unique identifier of the team. in: path @@ -101715,7 +104718,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *687 + - *688 requestBody: required: true content: @@ -101815,7 +104818,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *687 + - *688 responses: '204': description: Response @@ -101844,7 +104847,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *687 + - *688 - *17 - *19 responses: @@ -101882,7 +104885,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *687 + - *688 - name: role description: Filters members returned by their role in the team. in: query @@ -101933,7 +104936,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *687 + - *688 - *74 responses: '204': @@ -101970,7 +104973,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *687 + - *688 - *74 responses: '204': @@ -102010,7 +105013,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *687 + - *688 - *74 responses: '204': @@ -102047,7 +105050,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *687 + - *688 - *74 responses: '200': @@ -102056,7 +105059,7 @@ paths: application/json: schema: *349 examples: - response-if-user-is-a-team-maintainer: *688 + response-if-user-is-a-team-maintainer: *689 '404': *6 x-github: githubCloudOnly: false @@ -102089,7 +105092,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *687 + - *688 - *74 requestBody: required: false @@ -102117,7 +105120,7 @@ paths: application/json: schema: *349 examples: - response-if-users-membership-with-team-is-now-pending: *689 + response-if-users-membership-with-team-is-now-pending: *690 '403': description: Forbidden if team synchronization is set up '422': @@ -102151,7 +105154,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *687 + - *688 - *74 responses: '204': @@ -102179,7 +105182,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *687 + - *688 - *17 - *19 responses: @@ -102221,7 +105224,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *687 + - *688 - *350 - *351 responses: @@ -102229,7 +105232,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *690 + schema: *691 examples: alternative-response-with-extra-repository-information: value: @@ -102386,7 +105389,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *687 + - *688 - *350 - *351 requestBody: @@ -102438,7 +105441,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *687 + - *688 - *350 - *351 responses: @@ -102465,7 +105468,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *687 + - *688 - *17 - *19 responses: @@ -102477,7 +105480,7 @@ paths: type: array items: *201 examples: - response-if-child-teams-exist: *691 + response-if-child-teams-exist: *692 headers: Link: *70 '404': *6 @@ -102510,7 +105513,7 @@ paths: application/json: schema: oneOf: - - &693 + - &694 title: Private User description: Private User type: object @@ -102713,7 +105716,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *692 + - *693 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -102866,7 +105869,7 @@ paths: description: Response content: application/json: - schema: *693 + schema: *694 examples: default: value: @@ -103264,7 +106267,7 @@ paths: type: integer secrets: type: array - items: &694 + items: &695 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -103380,7 +106383,7 @@ paths: description: Response content: application/json: - schema: *694 + schema: *695 examples: default: value: @@ -103793,7 +106796,7 @@ paths: description: Response content: application/json: - schema: &695 + schema: &696 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -103834,7 +106837,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &696 + default: &697 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -103879,9 +106882,9 @@ paths: description: Response content: application/json: - schema: *695 + schema: *696 examples: - default: *696 + default: *697 '404': *6 x-github: githubCloudOnly: false @@ -103918,9 +106921,9 @@ paths: type: integer machines: type: array - items: *697 + items: *698 examples: - default: *698 + default: *699 '304': *37 '500': *55 '401': *25 @@ -104859,7 +107862,7 @@ paths: type: array items: *267 examples: - default: &709 + default: &710 value: - id: 197 name: hello_docker @@ -104960,7 +107963,7 @@ paths: application/json: schema: type: array - items: &699 + items: &700 title: Email description: Email type: object @@ -105025,9 +108028,9 @@ paths: application/json: schema: type: array - items: *699 + items: *700 examples: - default: &711 + default: &712 value: - email: octocat@github.com verified: true @@ -105102,7 +108105,7 @@ paths: application/json: schema: type: array - items: *699 + items: *700 examples: default: value: @@ -105358,7 +108361,7 @@ paths: application/json: schema: type: array - items: &700 + items: &701 title: GPG Key description: A unique encryption key type: object @@ -105489,7 +108492,7 @@ paths: - subkeys - revoked examples: - default: &728 + default: &729 value: - id: 3 name: Octocat's GPG Key @@ -105574,9 +108577,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *701 examples: - default: &701 + default: &702 value: id: 3 name: Octocat's GPG Key @@ -105633,7 +108636,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &702 + - &703 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -105645,9 +108648,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *701 examples: - default: *701 + default: *702 '404': *6 '304': *37 '403': *29 @@ -105670,7 +108673,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *702 + - *703 responses: '204': description: Response @@ -106128,7 +109131,7 @@ paths: application/json: schema: type: array - items: &703 + items: &704 title: Key description: Key type: object @@ -106229,9 +109232,9 @@ paths: description: Response content: application/json: - schema: *703 + schema: *704 examples: - default: &704 + default: &705 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -106270,9 +109273,9 @@ paths: description: Response content: application/json: - schema: *703 + schema: *704 examples: - default: *704 + default: *705 '404': *6 '304': *37 '403': *29 @@ -106328,7 +109331,7 @@ paths: application/json: schema: type: array - items: &705 + items: &706 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -106396,7 +109399,7 @@ paths: - account - plan examples: - default: &706 + default: &707 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -106458,9 +109461,9 @@ paths: application/json: schema: type: array - items: *705 + items: *706 examples: - default: *706 + default: *707 headers: Link: *70 '304': *37 @@ -107469,7 +110472,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *261 - - *707 + - *708 responses: '204': description: Response @@ -107602,7 +110605,7 @@ paths: - docker - nuget - container - - *708 + - *709 - *19 - *17 responses: @@ -107614,8 +110617,8 @@ paths: type: array items: *267 examples: - default: *709 - '400': *710 + default: *710 + '400': *711 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107644,7 +110647,7 @@ paths: application/json: schema: *267 examples: - default: &729 + default: &730 value: id: 40201 name: octo-name @@ -108006,9 +111009,9 @@ paths: application/json: schema: type: array - items: *699 + items: *700 examples: - default: *711 + default: *712 headers: Link: *70 '304': *37 @@ -108121,7 +111124,7 @@ paths: type: array items: *82 examples: - default: &718 + default: &719 summary: Default response value: - id: 1296269 @@ -108473,7 +111476,7 @@ paths: type: array items: *552 examples: - default: *712 + default: *713 headers: Link: *70 '304': *37 @@ -108558,7 +111561,7 @@ paths: application/json: schema: type: array - items: &713 + items: &714 title: Social account description: Social media account type: object @@ -108573,7 +111576,7 @@ paths: - provider - url examples: - default: &714 + default: &715 value: - provider: twitter url: https://twitter.com/github @@ -108635,9 +111638,9 @@ paths: application/json: schema: type: array - items: *713 + items: *714 examples: - default: *714 + default: *715 '422': *15 '304': *37 '404': *6 @@ -108724,7 +111727,7 @@ paths: application/json: schema: type: array - items: &715 + items: &716 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -108744,7 +111747,7 @@ paths: - title - created_at examples: - default: &747 + default: &748 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -108808,9 +111811,9 @@ paths: description: Response content: application/json: - schema: *715 + schema: *716 examples: - default: &716 + default: &717 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -108840,7 +111843,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: - - &717 + - &718 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -108852,9 +111855,9 @@ paths: description: Response content: application/json: - schema: *715 + schema: *716 examples: - default: *716 + default: *717 '404': *6 '304': *37 '403': *29 @@ -108877,7 +111880,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: - - *717 + - *718 responses: '204': description: Response @@ -108906,7 +111909,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &748 + - &749 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 @@ -108931,11 +111934,11 @@ paths: type: array items: *82 examples: - default-response: *718 + default-response: *719 application/vnd.github.v3.star+json: schema: type: array - items: &749 + items: &750 title: Starred Repository description: Starred Repository type: object @@ -109304,10 +112307,10 @@ paths: application/json: schema: oneOf: + - *694 - *693 - - *692 examples: - default-response: &722 + default-response: &723 summary: Default response value: login: octocat @@ -109342,7 +112345,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &723 + response-with-git-hub-plan-information: &724 summary: Response with GitHub plan information value: login: octocat @@ -109399,7 +112402,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &720 + - &721 name: user_id description: The unique identifier of the user. in: path @@ -109465,7 +112468,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *719 + - *720 - *17 responses: '200': @@ -109500,7 +112503,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *720 + - *721 - *285 requestBody: required: true @@ -109572,7 +112575,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *721 + schema: *722 examples: table_view: summary: Response for creating a table view @@ -109624,11 +112627,11 @@ paths: application/json: schema: oneOf: + - *694 - *693 - - *692 examples: - default-response: *722 - response-with-git-hub-plan-information: *723 + default-response: *723 + response-with-git-hub-plan-information: *724 '404': *6 x-github: githubCloudOnly: false @@ -109678,8 +112681,8 @@ paths: required: - subject_digests examples: - default: *724 - withPredicateType: *725 + default: *725 + withPredicateType: *726 responses: '200': description: Response @@ -109732,7 +112735,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *726 + default: *727 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110247,7 +113250,7 @@ paths: application/json: schema: *195 examples: - default: &727 + default: &728 summary: Example response for a user copilot space value: id: 42 @@ -110348,7 +113351,7 @@ paths: application/json: schema: *195 examples: - default: *727 + default: *728 '403': *29 '404': *6 x-github: @@ -110471,7 +113474,7 @@ paths: application/json: schema: *195 examples: - default: *727 + default: *728 '403': *29 '404': *6 '422': *15 @@ -111239,7 +114242,7 @@ paths: type: array items: *267 examples: - default: *709 + default: *710 '403': *29 '401': *25 x-github: @@ -111623,9 +114626,9 @@ paths: application/json: schema: type: array - items: *700 + items: *701 examples: - default: *728 + default: *729 headers: Link: *70 x-github: @@ -111853,7 +114856,7 @@ paths: - docker - nuget - container - - *708 + - *709 - *74 - *19 - *17 @@ -111866,10 +114869,10 @@ paths: type: array items: *267 examples: - default: *709 + default: *710 '403': *29 '401': *25 - '400': *710 + '400': *711 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -111899,7 +114902,7 @@ paths: application/json: schema: *267 examples: - default: *729 + default: *730 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112248,7 +115251,7 @@ paths: type: array items: *289 examples: - default: *730 + default: *731 headers: Link: *70 '304': *37 @@ -112308,7 +115311,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *731 + items: *732 required: - name - data_type @@ -112324,7 +115327,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *732 + iteration_configuration: *733 required: - name - data_type @@ -112346,8 +115349,8 @@ paths: value: name: Due date data_type: date - single_select_field: *733 - iteration_field: *734 + single_select_field: *734 + iteration_field: *735 responses: '201': description: Response @@ -112355,11 +115358,11 @@ paths: application/json: schema: *289 examples: - text_field: *735 - number_field: *736 - date_field: *737 - single_select_field: *738 - iteration_field: *739 + text_field: *736 + number_field: *737 + date_field: *738 + single_select_field: *739 + iteration_field: *740 '304': *37 '403': *29 '401': *25 @@ -112381,7 +115384,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *285 - - *740 + - *741 - *74 responses: '200': @@ -112390,7 +115393,7 @@ paths: application/json: schema: *289 examples: - default: *741 + default: *742 headers: Link: *70 '304': *37 @@ -112744,7 +115747,7 @@ paths: parameters: - *285 - *74 - - *742 + - *743 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -113019,7 +116022,7 @@ paths: - *124 - *126 - *125 - - *743 + - *744 - *127 responses: '200': @@ -113150,7 +116153,7 @@ paths: parameters: - *74 - *124 - - *744 + - *745 - *125 responses: '200': @@ -113249,9 +116252,9 @@ paths: - *124 - *126 - *125 - - *745 - - *127 - *746 + - *127 + - *747 responses: '200': description: Response when getting a billing usage summary @@ -113385,9 +116388,9 @@ paths: application/json: schema: type: array - items: *713 + items: *714 examples: - default: *714 + default: *715 headers: Link: *70 x-github: @@ -113417,9 +116420,9 @@ paths: application/json: schema: type: array - items: *715 + items: *716 examples: - default: *747 + default: *748 headers: Link: *70 x-github: @@ -113444,7 +116447,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *74 - - *748 + - *749 - *62 - *17 - *19 @@ -113456,11 +116459,11 @@ paths: schema: anyOf: - type: array - items: *749 + items: *750 - type: array items: *82 examples: - default-response: *718 + default-response: *719 headers: Link: *70 x-github: @@ -113619,7 +116622,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &750 + enterprise: &751 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -113677,7 +116680,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &751 + installation: &752 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -113696,7 +116699,7 @@ x-webhooks: required: - id - node_id - organization: &752 + organization: &753 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -113756,13 +116759,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &753 + repository: &754 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &785 + properties: &786 id: description: Unique identifier of the repository example: 42 @@ -114457,7 +117460,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &786 + required: &787 - archive_url - assignees_url - blobs_url @@ -114531,7 +117534,7 @@ x-webhooks: - watchers_count - created_at - updated_at - x-github-breaking-changes: &787 + x-github-breaking-changes: &788 - changeset: remove_use_squash_pr_title_as_default patch: properties: @@ -114622,10 +117625,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -114701,11 +117704,11 @@ x-webhooks: type: string enum: - created - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 - rule: &754 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 + rule: &755 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) @@ -114928,11 +117931,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 - rule: *754 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 + rule: *755 sender: *4 required: - action @@ -115115,11 +118118,11 @@ x-webhooks: - everyone required: - from - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 - rule: *754 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 + rule: *755 sender: *4 required: - action @@ -115203,7 +118206,7 @@ x-webhooks: type: string enum: - completed - check_run: &756 + check_run: &757 title: CheckRun description: A check performed on the code of a given code change type: object @@ -115294,7 +118297,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *755 + deployment: *756 details_url: example: https://example.com type: string @@ -115379,10 +118382,10 @@ x-webhooks: - output - app - pull_requests - installation: *751 - enterprise: *750 - organization: *752 - repository: *753 + installation: *752 + enterprise: *751 + organization: *753 + repository: *754 sender: *4 required: - check_run @@ -115773,11 +118776,11 @@ x-webhooks: type: string enum: - created - check_run: *756 - installation: *751 - enterprise: *750 - organization: *752 - repository: *753 + check_run: *757 + installation: *752 + enterprise: *751 + organization: *753 + repository: *754 sender: *4 required: - check_run @@ -116171,11 +119174,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *756 - installation: *751 - enterprise: *750 - organization: *752 - repository: *753 + check_run: *757 + installation: *752 + enterprise: *751 + organization: *753 + repository: *754 requested_action: description: The action requested by the user. type: object @@ -116578,11 +119581,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *756 - installation: *751 - enterprise: *750 - organization: *752 - repository: *753 + check_run: *757 + installation: *752 + enterprise: *751 + organization: *753 + repository: *754 sender: *4 required: - check_run @@ -117552,10 +120555,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -118244,10 +121247,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -118930,10 +121933,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -119244,20 +122247,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &757 + commit_oid: &758 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: *750 - installation: *751 - organization: *752 - ref: &758 + enterprise: *751 + installation: *752 + organization: *753 + ref: &759 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: *753 + repository: *754 sender: *4 required: - action @@ -119652,12 +122655,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *757 - enterprise: *750 - installation: *751 - organization: *752 - ref: *758 - repository: *753 + commit_oid: *758 + enterprise: *751 + installation: *752 + organization: *753 + ref: *759 + repository: *754 sender: *4 required: - action @@ -119923,12 +122926,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *757 - enterprise: *750 - installation: *751 - organization: *752 - ref: *758 - repository: *753 + commit_oid: *758 + enterprise: *751 + installation: *752 + organization: *753 + ref: *759 + repository: *754 sender: *4 required: - action @@ -120260,12 +123263,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *757 - enterprise: *750 - installation: *751 - organization: *752 - ref: *758 - repository: *753 + commit_oid: *758 + enterprise: *751 + installation: *752 + organization: *753 + ref: *759 + repository: *754 sender: *4 required: - action @@ -120539,16 +123542,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 ref: 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 nullable: true - repository: *753 + repository: *754 sender: *4 required: - action @@ -120785,12 +123788,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *757 - enterprise: *750 - installation: *751 - organization: *752 - ref: *758 - repository: *753 + commit_oid: *758 + enterprise: *751 + installation: *752 + organization: *753 + ref: *759 + repository: *754 sender: *4 required: - action @@ -121101,10 +124104,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -121359,10 +124362,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -121442,18 +124445,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *752 - pusher_type: &759 + organization: *753 + pusher_type: &760 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &760 + ref: &761 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -121463,7 +124466,7 @@ x-webhooks: enum: - tag - branch - repository: *753 + repository: *754 sender: *4 required: - ref @@ -121546,9 +124549,9 @@ x-webhooks: enum: - created definition: *297 - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 sender: *4 required: - action @@ -121633,9 +124636,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 sender: *4 required: - action @@ -121713,9 +124716,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *297 - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 sender: *4 required: - action @@ -121793,9 +124796,9 @@ x-webhooks: enum: - updated definition: *297 - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 sender: *4 required: - action @@ -121872,10 +124875,10 @@ x-webhooks: type: string enum: - updated - enterprise: *750 - installation: *751 - repository: *753 - organization: *752 + enterprise: *751 + installation: *752 + repository: *754 + organization: *753 sender: *4 new_property_values: type: array @@ -121960,18 +124963,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *750 - installation: *751 - organization: *752 - pusher_type: *759 - ref: *760 + enterprise: *751 + installation: *752 + organization: *753 + pusher_type: *760 + ref: *761 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *753 + repository: *754 sender: *4 required: - ref @@ -122052,10 +125055,10 @@ x-webhooks: enum: - assignees_changed alert: *507 - installation: *751 - organization: *752 - enterprise: *750 - repository: *753 + installation: *752 + organization: *753 + enterprise: *751 + repository: *754 sender: *4 required: - action @@ -122136,10 +125139,10 @@ x-webhooks: enum: - auto_dismissed alert: *507 - installation: *751 - organization: *752 - enterprise: *750 - repository: *753 + installation: *752 + organization: *753 + enterprise: *751 + repository: *754 sender: *4 required: - action @@ -122221,10 +125224,10 @@ x-webhooks: enum: - auto_reopened alert: *507 - installation: *751 - organization: *752 - enterprise: *750 - repository: *753 + installation: *752 + organization: *753 + enterprise: *751 + repository: *754 sender: *4 required: - action @@ -122306,10 +125309,10 @@ x-webhooks: enum: - created alert: *507 - installation: *751 - organization: *752 - enterprise: *750 - repository: *753 + installation: *752 + organization: *753 + enterprise: *751 + repository: *754 sender: *4 required: - action @@ -122389,10 +125392,10 @@ x-webhooks: enum: - dismissed alert: *507 - installation: *751 - organization: *752 - enterprise: *750 - repository: *753 + installation: *752 + organization: *753 + enterprise: *751 + repository: *754 sender: *4 required: - action @@ -122472,10 +125475,10 @@ x-webhooks: enum: - fixed alert: *507 - installation: *751 - organization: *752 - enterprise: *750 - repository: *753 + installation: *752 + organization: *753 + enterprise: *751 + repository: *754 sender: *4 required: - action @@ -122556,10 +125559,10 @@ x-webhooks: enum: - reintroduced alert: *507 - installation: *751 - organization: *752 - enterprise: *750 - repository: *753 + installation: *752 + organization: *753 + enterprise: *751 + repository: *754 sender: *4 required: - action @@ -122639,10 +125642,10 @@ x-webhooks: enum: - reopened alert: *507 - installation: *751 - organization: *752 - enterprise: *750 - repository: *753 + installation: *752 + organization: *753 + enterprise: *751 + repository: *754 sender: *4 required: - action @@ -122719,9 +125722,9 @@ x-webhooks: type: string enum: - created - enterprise: *750 - installation: *751 - key: &761 + enterprise: *751 + installation: *752 + key: &762 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -122757,8 +125760,8 @@ x-webhooks: - verified - created_at - read_only - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -122835,11 +125838,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *750 - installation: *751 - key: *761 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + key: *762 + organization: *753 + repository: *754 sender: *4 required: - action @@ -123395,12 +126398,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 - workflow: &767 + workflow: &768 title: Workflow type: object nullable: true @@ -124141,15 +127144,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *762 - required: *763 + properties: *763 + required: *764 nullable: true pull_requests: type: array items: *605 - repository: *753 - organization: *752 - installation: *751 + repository: *754 + organization: *753 + installation: *752 sender: *4 responses: '200': @@ -124220,7 +127223,7 @@ x-webhooks: type: string enum: - approved - approver: &764 + approver: &765 type: object properties: avatar_url: @@ -124263,11 +127266,11 @@ x-webhooks: type: string comment: type: string - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 - reviewers: &765 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 + reviewers: &766 type: array items: type: object @@ -124346,7 +127349,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &766 + workflow_job_run: &767 type: object properties: conclusion: @@ -125077,18 +128080,18 @@ x-webhooks: type: string enum: - rejected - approver: *764 + approver: *765 comment: type: string - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 - reviewers: *765 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 + reviewers: *766 sender: *4 since: type: string - workflow_job_run: *766 + workflow_job_run: *767 workflow_job_runs: type: array items: @@ -125792,13 +128795,13 @@ x-webhooks: type: string enum: - requested - enterprise: *750 + enterprise: *751 environment: type: string - installation: *751 - organization: *752 - repository: *753 - requestor: &772 + installation: *752 + organization: *753 + repository: *754 + requestor: &773 title: User type: object nullable: true @@ -127687,12 +130690,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 - workflow: *767 + workflow: *768 workflow_run: title: Deployment Workflow Run type: object @@ -128372,7 +131375,7 @@ x-webhooks: type: string enum: - answered - answer: &770 + answer: &771 type: object properties: author_association: @@ -128529,11 +131532,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *768 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + discussion: *769 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -128660,11 +131663,11 @@ x-webhooks: - from required: - category - discussion: *768 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + discussion: *769 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -128747,11 +131750,11 @@ x-webhooks: type: string enum: - closed - discussion: *768 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + discussion: *769 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -128833,7 +131836,7 @@ x-webhooks: type: string enum: - created - comment: &769 + comment: &770 type: object properties: author_association: @@ -128990,11 +131993,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *768 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + discussion: *769 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -129077,12 +132080,12 @@ x-webhooks: type: string enum: - deleted - comment: *769 - discussion: *768 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + comment: *770 + discussion: *769 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -129177,12 +132180,12 @@ x-webhooks: - from required: - body - comment: *769 - discussion: *768 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + comment: *770 + discussion: *769 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -129266,11 +132269,11 @@ x-webhooks: type: string enum: - created - discussion: *768 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + discussion: *769 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -129352,11 +132355,11 @@ x-webhooks: type: string enum: - deleted - discussion: *768 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + discussion: *769 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -129456,11 +132459,11 @@ x-webhooks: type: string required: - from - discussion: *768 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + discussion: *769 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -129542,10 +132545,10 @@ x-webhooks: type: string enum: - labeled - discussion: *768 - enterprise: *750 - installation: *751 - label: &771 + discussion: *769 + enterprise: *751 + installation: *752 + label: &772 title: Label type: object properties: @@ -129577,8 +132580,8 @@ x-webhooks: - color - default - description - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -129661,11 +132664,11 @@ x-webhooks: type: string enum: - locked - discussion: *768 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + discussion: *769 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -129747,11 +132750,11 @@ x-webhooks: type: string enum: - pinned - discussion: *768 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + discussion: *769 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -129833,11 +132836,11 @@ x-webhooks: type: string enum: - reopened - discussion: *768 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + discussion: *769 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -129922,16 +132925,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *768 - new_repository: *753 + new_discussion: *769 + new_repository: *754 required: - new_discussion - new_repository - discussion: *768 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + discussion: *769 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -130014,10 +133017,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *768 - old_answer: *770 - organization: *752 - repository: *753 + discussion: *769 + old_answer: *771 + organization: *753 + repository: *754 sender: *4 required: - action @@ -130099,12 +133102,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *768 - enterprise: *750 - installation: *751 - label: *771 - organization: *752 - repository: *753 + discussion: *769 + enterprise: *751 + installation: *752 + label: *772 + organization: *753 + repository: *754 sender: *4 required: - action @@ -130187,11 +133190,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *768 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + discussion: *769 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -130273,11 +133276,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *768 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + discussion: *769 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -130350,7 +133353,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *750 + enterprise: *751 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -131010,9 +134013,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *751 - organization: *752 - repository: *753 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - forkee @@ -131158,9 +134161,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 pages: description: The pages that were updated. type: array @@ -131197,7 +134200,7 @@ x-webhooks: - action - sha - html_url - repository: *753 + repository: *754 sender: *4 required: - pages @@ -131273,10 +134276,10 @@ x-webhooks: type: string enum: - created - enterprise: *750 + enterprise: *751 installation: *22 - organization: *752 - repositories: &773 + organization: *753 + repositories: &774 description: An array of repository objects that the installation can access. type: array @@ -131302,8 +134305,8 @@ x-webhooks: - name - full_name - private - repository: *753 - requester: *772 + repository: *754 + requester: *773 sender: *4 required: - action @@ -131378,11 +134381,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *750 + enterprise: *751 installation: *22 - organization: *752 - repositories: *773 - repository: *753 + organization: *753 + repositories: *774 + repository: *754 requester: nullable: true sender: *4 @@ -131458,11 +134461,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *750 + enterprise: *751 installation: *22 - organization: *752 - repositories: *773 - repository: *753 + organization: *753 + repositories: *774 + repository: *754 requester: nullable: true sender: *4 @@ -131538,10 +134541,10 @@ x-webhooks: type: string enum: - added - enterprise: *750 + enterprise: *751 installation: *22 - organization: *752 - repositories_added: &774 + organization: *753 + repositories_added: &775 description: An array of repository objects, which were added to the installation. type: array @@ -131587,15 +134590,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *753 - repository_selection: &775 + repository: *754 + repository_selection: &776 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *772 + requester: *773 sender: *4 required: - action @@ -131674,10 +134677,10 @@ x-webhooks: type: string enum: - removed - enterprise: *750 + enterprise: *751 installation: *22 - organization: *752 - repositories_added: *774 + organization: *753 + repositories_added: *775 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -131704,9 +134707,9 @@ x-webhooks: - name - full_name - private - repository: *753 - repository_selection: *775 - requester: *772 + repository: *754 + repository_selection: *776 + requester: *773 sender: *4 required: - action @@ -131785,11 +134788,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *750 + enterprise: *751 installation: *22 - organization: *752 - repositories: *773 - repository: *753 + organization: *753 + repositories: *774 + repository: *754 requester: nullable: true sender: *4 @@ -131967,10 +134970,10 @@ x-webhooks: type: string required: - from - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 target_type: type: string @@ -132049,11 +135052,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *750 + enterprise: *751 installation: *22 - organization: *752 - repositories: *773 - repository: *753 + organization: *753 + repositories: *774 + repository: *754 requester: nullable: true sender: *4 @@ -132313,8 +135316,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -133103,8 +136106,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133453,8 +136456,8 @@ x-webhooks: - state - locked - assignee - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -133534,7 +136537,7 @@ x-webhooks: type: string enum: - deleted - comment: &776 + comment: &777 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -133707,8 +136710,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -134493,8 +137496,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134845,8 +137848,8 @@ x-webhooks: - state - locked - assignee - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -134926,7 +137929,7 @@ x-webhooks: type: string enum: - edited - changes: &806 + changes: &807 description: The changes to the comment. type: object properties: @@ -134938,9 +137941,9 @@ x-webhooks: type: string required: - from - comment: *776 - enterprise: *750 - installation: *751 + comment: *777 + enterprise: *751 + installation: *752 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -135728,8 +138731,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136078,8 +139081,8 @@ x-webhooks: - state - locked - assignee - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -136160,9 +139163,9 @@ x-webhooks: type: string enum: - pinned - comment: *776 - enterprise: *750 - installation: *751 + comment: *777 + enterprise: *751 + installation: *752 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -136952,8 +139955,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137304,8 +140307,8 @@ x-webhooks: - state - locked - assignee - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -137385,9 +140388,9 @@ x-webhooks: type: string enum: - unpinned - comment: *776 - enterprise: *750 - installation: *751 + comment: *777 + enterprise: *751 + installation: *752 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -138177,8 +141180,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138529,8 +141532,8 @@ x-webhooks: - state - locked - assignee - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -138619,9 +141622,9 @@ x-webhooks: type: number blocking_issue: *88 blocking_issue_repo: *82 - installation: *751 - organization: *752 - repository: *753 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -138710,9 +141713,9 @@ x-webhooks: type: number blocking_issue: *88 blocking_issue_repo: *82 - installation: *751 - organization: *752 - repository: *753 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -138800,9 +141803,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *88 - installation: *751 - organization: *752 - repository: *753 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -138891,9 +141894,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *88 - installation: *751 - organization: *752 - repository: *753 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -138973,10 +141976,10 @@ x-webhooks: type: string enum: - assigned - assignee: *772 - enterprise: *750 - installation: *751 - issue: &777 + assignee: *773 + enterprise: *751 + installation: *752 + issue: &778 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -139768,8 +142771,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 issue_field_values: type: array items: *566 @@ -139889,8 +142892,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -139970,8 +142973,8 @@ x-webhooks: type: string enum: - closed - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -140768,8 +143771,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 issue_field_values: type: array items: *566 @@ -141024,8 +144027,8 @@ x-webhooks: required: - state - closed_at - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -141104,8 +144107,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141893,8 +144896,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 issue_field_values: type: array items: *566 @@ -142013,8 +145016,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -142093,8 +145096,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142904,8 +145907,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 issue_field_values: type: array items: *566 @@ -143003,7 +146006,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &778 + milestone: &779 title: Milestone description: A collection of related issues and pull requests. type: object @@ -143141,8 +146144,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -143241,8 +146244,8 @@ x-webhooks: type: string required: - from - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144034,8 +147037,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 issue_field_values: type: array items: *566 @@ -144155,9 +147158,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *771 - organization: *752 - repository: *753 + label: *772 + organization: *753 + repository: *754 sender: *4 required: - action @@ -144237,9 +147240,9 @@ x-webhooks: type: string enum: - field_added - enterprise: *750 - installation: *751 - issue: *777 + enterprise: *751 + installation: *752 + issue: *778 issue_field: type: object description: The issue field whose value was set or updated on the @@ -144348,8 +147351,8 @@ x-webhooks: - id required: - from - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -144429,9 +147432,9 @@ x-webhooks: type: string enum: - field_removed - enterprise: *750 - installation: *751 - issue: *777 + enterprise: *751 + installation: *752 + issue: *778 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -144489,8 +147492,8 @@ x-webhooks: nullable: true required: - id - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -144570,8 +147573,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -145362,8 +148365,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 issue_field_values: type: array items: *566 @@ -145483,9 +148486,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *771 - organization: *752 - repository: *753 + label: *772 + organization: *753 + repository: *754 sender: *4 required: - action @@ -145565,8 +148568,8 @@ x-webhooks: type: string enum: - locked - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -146381,8 +149384,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 issue_field_values: type: array items: *566 @@ -146479,8 +149482,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -146559,8 +149562,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147369,8 +150372,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 issue_field_values: type: array items: *566 @@ -147467,9 +150470,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *778 - organization: *752 - repository: *753 + milestone: *779 + organization: *753 + repository: *754 sender: *4 required: - action @@ -148332,8 +151335,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 issue_field_values: type: array items: *566 @@ -148917,8 +151920,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -149702,8 +152705,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 issue_field_values: type: array items: *566 @@ -149830,8 +152833,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -149911,9 +152914,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *750 - installation: *751 - issue: &779 + enterprise: *751 + installation: *752 + issue: &780 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -150699,8 +153702,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 issue_field_values: type: array items: *566 @@ -150819,8 +153822,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -150899,8 +153902,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -151713,8 +154716,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 issue_field_values: type: array items: *566 @@ -151812,8 +154815,8 @@ x-webhooks: user_view_type: type: string type: *249 - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -152682,8 +155685,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 issue_field_values: type: array items: *566 @@ -153281,11 +156284,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *750 - installation: *751 - issue: *779 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + issue: *780 + organization: *753 + repository: *754 sender: *4 required: - action @@ -153365,12 +156368,12 @@ x-webhooks: type: string enum: - typed - enterprise: *750 - installation: *751 - issue: *777 + enterprise: *751 + installation: *752 + issue: *778 type: *249 - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -153451,7 +156454,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &809 + assignee: &810 title: User type: object nullable: true @@ -153521,11 +156524,11 @@ x-webhooks: required: - login - id - enterprise: *750 - installation: *751 - issue: *777 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + issue: *778 + organization: *753 + repository: *754 sender: *4 required: - action @@ -153604,12 +156607,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *750 - installation: *751 - issue: *777 - label: *771 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + issue: *778 + label: *772 + organization: *753 + repository: *754 sender: *4 required: - action @@ -153689,8 +156692,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -154503,8 +157506,8 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *685 - issue_dependencies_summary: *686 + sub_issues_summary: *686 + issue_dependencies_summary: *687 issue_field_values: type: array items: *566 @@ -154601,8 +157604,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -154682,11 +157685,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *750 - installation: *751 - issue: *779 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + issue: *780 + organization: *753 + repository: *754 sender: *4 required: - action @@ -154765,12 +157768,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *750 - installation: *751 - issue: *777 + enterprise: *751 + installation: *752 + issue: *778 type: *249 - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -154850,11 +157853,11 @@ x-webhooks: type: string enum: - created - enterprise: *750 - installation: *751 - label: *771 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + label: *772 + organization: *753 + repository: *754 sender: *4 required: - action @@ -154932,11 +157935,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *750 - installation: *751 - label: *771 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + label: *772 + organization: *753 + repository: *754 sender: *4 required: - action @@ -155046,11 +158049,11 @@ x-webhooks: type: string required: - from - enterprise: *750 - installation: *751 - label: *771 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + label: *772 + organization: *753 + repository: *754 sender: *4 required: - action @@ -155132,9 +158135,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *750 - installation: *751 - marketplace_purchase: &780 + enterprise: *751 + installation: *752 + marketplace_purchase: &781 title: Marketplace Purchase type: object required: @@ -155217,8 +158220,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *752 - previous_marketplace_purchase: &781 + organization: *753 + previous_marketplace_purchase: &782 title: Marketplace Purchase type: object properties: @@ -155298,7 +158301,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *753 + repository: *754 sender: *4 required: - action @@ -155378,10 +158381,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *750 - installation: *751 - marketplace_purchase: *780 - organization: *752 + enterprise: *751 + installation: *752 + marketplace_purchase: *781 + organization: *753 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -155464,7 +158467,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *753 + repository: *754 sender: *4 required: - action @@ -155546,10 +158549,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *750 - installation: *751 - marketplace_purchase: *780 - organization: *752 + enterprise: *751 + installation: *752 + marketplace_purchase: *781 + organization: *753 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -155631,7 +158634,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *753 + repository: *754 sender: *4 required: - action @@ -155712,8 +158715,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 marketplace_purchase: title: Marketplace Purchase type: object @@ -155795,9 +158798,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *752 - previous_marketplace_purchase: *781 - repository: *753 + organization: *753 + previous_marketplace_purchase: *782 + repository: *754 sender: *4 required: - action @@ -155877,12 +158880,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *750 - installation: *751 - marketplace_purchase: *780 - organization: *752 - previous_marketplace_purchase: *781 - repository: *753 + enterprise: *751 + installation: *752 + marketplace_purchase: *781 + organization: *753 + previous_marketplace_purchase: *782 + repository: *754 sender: *4 required: - action @@ -155984,11 +158987,11 @@ x-webhooks: type: string required: - to - enterprise: *750 - installation: *751 - member: *772 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + member: *773 + organization: *753 + repository: *754 sender: *4 required: - action @@ -156088,11 +159091,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *750 - installation: *751 - member: *772 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + member: *773 + organization: *753 + repository: *754 sender: *4 required: - action @@ -156171,11 +159174,11 @@ x-webhooks: type: string enum: - removed - enterprise: *750 - installation: *751 - member: *772 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + member: *773 + organization: *753 + repository: *754 sender: *4 required: - action @@ -156253,11 +159256,11 @@ x-webhooks: type: string enum: - added - enterprise: *750 - installation: *751 - member: *772 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + member: *773 + organization: *753 + repository: *754 scope: description: The scope of the membership. Currently, can only be `team`. @@ -156333,7 +159336,7 @@ x-webhooks: required: - login - id - team: &782 + team: &783 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -156556,11 +159559,11 @@ x-webhooks: type: string enum: - removed - enterprise: *750 - installation: *751 - member: *772 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + member: *773 + organization: *753 + repository: *754 scope: description: The scope of the membership. Currently, can only be `team`. @@ -156637,7 +159640,7 @@ x-webhooks: required: - login - id - team: *782 + team: *783 required: - action - scope @@ -156719,8 +159722,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *751 - merge_group: &784 + installation: *752 + merge_group: &785 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -156739,15 +159742,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *783 + head_commit: *784 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -156833,10 +159836,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *751 - merge_group: *784 - organization: *752 - repository: *753 + installation: *752 + merge_group: *785 + organization: *753 + repository: *754 sender: *4 required: - action @@ -156909,7 +159912,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *750 + enterprise: *751 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -157018,17 +160021,17 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *751 - organization: *752 + installation: *752 + organization: *753 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *785 - required: *786 - x-github-breaking-changes: *787 + properties: *786 + required: *787 + x-github-breaking-changes: *788 nullable: true sender: *4 required: @@ -157109,11 +160112,11 @@ x-webhooks: type: string enum: - closed - enterprise: *750 - installation: *751 - milestone: *778 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + milestone: *779 + organization: *753 + repository: *754 sender: *4 required: - action @@ -157192,9 +160195,9 @@ x-webhooks: type: string enum: - created - enterprise: *750 - installation: *751 - milestone: &788 + enterprise: *751 + installation: *752 + milestone: &789 title: Milestone description: A collection of related issues and pull requests. type: object @@ -157331,8 +160334,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -157411,11 +160414,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *750 - installation: *751 - milestone: *778 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + milestone: *779 + organization: *753 + repository: *754 sender: *4 required: - action @@ -157525,11 +160528,11 @@ x-webhooks: type: string required: - from - enterprise: *750 - installation: *751 - milestone: *778 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + milestone: *779 + organization: *753 + repository: *754 sender: *4 required: - action @@ -157609,11 +160612,11 @@ x-webhooks: type: string enum: - opened - enterprise: *750 - installation: *751 - milestone: *788 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + milestone: *789 + organization: *753 + repository: *754 sender: *4 required: - action @@ -157692,11 +160695,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *772 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + blocked_user: *773 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -157775,11 +160778,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *772 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + blocked_user: *773 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -157858,9 +160861,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *750 - installation: *751 - membership: &789 + enterprise: *751 + installation: *752 + membership: &790 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -157967,8 +160970,8 @@ x-webhooks: - role - organization_url - user - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 required: - action @@ -158046,11 +161049,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *750 - installation: *751 - membership: *789 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + membership: *790 + organization: *753 + repository: *754 sender: *4 required: - action @@ -158129,8 +161132,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -158246,10 +161249,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 - user: *772 + user: *773 required: - action - invitation @@ -158327,11 +161330,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *750 - installation: *751 - membership: *789 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + membership: *790 + organization: *753 + repository: *754 sender: *4 required: - action @@ -158418,11 +161421,11 @@ x-webhooks: properties: from: type: string - enterprise: *750 - installation: *751 - membership: *789 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + membership: *790 + organization: *753 + repository: *754 sender: *4 required: - action @@ -158499,9 +161502,9 @@ x-webhooks: type: string enum: - published - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 package: description: Information about the package. type: object @@ -159000,7 +162003,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &790 + items: &791 title: Ruby Gems metadata type: object properties: @@ -159095,7 +162098,7 @@ x-webhooks: - owner - package_version - registry - repository: *753 + repository: *754 sender: *4 required: - action @@ -159171,9 +162174,9 @@ x-webhooks: type: string enum: - updated - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 package: description: Information about the package. type: object @@ -159526,7 +162529,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *790 + items: *791 source_url: type: string format: uri @@ -159596,7 +162599,7 @@ x-webhooks: - owner - package_version - registry - repository: *753 + repository: *754 sender: *4 required: - action @@ -159772,12 +162775,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *750 + enterprise: *751 id: type: integer - installation: *751 - organization: *752 - repository: *753 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - id @@ -159854,7 +162857,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &791 + personal_access_token_request: &792 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -160000,10 +163003,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *750 - organization: *752 + enterprise: *751 + organization: *753 sender: *4 - installation: *751 + installation: *752 required: - action - personal_access_token_request @@ -160080,11 +163083,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *791 - enterprise: *750 - organization: *752 + personal_access_token_request: *792 + enterprise: *751 + organization: *753 sender: *4 - installation: *751 + installation: *752 required: - action - personal_access_token_request @@ -160160,11 +163163,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *791 - enterprise: *750 - organization: *752 + personal_access_token_request: *792 + enterprise: *751 + organization: *753 sender: *4 - installation: *751 + installation: *752 required: - action - personal_access_token_request @@ -160239,11 +163242,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *791 - organization: *752 - enterprise: *750 + personal_access_token_request: *792 + organization: *753 + enterprise: *751 sender: *4 - installation: *751 + installation: *752 required: - action - personal_access_token_request @@ -160348,7 +163351,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *792 + last_response: *793 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -160380,8 +163383,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 zen: description: Random string of GitHub zen. @@ -160626,10 +163629,10 @@ x-webhooks: - from required: - note - enterprise: *750 - installation: *751 - organization: *752 - project_card: &793 + enterprise: *751 + installation: *752 + organization: *753 + project_card: &794 title: Project Card type: object properties: @@ -160748,7 +163751,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *753 + repository: *754 sender: *4 required: - action @@ -160829,11 +163832,11 @@ x-webhooks: type: string enum: - created - enterprise: *750 - installation: *751 - organization: *752 - project_card: *793 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + project_card: *794 + repository: *754 sender: *4 required: - action @@ -160913,9 +163916,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 project_card: title: Project Card type: object @@ -161043,9 +164046,9 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *785 - required: *786 - x-github-breaking-changes: *787 + properties: *786 + required: *787 + x-github-breaking-changes: *788 nullable: true sender: *4 required: @@ -161139,11 +164142,11 @@ x-webhooks: - from required: - note - enterprise: *750 - installation: *751 - organization: *752 - project_card: *793 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + project_card: *794 + repository: *754 sender: *4 required: - action @@ -161237,9 +164240,9 @@ x-webhooks: - from required: - column_id - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 project_card: allOf: - title: Project Card @@ -161429,7 +164432,7 @@ x-webhooks: type: string required: - after_id - repository: *753 + repository: *754 sender: *4 required: - action @@ -161509,10 +164512,10 @@ x-webhooks: type: string enum: - closed - enterprise: *750 - installation: *751 - organization: *752 - project: &795 + enterprise: *751 + installation: *752 + organization: *753 + project: &796 title: Project type: object properties: @@ -161636,7 +164639,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *753 + repository: *754 sender: *4 required: - action @@ -161716,10 +164719,10 @@ x-webhooks: type: string enum: - created - enterprise: *750 - installation: *751 - organization: *752 - project_column: &794 + enterprise: *751 + installation: *752 + organization: *753 + project_column: &795 title: Project Column type: object properties: @@ -161758,7 +164761,7 @@ x-webhooks: - name - created_at - updated_at - repository: *753 + repository: *754 sender: *4 required: - action @@ -161837,19 +164840,19 @@ x-webhooks: type: string enum: - deleted - enterprise: *750 - installation: *751 - organization: *752 - project_column: *794 + enterprise: *751 + installation: *752 + organization: *753 + project_column: *795 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *785 - required: *786 - x-github-breaking-changes: *787 + properties: *786 + required: *787 + x-github-breaking-changes: *788 nullable: true sender: *4 required: @@ -161939,11 +164942,11 @@ x-webhooks: type: string required: - from - enterprise: *750 - installation: *751 - organization: *752 - project_column: *794 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + project_column: *795 + repository: *754 sender: *4 required: - action @@ -162023,11 +165026,11 @@ x-webhooks: type: string enum: - moved - enterprise: *750 - installation: *751 - organization: *752 - project_column: *794 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + project_column: *795 + repository: *754 sender: *4 required: - action @@ -162107,11 +165110,11 @@ x-webhooks: type: string enum: - created - enterprise: *750 - installation: *751 - organization: *752 - project: *795 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + project: *796 + repository: *754 sender: *4 required: - action @@ -162191,19 +165194,19 @@ x-webhooks: type: string enum: - deleted - enterprise: *750 - installation: *751 - organization: *752 - project: *795 + enterprise: *751 + installation: *752 + organization: *753 + project: *796 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *785 - required: *786 - x-github-breaking-changes: *787 + properties: *786 + required: *787 + x-github-breaking-changes: *788 nullable: true sender: *4 required: @@ -162305,11 +165308,11 @@ x-webhooks: type: string required: - from - enterprise: *750 - installation: *751 - organization: *752 - project: *795 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + project: *796 + repository: *754 sender: *4 required: - action @@ -162388,11 +165391,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *750 - installation: *751 - organization: *752 - project: *795 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + project: *796 + repository: *754 sender: *4 required: - action @@ -162473,8 +165476,8 @@ x-webhooks: type: string enum: - closed - installation: *751 - organization: *752 + installation: *752 + organization: *753 projects_v2: *283 sender: *4 required: @@ -162556,8 +165559,8 @@ x-webhooks: type: string enum: - created - installation: *751 - organization: *752 + installation: *752 + organization: *753 projects_v2: *283 sender: *4 required: @@ -162639,8 +165642,8 @@ x-webhooks: type: string enum: - deleted - installation: *751 - organization: *752 + installation: *752 + organization: *753 projects_v2: *283 sender: *4 required: @@ -162758,8 +165761,8 @@ x-webhooks: type: string to: type: string - installation: *751 - organization: *752 + installation: *752 + organization: *753 projects_v2: *283 sender: *4 required: @@ -162843,7 +165846,7 @@ x-webhooks: type: string enum: - archived - changes: &799 + changes: &800 type: object properties: archived_at: @@ -162857,9 +165860,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *751 - organization: *752 - projects_v2_item: &796 + installation: *752 + organization: *753 + projects_v2_item: &797 title: Projects v2 Item description: An item belonging to a project type: object @@ -162994,9 +165997,9 @@ x-webhooks: nullable: true to: type: string - installation: *751 - organization: *752 - projects_v2_item: *796 + installation: *752 + organization: *753 + projects_v2_item: *797 sender: *4 required: - action @@ -163078,9 +166081,9 @@ x-webhooks: type: string enum: - created - installation: *751 - organization: *752 - projects_v2_item: *796 + installation: *752 + organization: *753 + projects_v2_item: *797 sender: *4 required: - action @@ -163161,9 +166164,9 @@ x-webhooks: type: string enum: - deleted - installation: *751 - organization: *752 - projects_v2_item: *796 + installation: *752 + organization: *753 + projects_v2_item: *797 sender: *4 required: - action @@ -163269,7 +166272,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &797 + - &798 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -163291,7 +166294,7 @@ x-webhooks: required: - id - name - - &798 + - &799 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -163325,8 +166328,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *797 - *798 + - *799 required: - field_value - type: object @@ -163342,9 +166345,9 @@ x-webhooks: nullable: true required: - body - installation: *751 - organization: *752 - projects_v2_item: *796 + installation: *752 + organization: *753 + projects_v2_item: *797 sender: *4 required: - action @@ -163439,9 +166442,9 @@ x-webhooks: to: type: string nullable: true - installation: *751 - organization: *752 - projects_v2_item: *796 + installation: *752 + organization: *753 + projects_v2_item: *797 sender: *4 required: - action @@ -163524,10 +166527,10 @@ x-webhooks: type: string enum: - restored - changes: *799 - installation: *751 - organization: *752 - projects_v2_item: *796 + changes: *800 + installation: *752 + organization: *753 + projects_v2_item: *797 sender: *4 required: - action @@ -163609,8 +166612,8 @@ x-webhooks: type: string enum: - reopened - installation: *751 - organization: *752 + installation: *752 + organization: *753 projects_v2: *283 sender: *4 required: @@ -163692,14 +166695,14 @@ x-webhooks: type: string enum: - created - installation: *751 - organization: *752 - projects_v2_status_update: &802 + installation: *752 + organization: *753 + projects_v2_status_update: &803 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *800 - required: *801 + properties: *801 + required: *802 sender: *4 required: - action @@ -163780,9 +166783,9 @@ x-webhooks: type: string enum: - deleted - installation: *751 - organization: *752 - projects_v2_status_update: *802 + installation: *752 + organization: *753 + projects_v2_status_update: *803 sender: *4 required: - action @@ -163918,9 +166921,9 @@ x-webhooks: type: string format: date nullable: true - installation: *751 - organization: *752 - projects_v2_status_update: *802 + installation: *752 + organization: *753 + projects_v2_status_update: *803 sender: *4 required: - action @@ -163991,10 +166994,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - repository @@ -164071,13 +167074,13 @@ x-webhooks: type: string enum: - assigned - assignee: *772 - enterprise: *750 - installation: *751 - number: &803 + assignee: *773 + enterprise: *751 + installation: *752 + number: &804 description: The pull request number. type: integer - organization: *752 + organization: *753 pull_request: title: Pull Request type: object @@ -166382,7 +169385,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *753 + repository: *754 sender: *4 required: - action @@ -166479,11 +169482,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 number: type: integer - organization: *752 + organization: *753 pull_request: title: Pull Request type: object @@ -168783,7 +171786,7 @@ x-webhooks: - draft reason: type: string - repository: *753 + repository: *754 sender: *4 required: - action @@ -168880,11 +171883,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 number: type: integer - organization: *752 + organization: *753 pull_request: title: Pull Request type: object @@ -171184,7 +174187,7 @@ x-webhooks: - draft reason: type: string - repository: *753 + repository: *754 sender: *4 required: - action @@ -171281,11 +174284,11 @@ x-webhooks: type: string enum: - closed - enterprise: *750 - installation: *751 - number: *803 - organization: *752 - pull_request: &804 + enterprise: *751 + installation: *752 + number: *804 + organization: *753 + pull_request: &805 allOf: - *605 - type: object @@ -171349,7 +174352,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *753 + repository: *754 sender: *4 required: - action @@ -171430,12 +174433,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *750 - installation: *751 - number: *803 - organization: *752 - pull_request: *804 - repository: *753 + enterprise: *751 + installation: *752 + number: *804 + organization: *753 + pull_request: *805 + repository: *754 sender: *4 required: - action @@ -171515,11 +174518,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *750 + enterprise: *751 milestone: *589 - number: *803 - organization: *752 - pull_request: &805 + number: *804 + organization: *753 + pull_request: &806 title: Pull Request type: object properties: @@ -173846,7 +176849,7 @@ x-webhooks: - active_lock_reason - draft version: '2026-03-10' - repository: *753 + repository: *754 sender: *4 required: - action @@ -173925,11 +176928,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 number: type: integer - organization: *752 + organization: *753 pull_request: title: Pull Request type: object @@ -176233,7 +179236,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *753 + repository: *754 sender: *4 required: - action @@ -176365,12 +179368,12 @@ x-webhooks: type: string required: - from - enterprise: *750 - installation: *751 - number: *803 - organization: *752 - pull_request: *804 - repository: *753 + enterprise: *751 + installation: *752 + number: *804 + organization: *753 + pull_request: *805 + repository: *754 sender: *4 required: - action @@ -176450,11 +179453,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 number: type: integer - organization: *752 + organization: *753 pull_request: title: Pull Request type: object @@ -178743,7 +181746,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *753 + repository: *754 sender: *4 required: - action @@ -178831,11 +181834,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *750 - installation: *751 - label: *771 - number: *803 - organization: *752 + enterprise: *751 + installation: *752 + label: *772 + number: *804 + organization: *753 pull_request: title: Pull Request type: object @@ -181139,7 +184142,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *753 + repository: *754 sender: *4 required: - action @@ -181235,10 +184238,10 @@ x-webhooks: type: string enum: - locked - enterprise: *750 - installation: *751 - number: *803 - organization: *752 + enterprise: *751 + installation: *752 + number: *804 + organization: *753 pull_request: title: Pull Request type: object @@ -183540,7 +186543,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *753 + repository: *754 sender: *4 required: - action @@ -183635,12 +186638,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *750 + enterprise: *751 milestone: *589 - number: *803 - organization: *752 - pull_request: *805 - repository: *753 + number: *804 + organization: *753 + pull_request: *806 + repository: *754 sender: *4 required: - action @@ -183719,12 +186722,12 @@ x-webhooks: type: string enum: - opened - enterprise: *750 - installation: *751 - number: *803 - organization: *752 - pull_request: *804 - repository: *753 + enterprise: *751 + installation: *752 + number: *804 + organization: *753 + pull_request: *805 + repository: *754 sender: *4 required: - action @@ -183805,12 +186808,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *750 - installation: *751 - number: *803 - organization: *752 - pull_request: *804 - repository: *753 + enterprise: *751 + installation: *752 + number: *804 + organization: *753 + pull_request: *805 + repository: *754 sender: *4 required: - action @@ -183890,12 +186893,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *750 - installation: *751 - number: *803 - organization: *752 - pull_request: *804 - repository: *753 + enterprise: *751 + installation: *752 + number: *804 + organization: *753 + pull_request: *805 + repository: *754 sender: *4 required: - action @@ -184261,9 +187264,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 pull_request: type: object properties: @@ -186455,7 +189458,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *753 + repository: *754 sender: *4 required: - action @@ -186550,7 +189553,7 @@ x-webhooks: type: string enum: - deleted - comment: &807 + comment: &808 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -186835,9 +189838,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 pull_request: type: object properties: @@ -189017,7 +192020,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *753 + repository: *754 sender: *4 required: - action @@ -189112,11 +192115,11 @@ x-webhooks: type: string enum: - edited - changes: *806 - comment: *807 - enterprise: *750 - installation: *751 - organization: *752 + changes: *807 + comment: *808 + enterprise: *751 + installation: *752 + organization: *753 pull_request: type: object properties: @@ -191299,7 +194302,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *753 + repository: *754 sender: *4 required: - action @@ -191395,9 +194398,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 pull_request: title: Simple Pull Request type: object @@ -193592,7 +196595,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *753 + repository: *754 review: description: The review that was affected. type: object @@ -193854,9 +196857,9 @@ x-webhooks: type: string required: - from - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 pull_request: title: Simple Pull Request type: object @@ -195910,8 +198913,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *753 - review: &808 + repository: *754 + review: &809 description: The review that was affected. type: object properties: @@ -196152,12 +199155,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 number: description: The pull request number. type: integer - organization: *752 + organization: *753 pull_request: title: Pull Request type: object @@ -198462,7 +201465,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *753 + repository: *754 requested_reviewer: title: User type: object @@ -198546,12 +201549,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 number: description: The pull request number. type: integer - organization: *752 + organization: *753 pull_request: title: Pull Request type: object @@ -200863,7 +203866,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *753 + repository: *754 requested_team: title: Team description: Groups of organization members that gives permissions @@ -201078,12 +204081,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 number: description: The pull request number. type: integer - organization: *752 + organization: *753 pull_request: title: Pull Request type: object @@ -203390,7 +206393,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *753 + repository: *754 requested_reviewer: title: User type: object @@ -203475,12 +206478,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *750 - installation: *751 + enterprise: *751 + installation: *752 number: description: The pull request number. type: integer - organization: *752 + organization: *753 pull_request: title: Pull Request type: object @@ -205778,7 +208781,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *753 + repository: *754 requested_team: title: Team description: Groups of organization members that gives permissions @@ -205982,9 +208985,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 pull_request: title: Simple Pull Request type: object @@ -208181,8 +211184,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *753 - review: *808 + repository: *754 + review: *809 sender: *4 required: - action @@ -208277,9 +211280,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 pull_request: title: Simple Pull Request type: object @@ -210371,7 +213374,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *753 + repository: *754 sender: *4 thread: type: object @@ -210766,9 +213769,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 pull_request: title: Simple Pull Request type: object @@ -212846,7 +215849,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *753 + repository: *754 sender: *4 thread: type: object @@ -213244,10 +216247,10 @@ x-webhooks: type: string before: type: string - enterprise: *750 - installation: *751 - number: *803 - organization: *752 + enterprise: *751 + installation: *752 + number: *804 + organization: *753 pull_request: title: Pull Request type: object @@ -215540,7 +218543,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *753 + repository: *754 sender: *4 required: - action @@ -215637,11 +218640,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *809 - enterprise: *750 - installation: *751 - number: *803 - organization: *752 + assignee: *810 + enterprise: *751 + installation: *752 + number: *804 + organization: *753 pull_request: title: Pull Request type: object @@ -217946,7 +220949,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *753 + repository: *754 sender: *4 required: - action @@ -218040,11 +221043,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *750 - installation: *751 - label: *771 - number: *803 - organization: *752 + enterprise: *751 + installation: *752 + label: *772 + number: *804 + organization: *753 pull_request: title: Pull Request type: object @@ -220339,7 +223342,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *753 + repository: *754 sender: *4 required: - action @@ -220435,10 +223438,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *750 - installation: *751 - number: *803 - organization: *752 + enterprise: *751 + installation: *752 + number: *804 + organization: *753 pull_request: title: Pull Request type: object @@ -222725,7 +225728,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *753 + repository: *754 sender: *4 required: - action @@ -222940,7 +225943,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *750 + enterprise: *751 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -223032,8 +226035,8 @@ x-webhooks: - url - author - committer - installation: *751 - organization: *752 + installation: *752 + organization: *753 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -223619,9 +226622,9 @@ x-webhooks: type: string enum: - published - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 registry_package: type: object properties: @@ -224067,7 +227070,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *790 + items: *791 summary: type: string tag_name: @@ -224121,7 +227124,7 @@ x-webhooks: - owner - package_version - registry - repository: *753 + repository: *754 sender: *4 required: - action @@ -224199,9 +227202,9 @@ x-webhooks: type: string enum: - updated - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 registry_package: type: object properties: @@ -224509,7 +227512,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *790 + items: *791 summary: type: string tag_name: @@ -224558,7 +227561,7 @@ x-webhooks: - owner - package_version - registry - repository: *753 + repository: *754 sender: *4 required: - action @@ -224635,10 +227638,10 @@ x-webhooks: type: string enum: - created - enterprise: *750 - installation: *751 - organization: *752 - release: &810 + enterprise: *751 + installation: *752 + organization: *753 + release: &811 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -224956,7 +227959,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *753 + repository: *754 sender: *4 required: - action @@ -225033,11 +228036,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *750 - installation: *751 - organization: *752 - release: *810 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + release: *811 + repository: *754 sender: *4 required: - action @@ -225154,11 +228157,11 @@ x-webhooks: type: boolean required: - to - enterprise: *750 - installation: *751 - organization: *752 - release: *810 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + release: *811 + repository: *754 sender: *4 required: - action @@ -225236,9 +228239,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -225560,7 +228563,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *753 + repository: *754 sender: *4 required: - action @@ -225636,10 +228639,10 @@ x-webhooks: type: string enum: - published - enterprise: *750 - installation: *751 - organization: *752 - release: &811 + enterprise: *751 + installation: *752 + organization: *753 + release: &812 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -225958,7 +228961,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *753 + repository: *754 sender: *4 required: - action @@ -226034,11 +229037,11 @@ x-webhooks: type: string enum: - released - enterprise: *750 - installation: *751 - organization: *752 - release: *810 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + release: *811 + repository: *754 sender: *4 required: - action @@ -226114,11 +229117,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *750 - installation: *751 - organization: *752 - release: *811 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + release: *812 + repository: *754 sender: *4 required: - action @@ -226194,11 +229197,11 @@ x-webhooks: type: string enum: - published - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 - repository_advisory: *672 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 + repository_advisory: *673 sender: *4 required: - action @@ -226274,11 +229277,11 @@ x-webhooks: type: string enum: - reported - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 - repository_advisory: *672 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 + repository_advisory: *673 sender: *4 required: - action @@ -226354,10 +229357,10 @@ x-webhooks: type: string enum: - archived - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -226434,10 +229437,10 @@ x-webhooks: type: string enum: - created - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -226515,10 +229518,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -226602,10 +229605,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -226717,10 +229720,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -226792,10 +229795,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 status: type: string @@ -226876,10 +229879,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -226956,10 +229959,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -227053,10 +230056,10 @@ x-webhooks: - name required: - repository - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -227136,10 +230139,10 @@ x-webhooks: type: string enum: - created - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 repository_ruleset: *332 sender: *4 required: @@ -227218,10 +230221,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 repository_ruleset: *332 sender: *4 required: @@ -227300,10 +230303,10 @@ x-webhooks: type: string enum: - edited - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 repository_ruleset: *332 changes: type: object @@ -227608,10 +230611,10 @@ x-webhooks: - from required: - owner - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -227689,10 +230692,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -227770,7 +230773,7 @@ x-webhooks: type: string enum: - create - alert: &812 + alert: &813 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -227892,10 +230895,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -228101,10 +231104,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -228182,11 +231185,11 @@ x-webhooks: type: string enum: - reopen - alert: *812 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + alert: *813 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -228385,10 +231388,10 @@ x-webhooks: enum: - fixed - open - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -228466,7 +231469,7 @@ x-webhooks: type: string enum: - assigned - alert: &813 + alert: &814 type: object properties: number: *179 @@ -228609,10 +231612,10 @@ x-webhooks: required: *21 nullable: true assignee: *4 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -228690,11 +231693,11 @@ x-webhooks: type: string enum: - created - alert: *813 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + alert: *814 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -228775,11 +231778,11 @@ x-webhooks: type: string enum: - created - alert: *813 - installation: *751 - location: *814 - organization: *752 - repository: *753 + alert: *814 + installation: *752 + location: *815 + organization: *753 + repository: *754 sender: *4 required: - location @@ -229017,11 +232020,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *813 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + alert: *814 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -229099,11 +232102,11 @@ x-webhooks: type: string enum: - reopened - alert: *813 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + alert: *814 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -229181,11 +232184,11 @@ x-webhooks: type: string enum: - resolved - alert: *813 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + alert: *814 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -229263,12 +232266,12 @@ x-webhooks: type: string enum: - unassigned - alert: *813 + alert: *814 assignee: *4 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -229346,11 +232349,11 @@ x-webhooks: type: string enum: - validated - alert: *813 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + alert: *814 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -229476,10 +232479,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *753 - enterprise: *750 - installation: *751 - organization: *752 + repository: *754 + enterprise: *751 + installation: *752 + organization: *753 sender: *4 required: - action @@ -229557,11 +232560,11 @@ x-webhooks: type: string enum: - published - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 - security_advisory: &815 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 + security_advisory: &816 description: The details of the security advisory, including summary, description, and severity. type: object @@ -229762,11 +232765,11 @@ x-webhooks: type: string enum: - updated - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 - security_advisory: *815 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 + security_advisory: *816 sender: *4 required: - action @@ -229839,10 +232842,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -230035,9 +233038,9 @@ x-webhooks: type: object properties: security_and_analysis: *305 - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 repository: *353 sender: *4 required: @@ -230116,12 +233119,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 - sponsorship: &816 + sponsorship: &817 type: object properties: created_at: @@ -230422,12 +233425,12 @@ x-webhooks: type: string enum: - created - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 - sponsorship: *816 + sponsorship: *817 required: - action - sponsorship @@ -230515,12 +233518,12 @@ x-webhooks: type: string required: - from - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 - sponsorship: *816 + sponsorship: *817 required: - action - changes @@ -230597,17 +233600,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &817 + effective_date: &818 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: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 - sponsorship: *816 + sponsorship: *817 required: - action - sponsorship @@ -230681,7 +233684,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &818 + changes: &819 type: object properties: tier: @@ -230725,13 +233728,13 @@ x-webhooks: - from required: - tier - effective_date: *817 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + effective_date: *818 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 - sponsorship: *816 + sponsorship: *817 required: - action - changes @@ -230808,13 +233811,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *818 - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + changes: *819 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 - sponsorship: *816 + sponsorship: *817 required: - action - changes @@ -230888,10 +233891,10 @@ x-webhooks: type: string enum: - created - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -230974,10 +233977,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -231397,15 +234400,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *750 + enterprise: *751 id: description: The unique identifier of the status. type: integer - installation: *751 + installation: *752 name: type: string - organization: *752 - repository: *753 + organization: *753 + repository: *754 sender: *4 sha: description: The Commit SHA. @@ -231520,9 +234523,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *88 - installation: *751 - organization: *752 - repository: *753 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -231612,9 +234615,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *88 - installation: *751 - organization: *752 - repository: *753 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -231704,9 +234707,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *88 - installation: *751 - organization: *752 - repository: *753 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -231796,9 +234799,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *88 - installation: *751 - organization: *752 - repository: *753 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -231875,12 +234878,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 - team: &819 + team: &820 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -232103,9 +235106,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 repository: title: Repository description: A git repository @@ -232563,7 +235566,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *819 + team: *820 required: - action - team @@ -232639,9 +235642,9 @@ x-webhooks: type: string enum: - created - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 repository: title: Repository description: A git repository @@ -233099,7 +236102,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *819 + team: *820 required: - action - team @@ -233176,9 +236179,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 repository: title: Repository description: A git repository @@ -233636,7 +236639,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *819 + team: *820 required: - action - team @@ -233780,9 +236783,9 @@ x-webhooks: - from required: - permissions - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 repository: title: Repository description: A git repository @@ -234240,7 +237243,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *819 + team: *820 required: - action - changes @@ -234318,9 +237321,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *750 - installation: *751 - organization: *752 + enterprise: *751 + installation: *752 + organization: *753 repository: title: Repository description: A git repository @@ -234778,7 +237781,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *819 + team: *820 required: - action - team @@ -234854,10 +237857,10 @@ x-webhooks: type: string enum: - started - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 required: - action @@ -234930,16 +237933,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *750 + enterprise: *751 inputs: type: object nullable: true additionalProperties: true - installation: *751 - organization: *752 + installation: *752 + organization: *753 ref: type: string - repository: *753 + repository: *754 sender: *4 workflow: type: string @@ -235021,10 +238024,10 @@ x-webhooks: type: string enum: - completed - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 workflow_job: allOf: @@ -235340,10 +238343,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 workflow_job: allOf: @@ -235682,10 +238685,10 @@ x-webhooks: type: string enum: - queued - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 workflow_job: type: object @@ -235899,10 +238902,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 workflow_job: type: object @@ -236118,12 +239121,12 @@ x-webhooks: type: string enum: - completed - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 - workflow: *767 + workflow: *768 workflow_run: title: Workflow Run type: object @@ -237122,12 +240125,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 - workflow: *767 + workflow: *768 workflow_run: title: Workflow Run type: object @@ -238111,12 +241114,12 @@ x-webhooks: type: string enum: - requested - enterprise: *750 - installation: *751 - organization: *752 - repository: *753 + enterprise: *751 + installation: *752 + organization: *753 + repository: *754 sender: *4 - workflow: *767 + workflow: *768 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index 6123a941d..4c88580a3 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -2044,6 +2044,3164 @@ } } }, + "/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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", @@ -65221,6 +68379,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": { @@ -139814,7 +142981,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" ], @@ -139873,20 +143040,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, "example": "1.2.3" @@ -223761,7 +226928,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -223842,6 +227010,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" @@ -223986,7 +227162,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" ], @@ -224075,7 +227251,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", @@ -224083,7 +227259,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -224119,7 +227296,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": { @@ -224137,6 +227314,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": [ @@ -224195,6 +227380,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" + } } } } @@ -224244,7 +227440,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -224331,6 +227528,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" @@ -224658,7 +227863,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -224739,6 +227945,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" @@ -224807,7 +228021,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" ], @@ -224913,7 +228127,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -224949,7 +228164,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": { @@ -224967,6 +228182,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" } } }, @@ -267587,6 +270810,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": { @@ -293045,25 +296277,525 @@ } }, { - "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", + "format": "date-time", + "nullable": true + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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", + "format": "uri", + "description": "API URL for the workflow run.", + "nullable": true + }, + "run_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the workflow run.", + "nullable": true + }, + "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", + "format": "uri", + "description": "API URL for the job.", + "nullable": true + }, + "job_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the job.", + "nullable": true + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "concurrency-groups" } } }, @@ -308115,99 +311847,374 @@ } }, { - "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", + "format": "uri", + "description": "API URL for the workflow run.", + "nullable": true + }, + "run_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the workflow run.", + "nullable": true + }, + "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", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease.", + "nullable": true + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease.", + "nullable": true + }, + "job_url": { + "type": "string", + "format": "uri", + "description": "API URL for the job.", + "nullable": true + }, + "job_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the job.", + "nullable": true + }, + "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": { @@ -308231,13 +312238,82 @@ } } } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "workflow-runs" + "subcategory": "concurrency-groups" } } }, @@ -596569,6 +600645,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": { @@ -600432,6 +604517,9 @@ "400": { "description": "Bad request, resolution comment is invalid or the resolution was not changed." }, + "403": { + "description": "Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer." + }, "404": { "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index d3dbf4d4a..114fa05d3 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -870,7 +870,7 @@ paths: - subscriptions_url - type - url - type: &467 + type: &468 type: string description: The type of credit the user is receiving. enum: @@ -1036,7 +1036,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: - - &784 + - &785 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1126,6 +1126,2525 @@ 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 @@ -1733,7 +4252,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &793 + schema: &794 title: Scim Error description: Scim Error type: object @@ -9102,7 +11621,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &794 + '401': &795 description: Authorization failure '404': *6 x-github: @@ -13313,7 +15832,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &558 + instances_url: &559 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13348,7 +15867,7 @@ paths: format: date-time readOnly: true nullable: true - dismissed_reason: &559 + dismissed_reason: &560 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -13357,13 +15876,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &560 + dismissed_comment: &561 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &561 + rule: &562 type: object properties: id: @@ -13416,7 +15935,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &562 + tool: &563 type: object properties: name: *113 @@ -13426,26 +15945,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *114 - most_recent_instance: &563 + most_recent_instance: &564 type: object properties: - ref: &556 + ref: &557 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &573 + analysis_key: &574 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: &574 + environment: &575 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: &575 + category: &576 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -13465,7 +15984,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: &576 + location: &577 type: object description: Describe a region within a file for the alert. properties: @@ -13486,7 +16005,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: &577 + items: &578 type: string description: A classification of the file. For example to identify it as generated. @@ -17906,7 +20425,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 - - &620 + - &621 name: has in: query description: |- @@ -18029,7 +20548,7 @@ paths: - direct - transitive - inconclusive - security_advisory: &621 + security_advisory: &622 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -18268,14 +20787,14 @@ paths: nullable: true maxLength: 280 fixed_at: *141 - auto_dismissed_at: &622 + auto_dismissed_at: &623 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissal_request: &623 + dismissal_request: &624 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -20065,7 +22584,7 @@ paths: - name - created_on examples: - default: &472 + default: &473 value: total_count: 2 network_configurations: @@ -20316,7 +22835,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: - *41 - - &473 + - &474 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -20328,7 +22847,7 @@ paths: description: Response content: application/json: - schema: &474 + schema: &475 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -20362,7 +22881,7 @@ paths: - subnet_id - region examples: - default: &475 + default: &476 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -22421,7 +24940,7 @@ paths: - *169 rules: type: array - items: &750 + items: &751 title: Repository Rule type: object description: A repository rule. @@ -22430,7 +24949,7 @@ paths: - *175 - *176 - *177 - - &748 + - &749 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -23000,6 +25519,17 @@ paths: schema: type: boolean default: false + - &463 + 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 @@ -23007,7 +25537,7 @@ paths: application/json: schema: type: array - items: &463 + items: &464 type: object properties: number: *131 @@ -23026,14 +25556,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &762 + state: &763 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: &763 + resolution: &764 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -23150,8 +25680,8 @@ paths: pull request. ' - oneOf: &764 - - &766 + oneOf: &765 + - &767 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -23209,7 +25739,7 @@ paths: - blob_url - commit_sha - commit_url - - &767 + - &768 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. @@ -23264,7 +25794,7 @@ paths: - page_url - commit_sha - commit_url - - &768 + - &769 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -23284,7 +25814,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &769 + - &770 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -23304,7 +25834,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &770 + - &771 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -23324,7 +25854,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &771 + - &772 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -23338,7 +25868,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &772 + - &773 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -23352,7 +25882,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &773 + - &774 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -23366,7 +25896,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &774 + - &775 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. @@ -23386,7 +25916,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &775 + - &776 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. @@ -23406,7 +25936,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &776 + - &777 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. @@ -23426,7 +25956,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &777 + - &778 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. @@ -23446,7 +25976,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &778 + - &779 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 request. @@ -23494,7 +26024,7 @@ paths: required: *21 nullable: true examples: - default: &464 + default: &465 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -23703,7 +26233,7 @@ paths: description: Response content: application/json: - schema: &465 + schema: &466 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -23786,7 +26316,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *201 examples: - default: &466 + default: &467 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -23922,7 +26452,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *41 - - &469 + - &470 name: advanced_security_product in: query description: | @@ -23942,7 +26472,7 @@ paths: description: Success content: application/json: - schema: &470 + schema: &471 type: object properties: total_advanced_security_committers: @@ -23997,7 +26527,7 @@ paths: required: - repositories examples: - default: &471 + default: &472 value: total_advanced_security_committers: 2 total_count: 2 @@ -27109,7 +29639,7 @@ paths: properties: action: type: string - discussion: &902 + discussion: &903 title: Discussion description: A Discussion in a repository. type: object @@ -27476,7 +30006,7 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &682 + properties: &683 id: type: integer format: int64 @@ -27852,7 +30382,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &821 + sub_issues_summary: &822 title: Sub-issues Summary type: object properties: @@ -27939,7 +30469,7 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: &705 + properties: &706 pinned_at: type: string format: date-time @@ -27951,7 +30481,7 @@ paths: properties: *20 required: *21 nullable: true - required: &706 + required: &707 - pinned_at - pinned_by nullable: true @@ -27965,7 +30495,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &822 + issue_dependencies_summary: &823 title: Issue Dependencies Summary type: object properties: @@ -27984,7 +30514,7 @@ paths: - total_blocking issue_field_values: type: array - items: &689 + items: &690 title: Issue Field Value description: A value assigned to an issue field type: object @@ -28045,7 +30575,7 @@ paths: - node_id - data_type - value - required: &683 + required: &684 - assignee - closed_at - comments @@ -28083,7 +30613,7 @@ paths: action: type: string issue: *229 - comment: &678 + comment: &679 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -28747,7 +31277,7 @@ paths: type: string release: allOf: - - &741 + - &742 title: Release description: A release. type: object @@ -28818,7 +31348,7 @@ paths: author: *4 assets: type: array - items: &742 + items: &743 title: Release Asset description: Data related to a release. type: object @@ -29397,7 +31927,7 @@ paths: url: type: string format: uri - user: &828 + user: &829 title: Public User description: Public User type: object @@ -32698,14 +35228,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: - - &484 + - &485 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &485 + - &486 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -32767,7 +35297,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &490 + '301': &491 description: Moved permanently content: application/json: @@ -32789,7 +35319,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &715 + - &716 name: all description: If `true`, show notifications marked as read. in: query @@ -32797,7 +35327,7 @@ paths: schema: type: boolean default: false - - &716 + - &717 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -32807,7 +35337,7 @@ paths: type: boolean default: false - *236 - - &717 + - &718 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: @@ -33345,7 +35875,7 @@ paths: - url - subscription_url examples: - default: &718 + default: &719 value: - id: '1' repository: @@ -34197,7 +36727,7 @@ paths: type: array items: *160 examples: - default: &724 + default: &725 value: - property_name: environment value: production @@ -34247,7 +36777,7 @@ paths: required: - properties examples: - default: &725 + default: &726 value: properties: - property_name: environment @@ -35060,7 +37590,7 @@ paths: type: integer repository_cache_usages: type: array - items: &497 + items: &498 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -38366,7 +40896,7 @@ paths: description: Response content: application/json: - schema: &517 + schema: &518 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -38395,7 +40925,7 @@ paths: - key_id - key examples: - default: &518 + default: &519 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -38808,7 +41338,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-organization-variables parameters: - *89 - - &502 + - &503 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)." @@ -39574,6 +42104,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 @@ -39616,24 +42150,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 example: 1.2.3 @@ -40094,12 +42622,12 @@ paths: required: - subject_digests examples: - default: &860 + default: &861 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &861 + withPredicateType: &862 value: subject_digests: - sha256:abc123 @@ -40157,7 +42685,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &862 + default: &863 value: attestations_subject_digests: - sha256:abc: @@ -40507,7 +43035,7 @@ paths: initiator: type: string examples: - default: &531 + default: &532 value: attestations: - bundle: @@ -41424,7 +43952,7 @@ paths: be returned. in: query required: false - schema: &557 + schema: &558 type: string description: Severity of a code scanning alert. enum: @@ -42521,7 +45049,7 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &589 + properties: &590 name: type: string description: The name of the machine. @@ -42563,7 +45091,7 @@ paths: - ready - in_progress nullable: true - required: &590 + required: &591 - name - display_name - operating_system @@ -43431,7 +45959,7 @@ paths: - updated_at - visibility examples: - default: &591 + default: &592 value: total_count: 2 secrets: @@ -43469,7 +45997,7 @@ paths: description: Response content: application/json: - schema: &592 + schema: &593 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -43498,7 +46026,7 @@ paths: - key_id - key examples: - default: &593 + default: &594 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -43530,7 +46058,7 @@ paths: application/json: schema: *333 examples: - default: &595 + default: &596 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -47568,7 +50096,7 @@ paths: description: Response content: application/json: - schema: &626 + schema: &627 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -47585,7 +50113,7 @@ paths: - key_id - key examples: - default: &627 + default: &628 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -47913,7 +50441,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *89 - - &636 + - &637 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -47921,7 +50449,7 @@ paths: required: false schema: type: string - - &637 + - &638 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -47929,7 +50457,7 @@ paths: required: false schema: type: string - - &638 + - &639 name: time_period description: |- The time period to filter by. @@ -47945,7 +50473,7 @@ paths: - week - month default: month - - &639 + - &640 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -47970,7 +50498,7 @@ paths: application/json: schema: type: array - items: &640 + items: &641 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -48126,7 +50654,7 @@ paths: format: uri example: https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &641 + default: &642 value: - id: 21 number: 42 @@ -48228,7 +50756,7 @@ paths: application/json: schema: type: array - items: &642 + items: &643 title: Dependabot alert dismissal request description: Alert dismissal request made by a user asking to dismiss a Dependabot alert. @@ -48345,7 +50873,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/dependabot/1 examples: - default: &643 + default: &644 value: - id: 21 number: 42 @@ -48732,7 +51260,7 @@ paths: description: Response content: application/json: - schema: &481 + schema: &482 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -48813,7 +51341,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &482 + default: &483 value: group_id: '123' group_name: Octocat admins @@ -48868,7 +51396,7 @@ paths: description: Response content: application/json: - schema: &478 + schema: &479 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -48905,7 +51433,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &479 + default: &480 value: groups: - group_id: '123' @@ -50387,7 +52915,7 @@ paths: required: true content: application/json: - schema: &674 + schema: &675 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -51704,7 +54232,7 @@ paths: application/json: schema: *399 examples: - default: &588 + default: &589 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -52953,7 +55481,7 @@ paths: parameters: - *89 - *405 - - &843 + - &844 name: repo_name description: repo_name parameter in: path @@ -53987,7 +56515,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &468 + items: &469 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -54281,7 +56809,7 @@ paths: - nuget - container - *89 - - &844 + - &845 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -54322,7 +56850,7 @@ paths: default: *411 '403': *29 '401': *25 - '400': &846 + '400': &847 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -55526,6 +58054,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -55594,6 +58123,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 @@ -55631,7 +58169,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: @@ -55724,7 +58262,472 @@ 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. + example: MAVEN_REPOSITORY_SECRET + type: string + 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. + example: monalisa + type: string + 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: &425 + 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: + - *89 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - key_id + - key + properties: + key_id: + description: The identifier for the key. + example: '012345678912345678' + type: string + key: + description: The Base64 encoded public key. + example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + type: string + examples: + default: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + headers: + Link: *47 + '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: + - *89 + - *300 + responses: + '200': + description: The specified private registry configuration for the organization + content: + application/json: + schema: *424 + examples: + default: *425 + '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: + - *89 + - *300 + 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 + nullable: true + 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 @@ -55733,6 +58736,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`. @@ -55765,7 +58769,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` @@ -55783,440 +58787,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. - example: MAVEN_REPOSITORY_SECRET - type: string - 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. - example: monalisa - type: string - 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: &425 - 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: - - *89 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - key_id - - key - properties: - key_id: - description: The identifier for the key. - example: '012345678912345678' - type: string - key: - description: The Base64 encoded public key. - example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - type: string - examples: - default: - value: - key_id: '012345678912345678' - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - headers: - Link: *47 - '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: - - *89 - - *300 - responses: - '200': - description: The specified private registry configuration for the organization - content: - application/json: - schema: *424 - examples: - default: *425 - '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: - - *89 - - *300 - 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. + 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 - 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 - nullable: true - 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 - - 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: @@ -56368,7 +58947,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &938 + properties: &939 id: type: number description: The unique identifier of the status update. @@ -56416,7 +58995,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &939 + required: &940 - id - node_id - created_at @@ -56630,7 +59209,7 @@ paths: content: oneOf: - *229 - - &605 + - &606 title: Pull Request Simple description: Pull Request Simple type: object @@ -56856,7 +59435,7 @@ paths: - review_comment - self author_association: *226 - auto_merge: &727 + auto_merge: &728 title: Auto merge description: The status of auto merging a pull request. type: object @@ -57234,7 +59813,7 @@ paths: - updated_at - project_url examples: - default: &866 + default: &867 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -57411,7 +59990,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &867 + items: &868 type: object properties: name: @@ -57448,7 +60027,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &868 + iteration_configuration: &869 type: object description: The configuration for iteration fields. properties: @@ -57498,7 +60077,7 @@ paths: value: name: Due date data_type: date - single_select_field: &869 + single_select_field: &870 summary: Create a single select field value: name: Priority @@ -57525,7 +60104,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &870 + iteration_field: &871 summary: Create an iteration field value: name: Sprint @@ -57551,7 +60130,7 @@ paths: application/json: schema: *432 examples: - text_field: &871 + text_field: &872 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -57560,7 +60139,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: &872 + number_field: &873 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -57569,7 +60148,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: &873 + date_field: &874 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -57578,7 +60157,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: &874 + single_select_field: &875 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -57612,7 +60191,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &875 + iteration_field: &876 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -57658,7 +60237,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-organization parameters: - *428 - - &876 + - &877 name: field_id description: The unique identifier of the field. in: path @@ -57673,7 +60252,7 @@ paths: application/json: schema: *432 examples: - default: &877 + default: &878 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -58870,7 +61449,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &857 + schema: &858 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -59047,7 +61626,7 @@ paths: parameters: - *428 - *89 - - &878 + - &879 name: view_number description: The number that identifies the project view. in: path @@ -59813,7 +62392,7 @@ paths: description: Response content: application/json: - schema: &489 + schema: &490 title: Full Repository description: Full Repository type: object @@ -60217,7 +62796,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &610 + properties: &611 url: type: string format: uri @@ -60233,7 +62812,7 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &611 + required: &612 - url - key - name @@ -60322,7 +62901,7 @@ paths: - network_count - subscribers_count examples: - default: &491 + default: &492 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -60875,7 +63454,7 @@ paths: - *89 - *17 - *19 - - &749 + - &750 name: targets description: | A comma-separated list of rule targets to filter by. @@ -61091,7 +63670,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *89 - - &751 + - &752 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 @@ -61103,14 +63682,14 @@ paths: x-multi-segment: true - *316 - *107 - - &752 + - &753 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 - - &753 + - &754 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -61130,7 +63709,7 @@ paths: description: Response content: application/json: - schema: &754 + schema: &755 title: Rule Suites description: Response type: array @@ -61185,7 +63764,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &755 + default: &756 value: - id: 21 actor_id: 12 @@ -61229,7 +63808,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *89 - - &756 + - &757 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -61245,7 +63824,7 @@ paths: description: Response content: application/json: - schema: &757 + schema: &758 title: Rule Suite description: Response type: object @@ -61344,7 +63923,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &758 + default: &759 value: id: 21 actor_id: 12 @@ -61680,7 +64259,7 @@ paths: - *112 - *19 - *17 - - &760 + - &761 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 @@ -61690,7 +64269,7 @@ paths: required: false schema: type: string - - &761 + - &762 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 @@ -61704,6 +64283,7 @@ paths: - *460 - *461 - *462 + - *463 responses: '200': description: Response @@ -61711,9 +64291,9 @@ paths: application/json: schema: type: array - items: *463 + items: *464 examples: - default: *464 + default: *465 headers: Link: *47 '404': *6 @@ -61748,9 +64328,9 @@ paths: description: Response content: application/json: - schema: *465 + schema: *466 examples: - default: *466 + default: *467 '403': *29 '404': *6 patch: @@ -61903,7 +64483,7 @@ paths: application/json: schema: type: array - items: &782 + items: &783 description: A repository security advisory. type: object properties: @@ -62123,7 +64703,7 @@ paths: login: type: string description: The username of the user credited. - type: *467 + type: *468 credits_detailed: type: array nullable: true @@ -62133,7 +64713,7 @@ paths: type: object properties: user: *4 - type: *467 + type: *468 state: type: string description: The state of the user's acceptance of the @@ -62194,7 +64774,7 @@ paths: - private_fork additionalProperties: false examples: - default: &783 + default: &784 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -62581,7 +65161,7 @@ paths: application/json: schema: type: array - items: *468 + items: *469 examples: default: value: @@ -62680,7 +65260,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *89 - - *469 + - *470 - *17 - *19 responses: @@ -62688,9 +65268,9 @@ paths: description: Success content: application/json: - schema: *470 + schema: *471 examples: - default: *471 + default: *472 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -62971,7 +65551,7 @@ paths: type: array items: *153 examples: - default: *472 + default: *473 headers: Link: *47 x-github: @@ -63200,15 +65780,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: - *89 - - *473 + - *474 responses: '200': description: Response content: application/json: - schema: *474 + schema: *475 examples: - default: *475 + default: *476 headers: Link: *47 x-github: @@ -63246,7 +65826,7 @@ paths: description: Response content: application/json: - schema: &486 + schema: &487 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -63292,7 +65872,7 @@ paths: type: string nullable: true examples: - default: &487 + default: &488 value: groups: - group_id: '123' @@ -63512,7 +66092,7 @@ paths: description: Response content: application/json: - schema: &476 + schema: &477 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -63839,7 +66419,7 @@ paths: - repos_count - organization examples: - default: &477 + default: &478 value: id: 1 node_id: MDQ6VGVhbTE= @@ -63916,9 +66496,9 @@ paths: description: Response content: application/json: - schema: *476 + schema: *477 examples: - default: *477 + default: *478 '404': *6 x-github: githubCloudOnly: false @@ -64002,16 +66582,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *476 + schema: *477 examples: - default: *477 + default: *478 '201': description: Response content: application/json: - schema: *476 + schema: *477 examples: - default: *477 + default: *478 '404': *6 '422': *15 '403': *29 @@ -64041,7 +66621,7 @@ paths: responses: '204': description: Response - '422': &480 + '422': &481 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -64070,10 +66650,10 @@ paths: description: Response content: application/json: - schema: *478 + schema: *479 examples: - default: *479 - '422': *480 + default: *480 + '422': *481 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -64116,10 +66696,10 @@ paths: description: Response content: application/json: - schema: *481 + schema: *482 examples: - default: *482 - '422': *480 + default: *483 + '422': *481 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -64143,7 +66723,7 @@ paths: responses: '204': description: Response - '422': *480 + '422': *481 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -64180,7 +66760,7 @@ paths: default: *389 headers: Link: *47 - '422': *480 + '422': *481 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64262,7 +66842,7 @@ paths: description: Response content: application/json: - schema: &483 + schema: &484 title: Team Membership description: Team Membership type: object @@ -64289,7 +66869,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &824 + response-if-user-is-a-team-maintainer: &825 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -64352,9 +66932,9 @@ paths: description: Response content: application/json: - schema: *483 + schema: *484 examples: - response-if-users-membership-with-team-is-now-pending: &825 + response-if-users-membership-with-team-is-now-pending: &826 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -64461,14 +67041,14 @@ paths: parameters: - *89 - *222 - - *484 - *485 + - *486 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &826 + schema: &827 title: Team Repository description: A team's access to a repository. type: object @@ -65039,8 +67619,8 @@ paths: parameters: - *89 - *222 - - *484 - *485 + - *486 requestBody: required: false content: @@ -65087,8 +67667,8 @@ paths: parameters: - *89 - *222 - - *484 - *485 + - *486 responses: '204': description: Response @@ -65121,10 +67701,10 @@ paths: description: Response content: application/json: - schema: *486 + schema: *487 examples: - default: *487 - '422': *480 + default: *488 + '422': *481 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -65190,7 +67770,7 @@ paths: description: Response content: application/json: - schema: *486 + schema: *487 examples: default: value: @@ -65202,7 +67782,7 @@ paths: group_name: Octocat docs members group_description: The people who make your octoworld come to life. - '422': *480 + '422': *481 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -65236,7 +67816,7 @@ paths: type: array items: *319 examples: - response-if-child-teams-exist: &827 + response-if-child-teams-exist: &828 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -65390,7 +67970,7 @@ paths: resources: type: object properties: - core: &488 + core: &489 title: Rate Limit type: object properties: @@ -65407,21 +67987,21 @@ paths: - remaining - reset - used - graphql: *488 - search: *488 - code_search: *488 - source_import: *488 - integration_manifest: *488 - code_scanning_upload: *488 - actions_runner_registration: *488 - scim: *488 - dependency_snapshots: *488 - dependency_sbom: *488 - code_scanning_autofix: *488 + graphql: *489 + search: *489 + code_search: *489 + source_import: *489 + integration_manifest: *489 + code_scanning_upload: *489 + actions_runner_registration: *489 + scim: *489 + dependency_snapshots: *489 + dependency_sbom: *489 + code_scanning_autofix: *489 required: - core - search - rate: *488 + rate: *489 required: - rate - resources @@ -65526,14 +68106,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository parameters: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: *489 + schema: *490 examples: default-response: summary: Default response @@ -66042,7 +68622,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *490 + '301': *491 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66060,8 +68640,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#update-a-repository parameters: - - *484 - *485 + - *486 requestBody: required: false content: @@ -66369,10 +68949,10 @@ paths: description: Response content: application/json: - schema: *489 + schema: *490 examples: - default: *491 - '307': &492 + default: *492 + '307': &493 description: Temporary Redirect content: application/json: @@ -66401,8 +68981,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository parameters: - - *484 - *485 + - *486 responses: '204': description: Response @@ -66424,7 +69004,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': *492 + '307': *493 '404': *6 '409': *121 x-github: @@ -66448,11 +69028,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *484 - *485 + - *486 - *17 - *19 - - &509 + - &510 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -66475,7 +69055,7 @@ paths: type: integer artifacts: type: array - items: &493 + items: &494 title: Artifact description: An artifact type: object @@ -66553,7 +69133,7 @@ paths: - expires_at - updated_at examples: - default: &510 + default: &511 value: total_count: 2 artifacts: @@ -66614,9 +69194,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#get-an-artifact parameters: - - *484 - *485 - - &494 + - *486 + - &495 name: artifact_id description: The unique identifier of the artifact. in: path @@ -66628,7 +69208,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *494 examples: default: value: @@ -66666,9 +69246,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#delete-an-artifact parameters: - - *484 - *485 - - *494 + - *486 + - *495 responses: '204': description: Response @@ -66692,9 +69272,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#download-an-artifact parameters: - - *484 - *485 - - *494 + - *486 + - *495 - name: archive_format in: path required: true @@ -66704,11 +69284,11 @@ paths: '302': description: Response headers: - Location: &629 + Location: &630 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': &677 + '410': &678 description: Gone content: application/json: @@ -66733,14 +69313,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: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: &495 + schema: &496 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -66773,13 +69353,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: - - *484 - *485 + - *486 requestBody: required: true content: application/json: - schema: *495 + schema: *496 examples: selected_actions: *44 responses: @@ -66808,14 +69388,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: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: &496 + schema: &497 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -66848,13 +69428,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: - - *484 - *485 + - *486 requestBody: required: true content: application/json: - schema: *496 + schema: *497 examples: selected_actions: *46 responses: @@ -66885,14 +69465,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: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: *497 + schema: *498 examples: default: value: @@ -66918,11 +69498,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: - - *484 - *485 + - *486 - *17 - *19 - - &498 + - &499 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 @@ -66956,7 +69536,7 @@ paths: description: Response content: application/json: - schema: &499 + schema: &500 title: Repository actions caches description: Repository actions caches type: object @@ -66998,7 +69578,7 @@ paths: - total_count - actions_caches examples: - default: &500 + default: &501 value: total_count: 1 actions_caches: @@ -67030,23 +69610,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: - - *484 - *485 + - *486 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *498 + - *499 responses: '200': description: Response content: application/json: - schema: *499 + schema: *500 examples: - default: *500 + default: *501 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67066,8 +69646,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: - - *484 - *485 + - *486 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -67082,6 +69662,240 @@ 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: + - *485 + - *486 + - *17 + - *111 + 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 + format: date-time + nullable: true + 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: *47 + '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: + - *485 + - *486 + - 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 + format: uri + description: API URL for the workflow run. + nullable: true + run_html_url: + type: string + format: uri + description: Web URL for the workflow run. + nullable: true + 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 + format: uri + description: API URL for the job. + nullable: true + job_html_url: + type: string + format: uri + description: Web URL for the job. + nullable: true + 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 @@ -67098,9 +69912,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: - - *484 - *485 - - &501 + - *486 + - &502 name: job_id description: The unique identifier of the job. in: path @@ -67112,7 +69926,7 @@ paths: description: Response content: application/json: - schema: &513 + schema: &514 title: Job description: Information of a job execution in a workflow run type: object @@ -67419,9 +70233,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: - - *484 - *485 - - *501 + - *486 + - *502 responses: '302': description: Response @@ -67449,9 +70263,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: - - *484 - *485 - - *501 + - *486 + - *502 requestBody: required: false content: @@ -67496,8 +70310,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: - - *484 - *485 + - *486 responses: '200': description: Status response @@ -67556,8 +70370,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -67625,8 +70439,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-organization-secrets parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -67644,7 +70458,7 @@ paths: type: integer secrets: type: array - items: &515 + items: &516 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -67664,7 +70478,7 @@ paths: - created_at - updated_at examples: - default: &516 + default: &517 value: total_count: 2 secrets: @@ -67697,9 +70511,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-organization-variables parameters: - - *484 - *485 - - *502 + - *486 + - *503 - *19 responses: '200': @@ -67716,7 +70530,7 @@ paths: type: integer variables: type: array - items: &519 + items: &520 title: Actions Variable type: object properties: @@ -67746,7 +70560,7 @@ paths: - created_at - updated_at examples: - default: &520 + default: &521 value: total_count: 2 variables: @@ -67779,8 +70593,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -67789,7 +70603,7 @@ paths: schema: type: object properties: - enabled: &503 + enabled: &504 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *62 @@ -67824,8 +70638,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: - - *484 - *485 + - *486 responses: '204': description: Response @@ -67836,7 +70650,7 @@ paths: schema: type: object properties: - enabled: *503 + enabled: *504 allowed_actions: *62 sha_pinning_required: *63 required: @@ -67869,14 +70683,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: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: &504 + schema: &505 type: object properties: access_level: @@ -67894,7 +70708,7 @@ paths: required: - access_level examples: - default: &505 + default: &506 value: access_level: organization x-github: @@ -67919,15 +70733,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: - - *484 - *485 + - *486 requestBody: required: true content: application/json: - schema: *504 + schema: *505 examples: - default: *505 + default: *506 responses: '204': description: Response @@ -67951,8 +70765,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -67982,8 +70796,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: - - *484 - *485 + - *486 responses: '204': description: Empty response for successful settings update @@ -68017,8 +70831,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -68045,8 +70859,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: - - *484 - *485 + - *486 responses: '204': description: Response @@ -68080,8 +70894,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -68109,8 +70923,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -68141,8 +70955,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -68173,8 +70987,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: - - *484 - *485 + - *486 responses: '204': description: Response @@ -68206,8 +71020,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -68236,8 +71050,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: - - *484 - *485 + - *486 responses: '204': description: Success response @@ -68277,8 +71091,8 @@ paths: in: query schema: type: string - - *484 - *485 + - *486 - *17 - *19 responses: @@ -68322,8 +71136,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -68355,8 +71169,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -68430,8 +71244,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: - - *484 - *485 + - *486 responses: '201': description: Response @@ -68467,8 +71281,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: - - *484 - *485 + - *486 responses: '201': description: Response @@ -68498,8 +71312,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: - - *484 - *485 + - *486 - *77 responses: '200': @@ -68529,8 +71343,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: - - *484 - *485 + - *486 - *77 responses: '204': @@ -68557,8 +71371,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: - - *484 - *485 + - *486 - *77 responses: '200': *83 @@ -68583,8 +71397,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: - - *484 - *485 + - *486 - *77 requestBody: required: true @@ -68633,8 +71447,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: - - *484 - *485 + - *486 - *77 requestBody: required: true @@ -68684,8 +71498,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: - - *484 - *485 + - *486 - *77 responses: '200': *297 @@ -68715,8 +71529,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: - - *484 - *485 + - *486 - *77 - *298 responses: @@ -68746,9 +71560,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: - - *484 - *485 - - &523 + - *486 + - &524 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. @@ -68756,7 +71570,7 @@ paths: required: false schema: type: string - - &524 + - &525 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -68764,7 +71578,7 @@ paths: required: false schema: type: string - - &525 + - &526 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -68773,7 +71587,7 @@ paths: required: false schema: type: string - - &526 + - &527 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 @@ -68800,7 +71614,7 @@ paths: - pending - *17 - *19 - - &527 + - &528 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)." @@ -68809,7 +71623,7 @@ paths: schema: type: string format: date-time - - &506 + - &507 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -68818,13 +71632,13 @@ paths: schema: type: boolean default: false - - &528 + - &529 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &529 + - &530 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -68847,7 +71661,7 @@ paths: type: integer workflow_runs: type: array - items: &507 + items: &508 title: Workflow Run description: An invocation of a workflow type: object @@ -68995,7 +71809,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &551 + properties: &552 id: type: string description: SHA for the commit @@ -69046,7 +71860,7 @@ paths: - name - email nullable: true - required: &552 + required: &553 - id - tree_id - message @@ -69093,7 +71907,7 @@ paths: - workflow_url - pull_requests examples: - default: &530 + default: &531 value: total_count: 1 workflow_runs: @@ -69329,24 +72143,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *484 - *485 - - &508 + - *486 + - &509 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *506 + - *507 responses: '200': description: Response content: application/json: - schema: *507 + schema: *508 examples: - default: &511 + default: &512 value: id: 30433642 name: Build @@ -69587,9 +72401,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *484 - *485 - - *508 + - *486 + - *509 responses: '204': description: Response @@ -69612,9 +72426,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: - - *484 - *485 - - *508 + - *486 + - *509 responses: '200': description: Response @@ -69733,9 +72547,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: - - *484 - *485 - - *508 + - *486 + - *509 responses: '201': description: Response @@ -69768,12 +72582,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *484 - *485 - - *508 + - *486 + - *509 - *17 - *19 - - *509 + - *510 - *112 responses: '200': @@ -69790,9 +72604,9 @@ paths: type: integer artifacts: type: array - items: *493 + items: *494 examples: - default: *510 + default: *511 headers: Link: *47 x-github: @@ -69816,25 +72630,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *484 - *485 - - *508 - - &512 + - *486 + - *509 + - &513 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *506 + - *507 responses: '200': description: Response content: application/json: - schema: *507 + schema: *508 examples: - default: *511 + default: *512 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69857,10 +72671,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: - - *484 - *485 - - *508 - - *512 + - *486 + - *509 + - *513 - *17 - *19 responses: @@ -69878,9 +72692,9 @@ paths: type: integer jobs: type: array - items: *513 + items: *514 examples: - default: &514 + default: &515 value: total_count: 1 jobs: @@ -69993,10 +72807,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *484 - *485 - - *508 - - *512 + - *486 + - *509 + - *513 responses: '302': description: Response @@ -70024,9 +72838,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *484 - *485 - - *508 + - *486 + - *509 responses: '202': description: Response @@ -70042,6 +72856,192 @@ 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: + - *485 + - *486 + - *509 + - *17 + - *110 + - *111 + 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 + format: uri + description: API URL for the workflow run. + nullable: true + run_html_url: + type: string + format: uri + description: Web URL for the workflow run. + nullable: true + 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 + description: The ID of the job, when the item represents + a job-level or reusable-workflow-level lease. + nullable: true + job_name: + type: string + description: The display name of the job, when the + item represents a job-level or reusable-workflow-level + lease. + nullable: true + job_url: + type: string + format: uri + description: API URL for the job. + nullable: true + job_html_url: + type: string + format: uri + description: Web URL for the job. + nullable: true + 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: *47 + '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 @@ -70059,9 +73059,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: - - *484 - *485 - - *508 + - *486 + - *509 requestBody: required: true content: @@ -70128,9 +73128,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *484 - *485 - - *508 + - *486 + - *509 responses: '202': description: Response @@ -70163,9 +73163,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: - - *484 - *485 - - *508 + - *486 + - *509 - 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 @@ -70195,9 +73195,9 @@ paths: type: integer jobs: type: array - items: *513 + items: *514 examples: - default: *514 + default: *515 headers: Link: *47 x-github: @@ -70222,9 +73222,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *484 - *485 - - *508 + - *486 + - *509 responses: '302': description: Response @@ -70251,9 +73251,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *484 - *485 - - *508 + - *486 + - *509 responses: '204': description: Response @@ -70280,9 +73280,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: - - *484 - *485 - - *508 + - *486 + - *509 responses: '200': description: Response @@ -70342,7 +73342,7 @@ paths: items: type: object properties: - type: &644 + type: &645 type: string description: The type of reviewer. enum: @@ -70427,9 +73427,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: - - *484 - *485 - - *508 + - *486 + - *509 requestBody: required: true content: @@ -70476,12 +73476,12 @@ paths: application/json: schema: type: array - items: &631 + items: &632 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &896 + properties: &897 url: type: string format: uri @@ -70566,7 +73566,7 @@ paths: nullable: true properties: *224 required: *225 - required: &897 + required: &898 - id - node_id - sha @@ -70582,7 +73582,7 @@ paths: - created_at - updated_at examples: - default: &632 + default: &633 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -70638,9 +73638,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *484 - *485 - - *508 + - *486 + - *509 requestBody: required: false content: @@ -70684,9 +73684,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: - - *484 - *485 - - *508 + - *486 + - *509 requestBody: required: false content: @@ -70740,9 +73740,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *484 - *485 - - *508 + - *486 + - *509 responses: '200': description: Response @@ -70879,8 +73879,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-secrets parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -70898,9 +73898,9 @@ paths: type: integer secrets: type: array - items: *515 + items: *516 examples: - default: *516 + default: *517 headers: Link: *47 x-github: @@ -70925,16 +73925,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-public-key parameters: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: *517 + schema: *518 examples: - default: *518 + default: *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70956,17 +73956,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-secret parameters: - - *484 - *485 + - *486 - *300 responses: '200': description: Response content: application/json: - schema: *515 + schema: *516 examples: - default: &657 + default: &658 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -70992,8 +73992,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *484 - *485 + - *486 - *300 requestBody: required: true @@ -71051,8 +74051,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-a-repository-secret parameters: - - *484 - *485 + - *486 - *300 responses: '204': @@ -71078,9 +74078,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-variables parameters: - - *484 - *485 - - *502 + - *486 + - *503 - *19 responses: '200': @@ -71097,9 +74097,9 @@ paths: type: integer variables: type: array - items: *519 + items: *520 examples: - default: *520 + default: *521 headers: Link: *47 x-github: @@ -71122,8 +74122,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-a-repository-variable parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -71175,17 +74175,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-a-repository-variable parameters: - - *484 - *485 + - *486 - *303 responses: '200': description: Response content: application/json: - schema: *519 + schema: *520 examples: - default: &658 + default: &659 value: name: USERNAME value: octocat @@ -71211,8 +74211,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-a-repository-variable parameters: - - *484 - *485 + - *486 - *303 requestBody: required: true @@ -71255,8 +74255,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-a-repository-variable parameters: - - *484 - *485 + - *486 - *303 responses: '204': @@ -71282,8 +74282,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#list-repository-workflows parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -71301,7 +74301,7 @@ paths: type: integer workflows: type: array - items: &521 + items: &522 title: Workflow description: A GitHub Actions workflow type: object @@ -71408,9 +74408,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-a-workflow parameters: - - *484 - *485 - - &522 + - *486 + - &523 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -71425,7 +74425,7 @@ paths: description: Response content: application/json: - schema: *521 + schema: *522 examples: default: value: @@ -71458,9 +74458,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#disable-a-workflow parameters: - - *484 - *485 - - *522 + - *486 + - *523 responses: '204': description: Response @@ -71485,9 +74485,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *484 - *485 - - *522 + - *486 + - *523 responses: '204': description: Empty response when `return_run_details` parameter is `false`. @@ -71574,9 +74574,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#enable-a-workflow parameters: - - *484 - *485 - - *522 + - *486 + - *523 responses: '204': description: Response @@ -71603,19 +74603,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: - - *484 - *485 - - *522 + - *486 - *523 - *524 - *525 - *526 + - *527 - *17 - *19 - - *527 - - *506 - *528 + - *507 - *529 + - *530 responses: '200': description: Response @@ -71631,9 +74631,9 @@ paths: type: integer workflow_runs: type: array - items: *507 + items: *508 examples: - default: *530 + default: *531 headers: Link: *47 x-github: @@ -71666,9 +74666,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-workflow-usage parameters: - - *484 - *485 - - *522 + - *486 + - *523 responses: '200': description: Response @@ -71729,8 +74729,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-activities parameters: - - *484 - *485 + - *486 - *112 - *17 - *110 @@ -71894,8 +74894,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#list-assignees parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -71932,8 +74932,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: - - *484 - *485 + - *486 - name: assignee in: path required: true @@ -71969,8 +74969,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#create-an-attestation parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -72080,8 +75080,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#list-attestations parameters: - - *484 - *485 + - *486 - *17 - *110 - *111 @@ -72138,7 +75138,7 @@ paths: initiator: type: string examples: - default: *531 + default: *532 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72158,8 +75158,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *484 - *485 + - *486 responses: '200': description: Response @@ -72167,7 +75167,7 @@ paths: application/json: schema: type: array - items: &532 + items: &533 title: Autolink reference description: An autolink reference. type: object @@ -72221,8 +75221,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -72261,9 +75261,9 @@ paths: description: response content: application/json: - schema: *532 + schema: *533 examples: - default: &533 + default: &534 value: id: 1 key_prefix: TICKET- @@ -72294,9 +75294,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: - - *484 - *485 - - &534 + - *486 + - &535 name: autolink_id description: The unique identifier of the autolink. in: path @@ -72308,9 +75308,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *533 examples: - default: *533 + default: *534 '404': *6 x-github: githubCloudOnly: false @@ -72330,9 +75330,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: - - *484 - *485 - - *534 + - *486 + - *535 responses: '204': description: Response @@ -72356,8 +75356,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: - - *484 - *485 + - *486 responses: '200': description: Response if Dependabot is enabled @@ -72405,8 +75405,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-dependabot-security-updates parameters: - - *484 - *485 + - *486 responses: '204': description: Response @@ -72427,8 +75427,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-dependabot-security-updates parameters: - - *484 - *485 + - *486 responses: '204': description: Response @@ -72448,8 +75448,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#list-branches parameters: - - *484 - *485 + - *486 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -72487,7 +75487,7 @@ paths: - url protected: type: boolean - protection: &536 + protection: &537 title: Branch Protection description: Branch Protection type: object @@ -72529,7 +75529,7 @@ paths: required: - contexts - checks - enforce_admins: &539 + enforce_admins: &540 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -72544,7 +75544,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &541 + required_pull_request_reviews: &542 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -72620,7 +75620,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &538 + restrictions: &539 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -72897,9 +75897,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#get-a-branch parameters: - - *484 - *485 - - &537 + - *486 + - &538 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). @@ -72913,14 +75913,14 @@ paths: description: Response content: application/json: - schema: &547 + schema: &548 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &601 + commit: &602 title: Commit description: Commit type: object @@ -72954,7 +75954,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &535 + properties: &536 name: type: string example: '"Chris Wanstrath"' @@ -72970,7 +75970,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *535 + properties: *536 nullable: true message: type: string @@ -72991,7 +75991,7 @@ paths: required: - sha - url - verification: &664 + verification: &665 title: Verification type: object properties: @@ -73061,7 +76061,7 @@ paths: type: integer files: type: array - items: &614 + items: &615 title: Diff Entry description: Diff Entry type: object @@ -73145,7 +76145,7 @@ paths: - self protected: type: boolean - protection: *536 + protection: *537 protection_url: type: string format: uri @@ -73252,7 +76252,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *490 + '301': *491 '404': *6 x-github: githubCloudOnly: false @@ -73274,15 +76274,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-branch-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response content: application/json: - schema: *536 + schema: *537 examples: default: value: @@ -73476,9 +76476,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-branch-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: true content: @@ -73733,7 +76733,7 @@ paths: url: type: string format: uri - required_status_checks: &544 + required_status_checks: &545 title: Status Check Policy description: Status Check Policy type: object @@ -73885,7 +76885,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *538 + restrictions: *539 required_conversation_resolution: type: object properties: @@ -73997,9 +76997,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-branch-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '204': description: Response @@ -74024,17 +77024,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response content: application/json: - schema: *539 + schema: *540 examples: - default: &540 + default: &541 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -74056,17 +77056,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response content: application/json: - schema: *539 + schema: *540 examples: - default: *540 + default: *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74085,9 +77085,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '204': description: Response @@ -74112,17 +77112,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response content: application/json: - schema: *541 + schema: *542 examples: - default: &542 + default: &543 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -74218,9 +77218,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: false content: @@ -74318,9 +77318,9 @@ paths: description: Response content: application/json: - schema: *541 + schema: *542 examples: - default: *542 + default: *543 '422': *15 x-github: githubCloudOnly: false @@ -74341,9 +77341,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '204': description: Response @@ -74370,17 +77370,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response content: application/json: - schema: *539 + schema: *540 examples: - default: &543 + default: &544 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -74403,17 +77403,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response content: application/json: - schema: *539 + schema: *540 examples: - default: *543 + default: *544 '404': *6 x-github: githubCloudOnly: false @@ -74433,9 +77433,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '204': description: Response @@ -74460,17 +77460,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-status-checks-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response content: application/json: - schema: *544 + schema: *545 examples: - default: &545 + default: &546 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -74496,9 +77496,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-status-check-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: false content: @@ -74550,9 +77550,9 @@ paths: description: Response content: application/json: - schema: *544 + schema: *545 examples: - default: *545 + default: *546 '404': *6 '422': *15 x-github: @@ -74574,9 +77574,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '204': description: Response @@ -74600,9 +77600,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response @@ -74636,9 +77636,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-status-check-contexts parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: false content: @@ -74705,9 +77705,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-status-check-contexts parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: false content: @@ -74771,9 +77771,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: content: application/json: @@ -74839,15 +77839,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response content: application/json: - schema: *538 + schema: *539 examples: default: value: @@ -74938,9 +77938,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '204': description: Response @@ -74963,9 +77963,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: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response @@ -74975,7 +77975,7 @@ paths: type: array items: *5 examples: - default: &546 + default: &547 value: - id: 1 slug: octoapp @@ -75032,9 +78032,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: true content: @@ -75068,7 +78068,7 @@ paths: type: array items: *5 examples: - default: *546 + default: *547 '422': *15 x-github: githubCloudOnly: false @@ -75089,9 +78089,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: true content: @@ -75125,7 +78125,7 @@ paths: type: array items: *5 examples: - default: *546 + default: *547 '422': *15 x-github: githubCloudOnly: false @@ -75146,9 +78146,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: true content: @@ -75182,7 +78182,7 @@ paths: type: array items: *5 examples: - default: *546 + default: *547 '422': *15 x-github: githubCloudOnly: false @@ -75204,9 +78204,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: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response @@ -75236,9 +78236,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: false content: @@ -75297,9 +78297,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: false content: @@ -75358,9 +78358,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: content: application/json: @@ -75419,9 +78419,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: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response @@ -75455,9 +78455,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: true content: @@ -75515,9 +78515,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: true content: @@ -75575,9 +78575,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: true content: @@ -75637,9 +78637,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#rename-a-branch parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: true content: @@ -75661,7 +78661,7 @@ paths: description: Response content: application/json: - schema: *547 + schema: *548 examples: default: value: @@ -75775,8 +78775,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *484 - *485 + - *486 - *105 - *106 - *107 @@ -75812,8 +78812,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *484 - *485 + - *486 - name: bypass_request_number in: path required: true @@ -75886,8 +78886,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *484 - *485 + - *486 - *105 - *106 - *107 @@ -75927,8 +78927,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *484 - *485 + - *486 - name: bypass_request_number in: path required: true @@ -75998,8 +78998,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *484 - *485 + - *486 - name: bypass_request_number in: path required: true @@ -76070,8 +79070,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *484 - *485 + - *486 - name: bypass_response_id in: path required: true @@ -76104,8 +79104,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#create-a-check-run parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -76384,7 +79384,7 @@ paths: description: Response content: application/json: - schema: &548 + schema: &549 title: CheckRun description: A check performed on the code of a given code change type: object @@ -76504,7 +79504,7 @@ paths: check. type: array items: *234 - deployment: &889 + deployment: &890 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -76784,9 +79784,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#get-a-check-run parameters: - - *484 - *485 - - &549 + - *486 + - &550 name: check_run_id description: The unique identifier of the check run. in: path @@ -76798,9 +79798,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *549 examples: - default: &550 + default: &551 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -76900,9 +79900,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run parameters: - - *484 - *485 - - *549 + - *486 + - *550 requestBody: required: true content: @@ -77142,9 +80142,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *549 examples: - default: *550 + default: *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77164,9 +80164,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-run-annotations parameters: - - *484 - *485 - - *549 + - *486 + - *550 - *17 - *19 responses: @@ -77261,9 +80261,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#rerequest-a-check-run parameters: - - *484 - *485 - - *549 + - *486 + - *550 responses: '201': description: Response @@ -77307,8 +80307,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -77330,7 +80330,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &553 + schema: &554 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -77416,12 +80416,12 @@ paths: type: string format: date-time nullable: true - head_commit: &922 + head_commit: &923 title: Simple Commit description: A commit. type: object - properties: *551 - required: *552 + properties: *552 + required: *553 latest_check_runs_count: type: integer check_runs_url: @@ -77449,7 +80449,7 @@ paths: - check_runs_url - pull_requests examples: - default: &554 + default: &555 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -77740,9 +80740,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *553 + schema: *554 examples: - default: *554 + default: *555 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77761,8 +80761,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -78071,9 +81071,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite parameters: - - *484 - *485 - - &555 + - *486 + - &556 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -78085,9 +81085,9 @@ paths: description: Response content: application/json: - schema: *553 + schema: *554 examples: - default: *554 + default: *555 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78110,17 +81110,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: - - *484 - *485 - - *555 - - &607 + - *486 + - *556 + - &608 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &608 + - &609 name: status description: Returns check runs with the specified `status`. in: query @@ -78159,9 +81159,9 @@ paths: type: integer check_runs: type: array - items: *548 + items: *549 examples: - default: &609 + default: &610 value: total_count: 1 check_runs: @@ -78263,9 +81263,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#rerequest-a-check-suite parameters: - - *484 - *485 - - *555 + - *486 + - *556 responses: '201': description: Response @@ -78298,21 +81298,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: - - *484 - *485 + - *486 - *323 - *324 - *19 - *17 - - &571 + - &572 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: *556 - - &572 + schema: *557 + - &573 name: pr description: The number of the pull request for the results you want to list. in: query @@ -78343,7 +81343,7 @@ paths: be returned. in: query required: false - schema: *557 + schema: *558 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -78367,7 +81367,7 @@ paths: updated_at: *139 url: *136 html_url: *137 - instances_url: *558 + instances_url: *559 state: *115 fixed_at: *141 dismissed_by: @@ -78378,11 +81378,11 @@ paths: required: *21 nullable: true dismissed_at: *140 - dismissed_reason: *559 - dismissed_comment: *560 - rule: *561 - tool: *562 - most_recent_instance: *563 + dismissed_reason: *560 + dismissed_comment: *561 + rule: *562 + tool: *563 + most_recent_instance: *564 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -78508,7 +81508,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &564 + '403': &565 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -78535,9 +81535,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: - - *484 - *485 - - &565 + - *486 + - &566 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -78551,7 +81551,7 @@ paths: description: Response content: application/json: - schema: &566 + schema: &567 type: object properties: number: *131 @@ -78559,7 +81559,7 @@ paths: updated_at: *139 url: *136 html_url: *137 - instances_url: *558 + instances_url: *559 state: *115 fixed_at: *141 dismissed_by: @@ -78570,8 +81570,8 @@ paths: required: *21 nullable: true dismissed_at: *140 - dismissed_reason: *559 - dismissed_comment: *560 + dismissed_reason: *560 + dismissed_comment: *561 rule: type: object properties: @@ -78625,8 +81625,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *562 - most_recent_instance: *563 + tool: *563 + most_recent_instance: *564 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -78725,7 +81725,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *564 + '403': *565 '404': *6 '503': *200 x-github: @@ -78745,9 +81745,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: - - *484 - *485 - - *565 + - *486 + - *566 requestBody: required: true content: @@ -78762,8 +81762,8 @@ paths: enum: - open - dismissed - dismissed_reason: *559 - dismissed_comment: *560 + dismissed_reason: *560 + dismissed_comment: *561 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -78791,7 +81791,7 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: default: value: @@ -78867,7 +81867,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &570 + '403': &571 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -78894,15 +81894,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: - - *484 - *485 - - *565 + - *486 + - *566 responses: '200': description: Response content: application/json: - schema: &567 + schema: &568 type: object properties: status: @@ -78928,13 +81928,13 @@ paths: - description - started_at examples: - default: &568 + default: &569 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &569 + '400': &570 description: Bad Request content: application/json: @@ -78945,7 +81945,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': *564 + '403': *565 '404': *6 '503': *200 x-github: @@ -78970,29 +81970,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: - - *484 - *485 - - *565 + - *486 + - *566 responses: '200': description: OK content: application/json: - schema: *567 + schema: *568 examples: - default: *568 + default: *569 '202': description: Accepted content: application/json: - schema: *567 + schema: *568 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *569 + '400': *570 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -79024,9 +82024,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: - - *484 - *485 - - *565 + - *486 + - *566 requestBody: required: false content: @@ -79071,8 +82071,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *569 - '403': *570 + '400': *570 + '403': *571 '404': *6 '422': description: Unprocessable Entity @@ -79096,13 +82096,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: - - *484 - *485 - - *565 + - *486 + - *566 - *19 - *17 - - *571 - *572 + - *573 responses: '200': description: Response @@ -79113,10 +82113,10 @@ paths: items: type: object properties: - ref: *556 - analysis_key: *573 - environment: *574 - category: *575 + ref: *557 + analysis_key: *574 + environment: *575 + category: *576 state: type: string description: State of a code scanning alert instance. @@ -79131,7 +82131,7 @@ paths: properties: text: type: string - location: *576 + location: *577 html_url: type: string classifications: @@ -79139,7 +82139,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: *577 + items: *578 examples: default: value: @@ -79176,7 +82176,7 @@ paths: end_column: 50 classifications: - source - '403': *564 + '403': *565 '404': *6 '503': *200 x-github: @@ -79210,25 +82210,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: - - *484 - *485 + - *486 - *323 - *324 - *19 - *17 - - *572 + - *573 - 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: *556 + schema: *557 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &578 + schema: &579 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -79249,23 +82249,23 @@ paths: application/json: schema: type: array - items: &579 + items: &580 type: object properties: - ref: *556 - commit_sha: &587 + ref: *557 + commit_sha: &588 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: *573 + analysis_key: *574 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *575 + category: *576 error: type: string example: error reading field xyz @@ -79289,8 +82289,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *578 - tool: *562 + sarif_id: *579 + tool: *563 deletable: type: boolean warning: @@ -79351,7 +82351,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *564 + '403': *565 '404': *6 '503': *200 x-github: @@ -79387,8 +82387,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: - - *484 - *485 + - *486 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -79401,7 +82401,7 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: response: summary: application/json response @@ -79455,7 +82455,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *564 + '403': *565 '404': *6 '422': description: Response if analysis could not be processed @@ -79542,8 +82542,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: - - *484 - *485 + - *486 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -79596,7 +82596,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': *570 + '403': *571 '404': *6 '503': *200 x-github: @@ -79618,8 +82618,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -79627,7 +82627,7 @@ paths: application/json: schema: type: array - items: &580 + items: &581 title: CodeQL Database description: A CodeQL database. type: object @@ -79738,7 +82738,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': *564 + '403': *565 '404': *6 '503': *200 x-github: @@ -79767,8 +82767,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: - - *484 - *485 + - *486 - name: language in: path description: The language of the CodeQL database. @@ -79780,7 +82780,7 @@ paths: description: Response content: application/json: - schema: *580 + schema: *581 examples: default: value: @@ -79812,9 +82812,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': &618 + '302': &619 description: Found - '403': *564 + '403': *565 '404': *6 '503': *200 x-github: @@ -79836,8 +82836,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *484 - *485 + - *486 - name: language in: path description: The language of the CodeQL database. @@ -79847,7 +82847,7 @@ paths: responses: '204': description: Response - '403': *570 + '403': *571 '404': *6 '503': *200 x-github: @@ -79875,8 +82875,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -79885,7 +82885,7 @@ paths: type: object additionalProperties: false properties: - language: &581 + language: &582 type: string description: The language targeted by the CodeQL query enum: @@ -79965,7 +82965,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &585 + schema: &586 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -79975,7 +82975,7 @@ paths: description: The ID of the variant analysis. controller_repo: *122 actor: *4 - query_language: *581 + query_language: *582 query_pack_url: type: string description: The download url for the query pack. @@ -80022,7 +83022,7 @@ paths: items: type: object properties: - repository: &582 + repository: &583 title: Repository Identifier description: Repository Identifier type: object @@ -80058,7 +83058,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &586 + analysis_status: &587 type: string description: The new status of the CodeQL variant analysis repository task. @@ -80090,7 +83090,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &583 + access_mismatch_repos: &584 type: object properties: repository_count: @@ -80104,7 +83104,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: *582 + items: *583 required: - repository_count - repositories @@ -80126,8 +83126,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *583 - over_limit_repos: *583 + no_codeql_db_repos: *584 + over_limit_repos: *584 required: - access_mismatch_repos - not_found_repos @@ -80143,7 +83143,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &584 + value: &585 summary: Default response value: id: 1 @@ -80289,10 +83289,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *584 + value: *585 repository_lists: summary: Response for a successful variant analysis submission - value: *584 + value: *585 '404': *6 '422': description: Unable to process variant analysis submission @@ -80320,8 +83320,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: - - *484 - *485 + - *486 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -80333,9 +83333,9 @@ paths: description: Response content: application/json: - schema: *585 + schema: *586 examples: - default: *584 + default: *585 '404': *6 '503': *200 x-github: @@ -80358,7 +83358,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: - - *484 + - *485 - name: repo in: path description: The name of the controller repository. @@ -80393,7 +83393,7 @@ paths: type: object properties: repository: *122 - analysis_status: *586 + analysis_status: *587 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -80518,8 +83518,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -80604,7 +83604,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *564 + '403': *565 '404': *6 '503': *200 x-github: @@ -80625,8 +83625,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -80718,7 +83718,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *570 + '403': *571 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -80789,8 +83789,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -80798,7 +83798,7 @@ paths: schema: type: object properties: - commit_sha: *587 + commit_sha: *588 ref: type: string description: |- @@ -80856,7 +83856,7 @@ paths: schema: type: object properties: - id: *578 + id: *579 url: type: string description: The REST API URL for checking the status of the upload. @@ -80870,7 +83870,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': *570 + '403': *571 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -80893,8 +83893,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: - - *484 - *485 + - *486 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -80940,7 +83940,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': *564 + '403': *565 '404': description: Not Found if the sarif id does not match any upload '503': *200 @@ -80965,8 +83965,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -81047,8 +84047,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-codeowners-errors parameters: - - *484 - *485 + - *486 - 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 @@ -81168,8 +84168,8 @@ paths: parameters: - *17 - *19 - - *484 - *485 + - *486 responses: '200': description: Response @@ -81483,8 +84483,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -81549,7 +84549,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -81557,7 +84557,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '400': *14 '401': *25 '403': *29 @@ -81586,8 +84586,8 @@ paths: parameters: - *17 - *19 - - *484 - *485 + - *486 responses: '200': description: Response @@ -81651,8 +84651,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: - - *484 - *485 + - *486 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -81687,14 +84687,14 @@ paths: type: integer machines: type: array - items: &833 + items: &834 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *589 - required: *590 + properties: *590 + required: *591 examples: - default: &834 + default: &835 value: total_count: 2 machines: @@ -81734,8 +84734,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *484 - *485 + - *486 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -81819,8 +84819,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: - - *484 - *485 + - *486 - 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 @@ -81886,8 +84886,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -81905,7 +84905,7 @@ paths: type: integer secrets: type: array - items: &594 + items: &595 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -81925,7 +84925,7 @@ paths: - created_at - updated_at examples: - default: *591 + default: *592 headers: Link: *47 x-github: @@ -81948,16 +84948,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: *592 + schema: *593 examples: - default: *593 + default: *594 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -81977,17 +84977,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *484 - *485 + - *486 - *300 responses: '200': description: Response content: application/json: - schema: *594 + schema: *595 examples: - default: *595 + default: *596 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82007,8 +85007,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: - - *484 - *485 + - *486 - *300 requestBody: required: true @@ -82061,8 +85061,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *484 - *485 + - *486 - *300 responses: '204': @@ -82091,8 +85091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *484 - *485 + - *486 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -82134,7 +85134,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &596 + properties: &597 login: type: string example: octocat @@ -82227,7 +85227,7 @@ paths: user_view_type: type: string example: public - required: &597 + required: &598 - avatar_url - events_url - followers_url @@ -82301,8 +85301,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: - - *484 - *485 + - *486 - *148 responses: '204': @@ -82349,8 +85349,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *484 - *485 + - *486 - *148 requestBody: required: false @@ -82377,7 +85377,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &676 + schema: &677 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -82606,8 +85606,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *484 - *485 + - *486 - *148 responses: '204': @@ -82639,8 +85639,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *484 - *485 + - *486 - *148 responses: '200': @@ -82661,8 +85661,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *596 - required: *597 + properties: *597 + required: *598 nullable: true required: - permission @@ -82717,8 +85717,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -82728,7 +85728,7 @@ paths: application/json: schema: type: array - items: &598 + items: &599 title: Commit Comment description: Commit Comment type: object @@ -82786,7 +85786,7 @@ paths: - created_at - updated_at examples: - default: &603 + default: &604 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -82845,17 +85845,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment parameters: - - *484 - *485 + - *486 - *245 responses: '200': description: Response content: application/json: - schema: *598 + schema: *599 examples: - default: &604 + default: &605 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -82912,8 +85912,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#update-a-commit-comment parameters: - - *484 - *485 + - *486 - *245 requestBody: required: true @@ -82936,7 +85936,7 @@ paths: description: Response content: application/json: - schema: *598 + schema: *599 examples: default: value: @@ -82987,8 +85987,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#delete-a-commit-comment parameters: - - *484 - *485 + - *486 - *245 responses: '204': @@ -83010,8 +86010,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *484 - *485 + - *486 - *245 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). @@ -83038,7 +86038,7 @@ paths: application/json: schema: type: array - items: &599 + items: &600 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -83081,7 +86081,7 @@ paths: - content - created_at examples: - default: &680 + default: &681 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -83126,8 +86126,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *484 - *485 + - *486 - *245 requestBody: required: true @@ -83160,9 +86160,9 @@ paths: description: Reaction exists content: application/json: - schema: *599 + schema: *600 examples: - default: &600 + default: &601 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -83191,9 +86191,9 @@ paths: description: Reaction created content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 '422': *15 x-github: githubCloudOnly: false @@ -83215,10 +86215,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *484 - *485 + - *486 - *245 - - &681 + - &682 name: reaction_id description: The unique identifier of the reaction. in: path @@ -83273,8 +86273,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-commits parameters: - - *484 - *485 + - *486 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -83330,9 +86330,9 @@ paths: application/json: schema: type: array - items: *601 + items: *602 examples: - default: &734 + default: &735 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -83426,9 +86426,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-branches-for-head-commit parameters: - - *484 - *485 - - &602 + - *486 + - &603 name: commit_sha description: The SHA of the commit. in: path @@ -83500,9 +86500,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments parameters: - - *484 - *485 - - *602 + - *486 + - *603 - *17 - *19 responses: @@ -83512,9 +86512,9 @@ paths: application/json: schema: type: array - items: *598 + items: *599 examples: - default: *603 + default: *604 headers: Link: *47 x-github: @@ -83542,9 +86542,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#create-a-commit-comment parameters: - - *484 - *485 - - *602 + - *486 + - *603 requestBody: required: true content: @@ -83579,9 +86579,9 @@ paths: description: Response content: application/json: - schema: *598 + schema: *599 examples: - default: *604 + default: *605 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -83609,9 +86609,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: - - *484 - *485 - - *602 + - *486 + - *603 - *17 - *19 responses: @@ -83621,9 +86621,9 @@ paths: application/json: schema: type: array - items: *605 + items: *606 examples: - default: &726 + default: &727 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -84160,11 +87160,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#get-a-commit parameters: - - *484 - *485 + - *486 - *19 - *17 - - &606 + - &607 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)" @@ -84179,9 +87179,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *602 examples: - default: &711 + default: &712 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -84269,7 +87269,7 @@ paths: schema: type: string examples: - default: &615 + default: &616 value: | diff --git a/testfile b/testfile index 9bdeaeb..912c7ef 100644 @@ -84282,7 +87282,7 @@ paths: schema: type: string examples: - default: &616 + default: &617 value: | From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 From: Mona Lisa <87831417+monalisa@users.noreply.github.com> @@ -84335,11 +87335,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: - - *484 - *485 - - *606 + - *486 - *607 - *608 + - *609 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -84373,9 +87373,9 @@ paths: type: integer check_runs: type: array - items: *548 + items: *549 examples: - default: *609 + default: *610 headers: Link: *47 x-github: @@ -84400,9 +87400,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: - - *484 - *485 - - *606 + - *486 + - *607 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -84410,7 +87410,7 @@ paths: schema: type: integer example: 1 - - *607 + - *608 - *17 - *19 responses: @@ -84428,7 +87428,7 @@ paths: type: integer check_suites: type: array - items: *553 + items: *554 examples: default: value: @@ -84628,9 +87628,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: - - *484 - *485 - - *606 + - *486 + - *607 - *17 - *19 responses: @@ -84828,9 +87828,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *484 - *485 - - *606 + - *486 + - *607 - *17 - *19 responses: @@ -84840,7 +87840,7 @@ paths: application/json: schema: type: array - items: &787 + items: &788 title: Status description: The status of a commit. type: object @@ -84921,7 +87921,7 @@ paths: site_admin: false headers: Link: *47 - '301': *490 + '301': *491 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84949,8 +87949,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/community#get-community-profile-metrics parameters: - - *484 - *485 + - *486 responses: '200': description: Response @@ -84979,20 +87979,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *610 - required: *611 + properties: *611 + required: *612 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &612 + properties: &613 url: type: string format: uri html_url: type: string format: uri - required: &613 + required: &614 - url - html_url nullable: true @@ -85006,26 +88006,26 @@ paths: contributing: title: Community Health File type: object - properties: *612 - required: *613 + properties: *613 + required: *614 nullable: true readme: title: Community Health File type: object - properties: *612 - required: *613 + properties: *613 + required: *614 nullable: true issue_template: title: Community Health File type: object - properties: *612 - required: *613 + properties: *613 + required: *614 nullable: true pull_request_template: title: Community Health File type: object - properties: *612 - required: *613 + properties: *613 + required: *614 nullable: true required: - code_of_conduct @@ -85152,8 +88152,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#compare-two-commits parameters: - - *484 - *485 + - *486 - *19 - *17 - name: basehead @@ -85196,8 +88196,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *601 - merge_base_commit: *601 + base_commit: *602 + merge_base_commit: *602 status: type: string enum: @@ -85217,10 +88217,10 @@ paths: example: 6 commits: type: array - items: *601 + items: *602 files: type: array - items: *614 + items: *615 required: - url - html_url @@ -85466,12 +88466,12 @@ paths: schema: type: string examples: - default: *615 + default: *616 application/vnd.github.patch: schema: type: string examples: - default: *616 + default: *617 '404': *6 '500': *40 '503': *200 @@ -85516,8 +88516,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-repository-content parameters: - - *484 - *485 + - *486 - name: path description: path parameter in: path @@ -85677,7 +88677,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &617 + response-if-content-is-a-file-github-object: &618 summary: Response if content is a file value: type: file @@ -85809,7 +88809,7 @@ paths: - size - type - url - - &739 + - &740 title: Content File description: Content File type: object @@ -86010,7 +89010,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *617 + response-if-content-is-a-file: *618 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -86079,7 +89079,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *618 + '302': *619 '304': *37 x-github: githubCloudOnly: false @@ -86102,8 +89102,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#create-or-update-file-contents parameters: - - *484 - *485 + - *486 - name: path description: path parameter in: path @@ -86196,7 +89196,7 @@ paths: description: Response content: application/json: - schema: &619 + schema: &620 title: File Commit description: File Commit type: object @@ -86348,7 +89348,7 @@ paths: description: Response content: application/json: - schema: *619 + schema: *620 examples: example-for-creating-a-file: value: @@ -86402,7 +89402,7 @@ paths: schema: oneOf: - *3 - - &659 + - &660 description: Repository rule violation was detected type: object properties: @@ -86423,7 +89423,7 @@ paths: items: type: object properties: - placeholder_id: &779 + placeholder_id: &780 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -86455,8 +89455,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#delete-a-file parameters: - - *484 - *485 + - *486 - name: path description: path parameter in: path @@ -86517,7 +89517,7 @@ paths: description: Response content: application/json: - schema: *619 + schema: *620 examples: default: value: @@ -86572,8 +89572,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-contributors parameters: - - *484 - *485 + - *486 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -86696,8 +89696,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *484 - *485 + - *486 - *344 - *345 - *346 @@ -86710,7 +89710,7 @@ paths: schema: type: string - *349 - - *620 + - *621 - *350 - *351 - *352 @@ -86725,7 +89725,7 @@ paths: application/json: schema: type: array - items: &624 + items: &625 type: object description: A Dependabot alert. properties: @@ -86772,7 +89772,7 @@ paths: - direct - transitive - inconclusive - security_advisory: *621 + security_advisory: *622 security_vulnerability: *135 url: *136 html_url: *137 @@ -86803,8 +89803,8 @@ paths: nullable: true maxLength: 280 fixed_at: *141 - auto_dismissed_at: *622 - dismissal_request: *623 + auto_dismissed_at: *623 + dismissal_request: *624 assignees: type: array description: The users assigned to this alert. @@ -87059,9 +90059,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *484 - *485 - - &625 + - *486 + - &626 name: alert_number in: path description: |- @@ -87076,7 +90076,7 @@ paths: description: Response content: application/json: - schema: *624 + schema: *625 examples: default: value: @@ -87208,9 +90208,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *484 - *485 - - *625 + - *486 + - *626 requestBody: required: true content: @@ -87266,7 +90266,7 @@ paths: description: Response content: application/json: - schema: *624 + schema: *625 examples: default: value: @@ -87396,8 +90396,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-repository-secrets parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -87415,7 +90415,7 @@ paths: type: integer secrets: type: array - items: &628 + items: &629 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -87468,16 +90468,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: *627 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87497,15 +90497,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-secret parameters: - - *484 - *485 + - *486 - *300 responses: '200': description: Response content: application/json: - schema: *628 + schema: *629 examples: default: value: @@ -87531,8 +90531,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *484 - *485 + - *486 - *300 requestBody: required: true @@ -87585,8 +90585,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *484 - *485 + - *486 - *300 responses: '204': @@ -87609,8 +90609,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: - - *484 - *485 + - *486 - 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 @@ -87770,8 +90770,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -88009,8 +91009,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: - - *484 - *485 + - *486 - name: sbom_uuid in: path required: true @@ -88021,7 +91021,7 @@ paths: '302': description: Redirects to a temporary download URL for the completed SBOM. headers: - Location: *629 + Location: *630 '202': description: SBOM is still being processed, no content is returned. '404': *6 @@ -88042,8 +91042,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: - - *484 - *485 + - *486 responses: '201': description: Response @@ -88081,8 +91081,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -88157,7 +91157,7 @@ paths: - version - url additionalProperties: false - metadata: &630 + metadata: &631 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -88190,7 +91190,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *630 + metadata: *631 resolved: type: object description: A collection of resolved package dependencies. @@ -88203,7 +91203,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *630 + metadata: *631 relationship: type: string description: A notation of whether a dependency is requested @@ -88332,8 +91332,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments parameters: - - *484 - *485 + - *486 - name: sha description: The SHA recorded at creation time. in: query @@ -88373,9 +91373,9 @@ paths: application/json: schema: type: array - items: *631 + items: *632 examples: - default: *632 + default: *633 headers: Link: *47 x-github: @@ -88441,8 +91441,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#create-a-deployment parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -88523,7 +91523,7 @@ paths: description: Response content: application/json: - schema: *631 + schema: *632 examples: simple-example: summary: Simple example @@ -88596,9 +91596,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#get-a-deployment parameters: - - *484 - *485 - - &633 + - *486 + - &634 name: deployment_id description: deployment_id parameter in: path @@ -88610,7 +91610,7 @@ paths: description: Response content: application/json: - schema: *631 + schema: *632 examples: default: value: @@ -88675,9 +91675,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#delete-a-deployment parameters: - - *484 - *485 - - *633 + - *486 + - *634 responses: '204': description: Response @@ -88699,9 +91699,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#list-deployment-statuses parameters: - - *484 - *485 - - *633 + - *486 + - *634 - *17 - *19 responses: @@ -88711,7 +91711,7 @@ paths: application/json: schema: type: array - items: &634 + items: &635 title: Deployment Status description: The status of a deployment. type: object @@ -88872,9 +91872,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#create-a-deployment-status parameters: - - *484 - *485 - - *633 + - *486 + - *634 requestBody: required: true content: @@ -88949,9 +91949,9 @@ paths: description: Response content: application/json: - schema: *634 + schema: *635 examples: - default: &635 + default: &636 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -89007,9 +92007,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#get-a-deployment-status parameters: - - *484 - *485 - - *633 + - *486 + - *634 - name: status_id in: path required: true @@ -89020,9 +92020,9 @@ paths: description: Response content: application/json: - schema: *634 + schema: *635 examples: - default: *635 + default: *636 '404': *6 x-github: githubCloudOnly: false @@ -89049,12 +92049,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *484 - *485 - - *636 + - *486 - *637 - *638 - *639 + - *640 - *17 - *19 responses: @@ -89064,9 +92064,9 @@ paths: application/json: schema: type: array - items: *640 + items: *641 examples: - default: *641 + default: *642 '404': *6 '403': *29 '500': *40 @@ -89090,8 +92090,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *484 - *485 + - *486 - name: alert_number in: path required: true @@ -89103,7 +92103,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *640 + schema: *641 examples: default: value: @@ -89159,8 +92159,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *484 - *485 + - *486 - name: alert_number in: path required: true @@ -89219,12 +92219,12 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *484 - *485 - - *636 + - *486 - *637 - *638 - *639 + - *640 - *17 - *19 responses: @@ -89234,9 +92234,9 @@ paths: application/json: schema: type: array - items: *642 + items: *643 examples: - default: *643 + default: *644 '404': *6 '403': *29 '500': *40 @@ -89260,8 +92260,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *484 - *485 + - *486 - name: alert_number in: path required: true @@ -89273,7 +92273,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *642 + schema: *643 examples: default: value: @@ -89324,8 +92324,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *484 - *485 + - *486 - name: alert_number in: path required: true @@ -89363,7 +92363,7 @@ paths: description: The created dismissal request. content: application/json: - schema: *642 + schema: *643 examples: default: value: @@ -89414,8 +92414,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *484 - *485 + - *486 - name: alert_number in: path required: true @@ -89486,8 +92486,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *484 - *485 + - *486 - name: alert_number in: path required: true @@ -89520,8 +92520,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *484 - *485 + - *486 - *105 - *106 - *107 @@ -89562,8 +92562,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *484 - *485 + - *486 - name: alert_number in: path required: true @@ -89633,8 +92633,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *484 - *485 + - *486 - name: alert_number in: path required: true @@ -89703,8 +92703,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -89761,8 +92761,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#list-environments parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -89779,7 +92779,7 @@ paths: type: integer environments: type: array - items: &645 + items: &646 title: Environment description: Details of a deployment environment type: object @@ -89831,7 +92831,7 @@ paths: type: type: string example: wait_timer - wait_timer: &647 + wait_timer: &648 type: integer example: 30 description: The amount of time to delay a job after @@ -89868,7 +92868,7 @@ paths: items: type: object properties: - type: *644 + type: *645 reviewer: anyOf: - *4 @@ -89892,7 +92892,7 @@ paths: - id - node_id - type - deployment_branch_policy: &648 + deployment_branch_policy: &649 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -90008,9 +93008,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#get-an-environment parameters: - - *484 - *485 - - &646 + - *486 + - &647 name: environment_name in: path required: true @@ -90023,9 +93023,9 @@ paths: description: Response content: application/json: - schema: *645 + schema: *646 examples: - default: &649 + default: &650 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -90109,9 +93109,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#create-or-update-an-environment parameters: - - *484 - *485 - - *646 + - *486 + - *647 requestBody: required: false content: @@ -90120,7 +93120,7 @@ paths: type: object nullable: true properties: - wait_timer: *647 + wait_timer: *648 prevent_self_review: type: boolean example: false @@ -90137,13 +93137,13 @@ paths: items: type: object properties: - type: *644 + type: *645 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *648 + deployment_branch_policy: *649 additionalProperties: false examples: default: @@ -90163,9 +93163,9 @@ paths: description: Response content: application/json: - schema: *645 + schema: *646 examples: - default: *649 + default: *650 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -90189,9 +93189,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#delete-an-environment parameters: - - *484 - *485 - - *646 + - *486 + - *647 responses: '204': description: Default response @@ -90216,9 +93216,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *484 - *485 - - *646 + - *486 + - *647 - *17 - *19 responses: @@ -90236,7 +93236,7 @@ paths: example: 2 branch_policies: type: array - items: &650 + items: &651 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -90293,9 +93293,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *484 - *485 - - *646 + - *486 + - *647 requestBody: required: true content: @@ -90341,9 +93341,9 @@ paths: description: Response content: application/json: - schema: *650 + schema: *651 examples: - example-wildcard: &651 + example-wildcard: &652 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -90385,10 +93385,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *484 - *485 - - *646 - - &652 + - *486 + - *647 + - &653 name: branch_policy_id in: path required: true @@ -90400,9 +93400,9 @@ paths: description: Response content: application/json: - schema: *650 + schema: *651 examples: - default: *651 + default: *652 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90421,10 +93421,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *484 - *485 - - *646 - - *652 + - *486 + - *647 + - *653 requestBody: required: true content: @@ -90452,9 +93452,9 @@ paths: description: Response content: application/json: - schema: *650 + schema: *651 examples: - default: *651 + default: *652 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90473,10 +93473,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *484 - *485 - - *646 - - *652 + - *486 + - *647 + - *653 responses: '204': description: Response @@ -90501,9 +93501,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: - - *646 + - *647 + - *486 - *485 - - *484 responses: '200': description: List of deployment protection rules @@ -90519,7 +93519,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &653 + items: &654 title: Deployment protection rule description: Deployment protection rule type: object @@ -90538,7 +93538,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &654 + app: &655 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -90637,9 +93637,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: - - *646 + - *647 + - *486 - *485 - - *484 requestBody: content: application/json: @@ -90660,9 +93660,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *653 + schema: *654 examples: - default: &655 + default: &656 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -90697,9 +93697,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: - - *646 + - *647 + - *486 - *485 - - *484 - *19 - *17 responses: @@ -90718,7 +93718,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *654 + items: *655 examples: default: value: @@ -90753,10 +93753,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: - - *484 - *485 - - *646 - - &656 + - *486 + - *647 + - &657 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -90768,9 +93768,9 @@ paths: description: Response content: application/json: - schema: *653 + schema: *654 examples: - default: *655 + default: *656 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90791,10 +93791,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: - - *646 + - *647 + - *486 - *485 - - *484 - - *656 + - *657 responses: '204': description: Response @@ -90820,9 +93820,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-environment-secrets parameters: - - *484 - *485 - - *646 + - *486 + - *647 - *17 - *19 responses: @@ -90840,9 +93840,9 @@ paths: type: integer secrets: type: array - items: *515 + items: *516 examples: - default: *516 + default: *517 headers: Link: *47 x-github: @@ -90867,17 +93867,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-public-key parameters: - - *484 - *485 - - *646 + - *486 + - *647 responses: '200': description: Response content: application/json: - schema: *517 + schema: *518 examples: - default: *518 + default: *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90899,18 +93899,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-secret parameters: - - *484 - *485 - - *646 + - *486 + - *647 - *300 responses: '200': description: Response content: application/json: - schema: *515 + schema: *516 examples: - default: *657 + default: *658 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90932,9 +93932,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *484 - *485 - - *646 + - *486 + - *647 - *300 requestBody: required: true @@ -90992,9 +93992,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-an-environment-secret parameters: - - *484 - *485 - - *646 + - *486 + - *647 - *300 responses: '204': @@ -91020,10 +94020,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-environment-variables parameters: - - *484 - *485 - - *646 - - *502 + - *486 + - *647 + - *503 - *19 responses: '200': @@ -91040,9 +94040,9 @@ paths: type: integer variables: type: array - items: *519 + items: *520 examples: - default: *520 + default: *521 headers: Link: *47 x-github: @@ -91065,9 +94065,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-an-environment-variable parameters: - - *484 - *485 - - *646 + - *486 + - *647 requestBody: required: true content: @@ -91119,18 +94119,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-an-environment-variable parameters: - - *484 - *485 - - *646 + - *486 + - *647 - *303 responses: '200': description: Response content: application/json: - schema: *519 + schema: *520 examples: - default: *658 + default: *659 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91151,10 +94151,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-an-environment-variable parameters: - - *484 - *485 + - *486 - *303 - - *646 + - *647 requestBody: required: true content: @@ -91196,10 +94196,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-an-environment-variable parameters: - - *484 - *485 + - *486 - *303 - - *646 + - *647 responses: '204': description: Response @@ -91221,8 +94221,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-repository-events parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -91290,8 +94290,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#list-forks parameters: - - *484 - *485 + - *486 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -91450,8 +94450,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#create-a-fork parameters: - - *484 - *485 + - *486 requestBody: required: false content: @@ -91483,9 +94483,9 @@ paths: description: Response content: application/json: - schema: *489 + schema: *490 examples: - default: *491 + default: *492 '400': *14 '422': *15 '403': *29 @@ -91506,8 +94506,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#create-a-blob parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -91567,7 +94567,7 @@ paths: schema: oneOf: - *265 - - *659 + - *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91592,8 +94592,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#get-a-blob parameters: - - *484 - *485 + - *486 - name: file_sha in: path required: true @@ -91692,8 +94692,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/commits#create-a-commit parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -91802,7 +94802,7 @@ paths: description: Response content: application/json: - schema: &660 + schema: &661 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -92016,15 +95016,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/commits#get-a-commit-object parameters: - - *484 - *485 - - *602 + - *486 + - *603 responses: '200': description: Response content: application/json: - schema: *660 + schema: *661 examples: default: value: @@ -92080,9 +95080,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#list-matching-references parameters: - - *484 - *485 - - &661 + - *486 + - &662 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. @@ -92099,7 +95099,7 @@ paths: application/json: schema: type: array - items: &662 + items: &663 title: Git Reference description: Git references within a repository type: object @@ -92174,17 +95174,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference parameters: - - *484 - *485 - - *661 + - *486 + - *662 responses: '200': description: Response content: application/json: - schema: *662 + schema: *663 examples: - default: &663 + default: &664 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -92213,8 +95213,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#create-a-reference parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -92243,9 +95243,9 @@ paths: description: Response content: application/json: - schema: *662 + schema: *663 examples: - default: *663 + default: *664 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -92271,9 +95271,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#update-a-reference parameters: - - *484 - *485 - - *661 + - *486 + - *662 requestBody: required: true content: @@ -92302,9 +95302,9 @@ paths: description: Response content: application/json: - schema: *662 + schema: *663 examples: - default: *663 + default: *664 '422': *15 '409': *121 x-github: @@ -92322,9 +95322,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#delete-a-reference parameters: - - *484 - *485 - - *661 + - *486 + - *662 responses: '204': description: Response @@ -92379,8 +95379,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/tags#create-a-tag-object parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -92447,7 +95447,7 @@ paths: description: Response content: application/json: - schema: &665 + schema: &666 title: Git Tag description: Metadata for a Git tag type: object @@ -92498,7 +95498,7 @@ paths: - sha - type - url - verification: *664 + verification: *665 required: - sha - url @@ -92508,7 +95508,7 @@ paths: - tag - message examples: - default: &666 + default: &667 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -92581,8 +95581,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/tags#get-a-tag parameters: - - *484 - *485 + - *486 - name: tag_sha in: path required: true @@ -92593,9 +95593,9 @@ paths: description: Response content: application/json: - schema: *665 + schema: *666 examples: - default: *666 + default: *667 '404': *6 '409': *121 x-github: @@ -92619,8 +95619,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/trees#create-a-tree parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -92693,7 +95693,7 @@ paths: description: Response content: application/json: - schema: &667 + schema: &668 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -92789,8 +95789,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/trees#get-a-tree parameters: - - *484 - *485 + - *486 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -92813,7 +95813,7 @@ paths: description: Response content: application/json: - schema: *667 + schema: *668 examples: default-response: summary: Default response @@ -92872,8 +95872,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-repository-webhooks parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -92883,7 +95883,7 @@ paths: application/json: schema: type: array - items: &668 + items: &669 title: Webhook description: Webhooks for repositories. type: object @@ -92937,7 +95937,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &930 + last_response: &931 title: Hook Response type: object properties: @@ -93011,8 +96011,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#create-a-repository-webhook parameters: - - *484 - *485 + - *486 requestBody: required: false content: @@ -93064,9 +96064,9 @@ paths: description: Response content: application/json: - schema: *668 + schema: *669 examples: - default: &669 + default: &670 value: type: Repository id: 12345678 @@ -93114,17 +96114,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-repository-webhook parameters: - - *484 - *485 + - *486 - *366 responses: '200': description: Response content: application/json: - schema: *668 + schema: *669 examples: - default: *669 + default: *670 '404': *6 x-github: githubCloudOnly: false @@ -93144,8 +96144,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#update-a-repository-webhook parameters: - - *484 - *485 + - *486 - *366 requestBody: required: true @@ -93191,9 +96191,9 @@ paths: description: Response content: application/json: - schema: *668 + schema: *669 examples: - default: *669 + default: *670 '422': *15 '404': *6 x-github: @@ -93214,8 +96214,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *484 - *485 + - *486 - *366 responses: '204': @@ -93240,8 +96240,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: - - *484 - *485 + - *486 - *366 responses: '200': @@ -93269,8 +96269,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: - - *484 - *485 + - *486 - *366 requestBody: required: false @@ -93315,8 +96315,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *484 - *485 + - *486 - *366 - *17 - *367 @@ -93349,8 +96349,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: - - *484 - *485 + - *486 - *366 - *16 responses: @@ -93379,8 +96379,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: - - *484 - *485 + - *486 - *366 - *16 responses: @@ -93404,8 +96404,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *484 - *485 + - *486 - *366 responses: '204': @@ -93431,8 +96431,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *484 - *485 + - *486 - *366 responses: '204': @@ -93456,8 +96456,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: - - *484 - *485 + - *486 responses: '200': description: Response if immutable releases are enabled @@ -93503,8 +96503,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-immutable-releases parameters: - - *484 - *485 + - *486 responses: '204': *130 '409': *121 @@ -93524,8 +96524,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-immutable-releases parameters: - - *484 - *485 + - *486 responses: '204': *130 '409': *121 @@ -93582,14 +96582,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-an-import-status parameters: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: &670 + schema: &671 title: Import description: A repository import from an external source. type: object @@ -93688,7 +96688,7 @@ paths: - html_url - authors_url examples: - default: &673 + default: &674 value: vcs: subversion use_lfs: true @@ -93704,7 +96704,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': &671 + '503': &672 description: Unavailable due to service under maintenance. content: application/json: @@ -93733,8 +96733,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#start-an-import parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -93782,7 +96782,7 @@ paths: description: Response content: application/json: - schema: *670 + schema: *671 examples: default: value: @@ -93807,7 +96807,7 @@ paths: type: string '422': *15 '404': *6 - '503': *671 + '503': *672 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93835,8 +96835,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import parameters: - - *484 - *485 + - *486 requestBody: required: false content: @@ -93885,7 +96885,7 @@ paths: description: Response content: application/json: - schema: *670 + schema: *671 examples: example-1: summary: Example 1 @@ -93933,7 +96933,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': *671 + '503': *672 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93956,12 +96956,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#cancel-an-import parameters: - - *484 - *485 + - *486 responses: '204': description: Response - '503': *671 + '503': *672 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93987,9 +96987,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-commit-authors parameters: - - *484 - *485 - - &855 + - *486 + - &856 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -94003,7 +97003,7 @@ paths: application/json: schema: type: array - items: &672 + items: &673 title: Porter Author description: Porter Author type: object @@ -94057,7 +97057,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': *671 + '503': *672 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94082,8 +97082,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#map-a-commit-author parameters: - - *484 - *485 + - *486 - name: author_id in: path required: true @@ -94113,7 +97113,7 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: default: value: @@ -94126,7 +97126,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *671 + '503': *672 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94150,8 +97150,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-large-files parameters: - - *484 - *485 + - *486 responses: '200': description: Response @@ -94192,7 +97192,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *671 + '503': *672 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94220,8 +97220,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -94248,11 +97248,11 @@ paths: description: Response content: application/json: - schema: *670 + schema: *671 examples: - default: *673 + default: *674 '422': *15 - '503': *671 + '503': *672 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94275,8 +97275,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -94285,7 +97285,7 @@ paths: schema: *22 examples: default: *384 - '301': *490 + '301': *491 '404': *6 x-github: githubCloudOnly: false @@ -94305,8 +97305,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *484 - *485 + - *486 responses: '200': description: Response @@ -94319,7 +97319,7 @@ paths: properties: {} additionalProperties: false examples: - default: &675 + default: &676 value: limit: collaborators_only origin: repository @@ -94344,13 +97344,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *484 - *485 + - *486 requestBody: required: true content: application/json: - schema: *674 + schema: *675 examples: default: summary: Example request body @@ -94364,7 +97364,7 @@ paths: application/json: schema: *386 examples: - default: *675 + default: *676 '409': description: Response x-github: @@ -94386,8 +97386,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *484 - *485 + - *486 responses: '204': description: Response @@ -94410,8 +97410,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#list-repository-invitations parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -94421,9 +97421,9 @@ paths: application/json: schema: type: array - items: *676 + items: *677 examples: - default: &848 + default: &849 value: - id: 1 repository: @@ -94554,8 +97554,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *484 - *485 + - *486 - *390 requestBody: required: false @@ -94585,7 +97585,7 @@ paths: description: Response content: application/json: - schema: *676 + schema: *677 examples: default: value: @@ -94716,8 +97716,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *484 - *485 + - *486 - *390 responses: '204': @@ -94749,8 +97749,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-repository-issues parameters: - - *484 - *485 + - *486 - 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 @@ -94823,7 +97823,7 @@ paths: type: array items: *229 examples: - default: &688 + default: &689 value: - id: 1 node_id: MDU6SXNzdWUx @@ -94972,7 +97972,7 @@ paths: state_reason: completed headers: Link: *47 - '301': *490 + '301': *491 '422': *15 '404': *6 x-github: @@ -95001,8 +98001,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#create-an-issue parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -95086,7 +98086,7 @@ paths: application/json: schema: *229 examples: - default: &685 + default: &686 value: id: 1 node_id: MDU6SXNzdWUx @@ -95243,7 +98243,7 @@ paths: '422': *15 '503': *200 '404': *6 - '410': *677 + '410': *678 x-github: triggersNotification: true githubCloudOnly: false @@ -95271,8 +98271,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *484 - *485 + - *486 - *253 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -95293,9 +98293,9 @@ paths: application/json: schema: type: array - items: *678 + items: *679 examples: - default: &687 + default: &688 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -95353,17 +98353,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment parameters: - - *484 - *485 + - *486 - *245 responses: '200': description: Response content: application/json: - schema: *678 + schema: *679 examples: - default: &679 + default: &680 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -95418,8 +98418,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#update-an-issue-comment parameters: - - *484 - *485 + - *486 - *245 requestBody: required: true @@ -95442,9 +98442,9 @@ paths: description: Response content: application/json: - schema: *678 + schema: *679 examples: - default: *679 + default: *680 '422': *15 x-github: githubCloudOnly: false @@ -95462,8 +98462,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#delete-an-issue-comment parameters: - - *484 - *485 + - *486 - *245 responses: '204': @@ -95492,15 +98492,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#pin-an-issue-comment parameters: - - *484 - *485 + - *486 - *245 responses: '200': description: Response content: application/json: - schema: *678 + schema: *679 examples: default: value: @@ -95556,7 +98556,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *677 + '410': *678 '422': *15 x-github: githubCloudOnly: false @@ -95573,8 +98573,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#unpin-an-issue-comment parameters: - - *484 - *485 + - *486 - *245 responses: '204': @@ -95582,7 +98582,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *677 + '410': *678 '503': *200 x-github: githubCloudOnly: false @@ -95600,8 +98600,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *484 - *485 + - *486 - *245 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). @@ -95628,9 +98628,9 @@ paths: application/json: schema: type: array - items: *599 + items: *600 examples: - default: *680 + default: *681 headers: Link: *47 '404': *6 @@ -95651,8 +98651,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *484 - *485 + - *486 - *245 requestBody: required: true @@ -95685,16 +98685,16 @@ paths: description: Reaction exists content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 '201': description: Reaction created content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 '422': *15 x-github: githubCloudOnly: false @@ -95716,10 +98716,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *484 - *485 + - *486 - *245 - - *681 + - *682 responses: '204': description: Response @@ -95739,8 +98739,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events-for-a-repository parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -95750,7 +98750,7 @@ paths: application/json: schema: type: array - items: &684 + items: &685 title: Issue Event description: Issue Event type: object @@ -95793,8 +98793,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *682 - required: *683 + properties: *683 + required: *684 nullable: true label: title: Issue Event Label @@ -96102,8 +99102,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#get-an-issue-event parameters: - - *484 - *485 + - *486 - name: event_id in: path required: true @@ -96114,7 +99114,7 @@ paths: description: Response content: application/json: - schema: *684 + schema: *685 examples: default: value: @@ -96307,7 +99307,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *677 + '410': *678 '403': *29 x-github: githubCloudOnly: false @@ -96341,9 +99341,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue parameters: - - *484 - *485 - - &686 + - *486 + - &687 name: issue_number description: The number that identifies the issue. in: path @@ -96359,7 +99359,7 @@ paths: examples: default: summary: Issue - value: *685 + value: *686 pinned_comment: summary: Issue with pinned comment value: @@ -96558,9 +99558,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *490 + '301': *491 '404': *6 - '410': *677 + '410': *678 '304': *37 x-github: githubCloudOnly: false @@ -96585,9 +99585,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#update-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: false content: @@ -96713,13 +99713,13 @@ paths: application/json: schema: *229 examples: - default: *685 + default: *686 '422': *15 '503': *200 '403': *29 - '301': *490 + '301': *491 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96737,9 +99737,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: false content: @@ -96767,7 +99767,7 @@ paths: application/json: schema: *229 examples: - default: *685 + default: *686 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96783,9 +99783,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: content: application/json: @@ -96812,7 +99812,7 @@ paths: application/json: schema: *229 examples: - default: *685 + default: *686 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96834,9 +99834,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: - - *484 - *485 - - *686 + - *486 + - *687 - name: assignee in: path required: true @@ -96876,9 +99876,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments parameters: - - *484 - *485 - - *686 + - *486 + - *687 - *236 - *17 - *19 @@ -96889,13 +99889,13 @@ paths: application/json: schema: type: array - items: *678 + items: *679 examples: - default: *687 + default: *688 headers: Link: *47 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96924,9 +99924,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#create-an-issue-comment parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: true content: @@ -96948,16 +99948,16 @@ paths: description: Response content: application/json: - schema: *678 + schema: *679 examples: - default: *679 + default: *680 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *677 + '410': *678 '422': *15 '404': *6 x-github: @@ -96985,9 +99985,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: - - *484 - *485 - - *686 + - *486 + - *687 - *17 - *19 responses: @@ -96999,12 +99999,12 @@ paths: type: array items: *229 examples: - default: *688 + default: *689 headers: Link: *47 - '301': *490 + '301': *491 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97032,9 +100032,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: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: true content: @@ -97058,15 +100058,15 @@ paths: application/json: schema: *229 examples: - default: *685 + default: *686 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *490 + '301': *491 '403': *29 - '410': *677 + '410': *678 '422': *15 '404': *6 x-github: @@ -97097,9 +100097,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: - - *484 - *485 - - *686 + - *486 + - *687 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -97113,13 +100113,13 @@ paths: application/json: schema: *229 examples: - default: *685 - '301': *490 + default: *686 + '301': *491 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *677 + '410': *678 x-github: triggersNotification: true githubCloudOnly: false @@ -97145,9 +100145,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: - - *484 - *485 - - *686 + - *486 + - *687 - *17 - *19 responses: @@ -97159,12 +100159,12 @@ paths: type: array items: *229 examples: - default: *688 + default: *689 headers: Link: *47 - '301': *490 + '301': *491 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97181,9 +100181,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events parameters: - - *484 - *485 - - *686 + - *486 + - *687 - *17 - *19 responses: @@ -97197,7 +100197,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &692 + - &693 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -97251,7 +100251,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &693 + - &694 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -97387,7 +100387,7 @@ paths: - performed_via_github_app - assignee - assigner - - &694 + - &695 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -97438,7 +100438,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &695 + - &696 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -97489,7 +100489,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &696 + - &697 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -97543,7 +100543,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &697 + - &698 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -97590,7 +100590,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &698 + - &699 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -97637,7 +100637,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &699 + - &700 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -97697,7 +100697,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &700 + - &701 title: Locked Issue Event description: Locked Issue Event type: object @@ -97745,7 +100745,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &701 + - &702 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -97811,7 +100811,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &702 + - &703 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -97877,7 +100877,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &703 + - &704 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -97943,7 +100943,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &704 + - &705 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -98034,7 +101034,7 @@ paths: color: red headers: Link: *47 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98051,9 +101051,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: - - *484 - *485 - - *686 + - *486 + - *687 - *17 - *19 responses: @@ -98063,9 +101063,9 @@ paths: application/json: schema: type: array - items: *689 + items: *690 examples: - default: &690 + default: &691 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -98089,9 +101089,9 @@ paths: value: '2025-12-25' headers: Link: *47 - '301': *490 + '301': *491 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98120,9 +101120,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: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: true content: @@ -98186,9 +101186,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *689 + items: *690 examples: - default: *690 + default: *691 '400': *14 '403': *29 '404': *6 @@ -98224,9 +101224,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: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: true content: @@ -98291,9 +101291,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *689 + items: *690 examples: - default: *690 + default: *691 '400': *14 '403': *29 '404': *6 @@ -98324,9 +101324,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: - - *484 - *485 - - *686 + - *486 + - *687 - *393 responses: '204': @@ -98352,9 +101352,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 - *17 - *19 responses: @@ -98366,7 +101366,7 @@ paths: type: array items: *228 examples: - default: &691 + default: &692 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -98384,9 +101384,9 @@ paths: default: false headers: Link: *47 - '301': *490 + '301': *491 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98402,9 +101402,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#add-labels-to-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: false content: @@ -98449,10 +101449,10 @@ paths: type: array items: *228 examples: - default: *691 - '301': *490 + default: *692 + '301': *491 '404': *6 - '410': *677 + '410': *678 '422': *15 x-github: githubCloudOnly: false @@ -98469,9 +101469,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#set-labels-for-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: false content: @@ -98533,10 +101533,10 @@ paths: type: array items: *228 examples: - default: *691 - '301': *490 + default: *692 + '301': *491 '404': *6 - '410': *677 + '410': *678 '422': *15 x-github: githubCloudOnly: false @@ -98553,15 +101553,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 responses: '204': description: Response - '301': *490 + '301': *491 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98580,9 +101580,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 - name: name in: path required: true @@ -98606,9 +101606,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *490 + '301': *491 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98628,9 +101628,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#lock-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: false content: @@ -98658,7 +101658,7 @@ paths: '204': description: Response '403': *29 - '410': *677 + '410': *678 '404': *6 '422': *15 x-github: @@ -98676,9 +101676,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#unlock-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 responses: '204': description: Response @@ -98708,9 +101708,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#get-parent-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 responses: '200': description: Response @@ -98718,10 +101718,10 @@ paths: application/json: schema: *229 examples: - default: *685 - '301': *490 + default: *686 + '301': *491 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98738,9 +101738,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 - 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. @@ -98766,13 +101766,13 @@ paths: application/json: schema: type: array - items: *599 + items: *600 examples: - default: *680 + default: *681 headers: Link: *47 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98790,9 +101790,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: true content: @@ -98824,16 +101824,16 @@ paths: description: Response content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 '201': description: Response content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 '422': *15 x-github: githubCloudOnly: false @@ -98855,10 +101855,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *484 - *485 - - *686 - - *681 + - *486 + - *687 + - *682 responses: '204': description: Response @@ -98887,9 +101887,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#remove-sub-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: true content: @@ -98913,7 +101913,7 @@ paths: application/json: schema: *229 examples: - default: *685 + default: *686 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -98946,9 +101946,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#list-sub-issues parameters: - - *484 - *485 - - *686 + - *486 + - *687 - *17 - *19 responses: @@ -98960,11 +101960,11 @@ paths: type: array items: *229 examples: - default: *688 + default: *689 headers: Link: *47 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98992,9 +101992,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#add-sub-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: true content: @@ -99023,14 +102023,14 @@ paths: application/json: schema: *229 examples: - default: *685 + default: *686 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *677 + '410': *678 '422': *15 '404': *6 x-github: @@ -99050,9 +102050,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: true content: @@ -99085,7 +102085,7 @@ paths: application/json: schema: *229 examples: - default: *685 + default: *686 '403': *29 '404': *6 '422': *7 @@ -99107,9 +102107,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 - *17 - *19 responses: @@ -99124,7 +102124,6 @@ paths: description: Timeline Event type: object anyOf: - - *692 - *693 - *694 - *695 @@ -99137,6 +102136,7 @@ paths: - *702 - *703 - *704 + - *705 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -99197,8 +102197,8 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *705 - required: *706 + properties: *706 + required: *707 nullable: true required: - event @@ -99453,7 +102453,7 @@ paths: type: string comments: type: array - items: &728 + items: &729 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -99668,7 +102668,7 @@ paths: type: string comments: type: array - items: *598 + items: *599 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -99957,7 +102957,7 @@ paths: headers: Link: *47 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99974,8 +102974,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -99985,7 +102985,7 @@ paths: application/json: schema: type: array - items: &707 + items: &708 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -100051,8 +103051,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -100088,9 +103088,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *708 examples: - default: &708 + default: &709 value: id: 1 key: ssh-rsa AAA... @@ -100124,9 +103124,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *484 - *485 - - &709 + - *486 + - &710 name: key_id description: The unique identifier of the key. in: path @@ -100138,9 +103138,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *708 examples: - default: *708 + default: *709 '404': *6 x-github: githubCloudOnly: false @@ -100158,9 +103158,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *484 - *485 - - *709 + - *486 + - *710 responses: '204': description: Response @@ -100180,8 +103180,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-a-repository parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -100193,7 +103193,7 @@ paths: type: array items: *228 examples: - default: *691 + default: *692 headers: Link: *47 '404': *6 @@ -100214,8 +103214,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#create-a-label parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -100253,7 +103253,7 @@ paths: application/json: schema: *228 examples: - default: &710 + default: &711 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -100285,8 +103285,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#get-a-label parameters: - - *484 - *485 + - *486 - name: name in: path required: true @@ -100299,7 +103299,7 @@ paths: application/json: schema: *228 examples: - default: *710 + default: *711 '404': *6 x-github: githubCloudOnly: false @@ -100316,8 +103316,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#update-a-label parameters: - - *484 - *485 + - *486 - name: name in: path required: true @@ -100382,8 +103382,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#delete-a-label parameters: - - *484 - *485 + - *486 - name: name in: path required: true @@ -100409,8 +103409,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-languages parameters: - - *484 - *485 + - *486 responses: '200': description: Response @@ -100446,8 +103446,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *484 - *485 + - *486 responses: '202': *39 '403': @@ -100475,8 +103475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *484 - *485 + - *486 responses: '204': description: Response @@ -100502,9 +103502,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *484 - *485 - - *571 + - *486 + - *572 responses: '200': description: Response @@ -100649,8 +103649,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -100715,8 +103715,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#merge-a-branch parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -100750,9 +103750,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *601 + schema: *602 examples: - default: *711 + default: *712 '204': description: Response when already merged '404': @@ -100777,8 +103777,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#list-milestones parameters: - - *484 - *485 + - *486 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -100819,7 +103819,7 @@ paths: application/json: schema: type: array - items: &712 + items: &713 title: Milestone description: A collection of related issues and pull requests. type: object @@ -100880,8 +103880,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#create-a-milestone parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -100921,9 +103921,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: &713 + default: &714 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -100982,9 +103982,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#get-a-milestone parameters: - - *484 - *485 - - &714 + - *486 + - &715 name: milestone_number description: The number that identifies the milestone. in: path @@ -100996,9 +103996,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: *713 + default: *714 '404': *6 x-github: githubCloudOnly: false @@ -101015,9 +104015,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#update-a-milestone parameters: - - *484 - *485 - - *714 + - *486 + - *715 requestBody: required: false content: @@ -101055,9 +104055,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: *713 + default: *714 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101073,9 +104073,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#delete-a-milestone parameters: - - *484 - *485 - - *714 + - *486 + - *715 responses: '204': description: Response @@ -101096,9 +104096,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: - - *484 - *485 - - *714 + - *486 + - *715 - *17 - *19 responses: @@ -101110,7 +104110,7 @@ paths: type: array items: *228 examples: - default: *691 + default: *692 headers: Link: *47 x-github: @@ -101129,12 +104129,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: - - *484 - *485 - - *715 + - *486 - *716 - - *236 - *717 + - *236 + - *718 - *17 - *19 responses: @@ -101146,7 +104146,7 @@ paths: type: array items: *256 examples: - default: *718 + default: *719 headers: Link: *47 x-github: @@ -101170,8 +104170,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *484 - *485 + - *486 requestBody: required: false content: @@ -101229,14 +104229,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-a-apiname-pages-site parameters: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: &719 + schema: &720 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -101361,7 +104361,7 @@ paths: - custom_404 - public examples: - default: &720 + default: &721 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -101402,8 +104402,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-apiname-pages-site parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -101457,9 +104457,9 @@ paths: description: Response content: application/json: - schema: *719 + schema: *720 examples: - default: *720 + default: *721 '422': *15 '409': *121 x-github: @@ -101482,8 +104482,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -101590,8 +104590,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *484 - *485 + - *486 responses: '204': description: Response @@ -101617,8 +104617,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#list-apiname-pages-builds parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -101628,7 +104628,7 @@ paths: application/json: schema: type: array - items: &721 + items: &722 title: Page Build description: Page Build type: object @@ -101722,8 +104722,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#request-a-apiname-pages-build parameters: - - *484 - *485 + - *486 responses: '201': description: Response @@ -101768,16 +104768,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-latest-pages-build parameters: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: *721 + schema: *722 examples: - default: &722 + default: &723 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -101825,8 +104825,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-apiname-pages-build parameters: - - *484 - *485 + - *486 - name: build_id in: path required: true @@ -101837,9 +104837,9 @@ paths: description: Response content: application/json: - schema: *721 + schema: *722 examples: - default: *722 + default: *723 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101859,8 +104859,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-github-pages-deployment parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -101965,9 +104965,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: - - *484 - *485 - - &723 + - *486 + - &724 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -102025,9 +105025,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *484 - *485 - - *723 + - *486 + - *724 responses: '204': *130 '404': *6 @@ -102054,8 +105054,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -102313,8 +105313,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: - - *484 - *485 + - *486 responses: '200': description: Private vulnerability reporting status @@ -102351,8 +105351,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: - - *484 - *485 + - *486 responses: '204': *130 '422': *14 @@ -102373,8 +105373,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: - - *484 - *485 + - *486 responses: '204': *130 '422': *14 @@ -102396,8 +105396,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -102407,7 +105407,7 @@ paths: type: array items: *160 examples: - default: *724 + default: *725 '403': *29 '404': *6 x-github: @@ -102429,8 +105429,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -102446,7 +105446,7 @@ paths: required: - properties examples: - default: *725 + default: *726 responses: '204': description: No Content when custom property values are successfully created @@ -102484,8 +105484,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests parameters: - - *484 - *485 + - *486 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -102545,9 +105545,9 @@ paths: application/json: schema: type: array - items: *605 + items: *606 examples: - default: *726 + default: *727 headers: Link: *47 '304': *37 @@ -102579,8 +105579,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#create-a-pull-request parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -102645,7 +105645,7 @@ paths: description: Response content: application/json: - schema: &730 + schema: &731 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -102800,7 +105800,7 @@ paths: items: *4 requested_teams: type: array - items: *468 + items: *469 head: type: object properties: @@ -102856,7 +105856,7 @@ paths: - review_comment - self author_association: *226 - auto_merge: *727 + auto_merge: *728 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -102948,7 +105948,7 @@ paths: - merged_by - review_comments examples: - default: &731 + default: &732 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -103475,8 +106475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *484 - *485 + - *486 - name: sort in: query required: false @@ -103505,9 +106505,9 @@ paths: application/json: schema: type: array - items: *728 + items: *729 examples: - default: &733 + default: &734 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -103584,17 +106584,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: - - *484 - *485 + - *486 - *245 responses: '200': description: Response content: application/json: - schema: *728 + schema: *729 examples: - default: &729 + default: &730 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -103669,8 +106669,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: - - *484 - *485 + - *486 - *245 requestBody: required: true @@ -103693,9 +106693,9 @@ paths: description: Response content: application/json: - schema: *728 + schema: *729 examples: - default: *729 + default: *730 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103711,8 +106711,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: - - *484 - *485 + - *486 - *245 responses: '204': @@ -103734,8 +106734,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: - - *484 - *485 + - *486 - *245 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). @@ -103762,9 +106762,9 @@ paths: application/json: schema: type: array - items: *599 + items: *600 examples: - default: *680 + default: *681 headers: Link: *47 '404': *6 @@ -103785,8 +106785,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: - - *484 - *485 + - *486 - *245 requestBody: required: true @@ -103819,16 +106819,16 @@ paths: description: Reaction exists content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 '201': description: Reaction created content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 '422': *15 x-github: githubCloudOnly: false @@ -103850,10 +106850,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *484 - *485 + - *486 - *245 - - *681 + - *682 responses: '204': description: Response @@ -103896,9 +106896,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request parameters: - - *484 - *485 - - &732 + - *486 + - &733 name: pull_number description: The number that identifies the pull request. in: path @@ -103911,9 +106911,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *730 + schema: *731 examples: - default: *731 + default: *732 '304': *37 '404': *6 '406': @@ -103948,9 +106948,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request parameters: - - *484 - *485 - - *732 + - *486 + - *733 requestBody: required: false content: @@ -103992,9 +106992,9 @@ paths: description: Response content: application/json: - schema: *730 + schema: *731 examples: - default: *731 + default: *732 '422': *15 '403': *29 x-github: @@ -104016,9 +107016,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#archive-a-pull-request parameters: - - *484 - *485 - - *732 + - *486 + - *733 responses: '204': description: Response @@ -104043,9 +107043,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#unarchive-a-pull-request parameters: - - *484 - *485 - - *732 + - *486 + - *733 responses: '204': description: Response @@ -104071,9 +107071,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: - - *484 - *485 - - *732 + - *486 + - *733 requestBody: required: true content: @@ -104135,7 +107135,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -104143,7 +107143,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '401': *25 '403': *29 '404': *6 @@ -104173,9 +107173,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: - - *484 - *485 - - *732 + - *486 + - *733 - *253 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -104196,9 +107196,9 @@ paths: application/json: schema: type: array - items: *728 + items: *729 examples: - default: *733 + default: *734 headers: Link: *47 x-github: @@ -104231,9 +107231,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: - - *484 - *485 - - *732 + - *486 + - *733 requestBody: required: true content: @@ -104338,7 +107338,7 @@ paths: description: Response content: application/json: - schema: *728 + schema: *729 examples: example-for-a-multi-line-comment: value: @@ -104426,9 +107426,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: - - *484 - *485 - - *732 + - *486 + - *733 - *245 requestBody: required: true @@ -104451,7 +107451,7 @@ paths: description: Response content: application/json: - schema: *728 + schema: *729 examples: default: value: @@ -104537,9 +107537,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *484 - *485 - - *732 + - *486 + - *733 - *17 - *19 responses: @@ -104549,9 +107549,9 @@ paths: application/json: schema: type: array - items: *601 + items: *602 examples: - default: *734 + default: *735 headers: Link: *47 x-github: @@ -104581,9 +107581,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests-files parameters: - - *484 - *485 - - *732 + - *486 + - *733 - *17 - *19 responses: @@ -104593,7 +107593,7 @@ paths: application/json: schema: type: array - items: *614 + items: *615 examples: default: value: @@ -104631,9 +107631,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: - - *484 - *485 - - *732 + - *486 + - *733 responses: '204': description: Response if pull request has been merged @@ -104656,9 +107656,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#merge-a-pull-request parameters: - - *484 - *485 - - *732 + - *486 + - *733 requestBody: required: false content: @@ -104769,9 +107769,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: - - *484 - *485 - - *732 + - *486 + - *733 responses: '200': description: Response @@ -104846,9 +107846,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: - - *484 - *485 - - *732 + - *486 + - *733 requestBody: required: false content: @@ -104885,7 +107885,7 @@ paths: description: Response content: application/json: - schema: *605 + schema: *606 examples: default: value: @@ -105421,9 +108421,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: - - *484 - *485 - - *732 + - *486 + - *733 requestBody: required: true content: @@ -105457,7 +108457,7 @@ paths: description: Response content: application/json: - schema: *605 + schema: *606 examples: default: value: @@ -105962,9 +108962,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *484 - *485 - - *732 + - *486 + - *733 - *17 - *19 responses: @@ -105974,7 +108974,7 @@ paths: application/json: schema: type: array - items: &735 + items: &736 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -106125,9 +109125,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: - - *484 - *485 - - *732 + - *486 + - *733 requestBody: required: false content: @@ -106213,9 +109213,9 @@ paths: description: Response content: application/json: - schema: *735 + schema: *736 examples: - default: &737 + default: &738 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -106278,10 +109278,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: - - *484 - *485 - - *732 - - &736 + - *486 + - *733 + - &737 name: review_id description: The unique identifier of the review. in: path @@ -106293,9 +109293,9 @@ paths: description: Response content: application/json: - schema: *735 + schema: *736 examples: - default: &738 + default: &739 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -106354,10 +109354,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: - - *484 - *485 - - *732 - - *736 + - *486 + - *733 + - *737 requestBody: required: true content: @@ -106380,7 +109380,7 @@ paths: description: Response content: application/json: - schema: *735 + schema: *736 examples: default: value: @@ -106442,18 +109442,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: - - *484 - *485 - - *732 - - *736 + - *486 + - *733 + - *737 responses: '200': description: Response content: application/json: - schema: *735 + schema: *736 examples: - default: *737 + default: *738 '422': *7 '404': *6 x-github: @@ -106480,10 +109480,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: - - *484 - *485 - - *732 - - *736 + - *486 + - *733 + - *737 - *17 - *19 responses: @@ -106718,10 +109718,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: - - *484 - *485 - - *732 - - *736 + - *486 + - *733 + - *737 requestBody: required: true content: @@ -106749,7 +109749,7 @@ paths: description: Response content: application/json: - schema: *735 + schema: *736 examples: default: value: @@ -106812,10 +109812,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: - - *484 - *485 - - *732 - - *736 + - *486 + - *733 + - *737 requestBody: required: true content: @@ -106850,9 +109850,9 @@ paths: description: Response content: application/json: - schema: *735 + schema: *736 examples: - default: *738 + default: *739 '404': *6 '422': *7 '403': *29 @@ -106874,9 +109874,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *484 - *485 - - *732 + - *486 + - *733 requestBody: required: false content: @@ -106939,8 +109939,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-a-repository-readme parameters: - - *484 - *485 + - *486 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -106953,9 +109953,9 @@ paths: description: Response content: application/json: - schema: *739 + schema: *740 examples: - default: &740 + default: &741 value: type: file encoding: base64 @@ -106997,8 +109997,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: - - *484 - *485 + - *486 - name: dir description: The alternate path to look for a README file in: path @@ -107018,9 +110018,9 @@ paths: description: Response content: application/json: - schema: *739 + schema: *740 examples: - default: *740 + default: *741 '404': *6 '422': *15 x-github: @@ -107042,8 +110042,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#list-releases parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -107053,7 +110053,7 @@ paths: application/json: schema: type: array - items: *741 + items: *742 examples: default: value: @@ -107147,8 +110147,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#create-a-release parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -107224,9 +110224,9 @@ paths: description: Response content: application/json: - schema: *741 + schema: *742 examples: - default: &745 + default: &746 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -107331,9 +110331,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#get-a-release-asset parameters: - - *484 - *485 - - &743 + - *486 + - &744 name: asset_id description: The unique identifier of the asset. in: path @@ -107345,9 +110345,9 @@ paths: description: Response content: application/json: - schema: *742 + schema: *743 examples: - default: &744 + default: &745 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 @@ -107382,7 +110382,7 @@ paths: type: User site_admin: false '404': *6 - '302': *618 + '302': *619 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107398,9 +110398,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#update-a-release-asset parameters: - - *484 - *485 - - *743 + - *486 + - *744 requestBody: required: false content: @@ -107428,9 +110428,9 @@ paths: description: Response content: application/json: - schema: *742 + schema: *743 examples: - default: *744 + default: *745 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107446,9 +110446,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#delete-a-release-asset parameters: - - *484 - *485 - - *743 + - *486 + - *744 responses: '204': description: Response @@ -107473,8 +110473,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -107559,16 +110559,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-the-latest-release parameters: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: *741 + schema: *742 examples: - default: *745 + default: *746 '404': *6 x-github: githubCloudOnly: false @@ -107586,8 +110586,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release-by-tag-name parameters: - - *484 - *485 + - *486 - name: tag description: tag parameter in: path @@ -107600,9 +110600,9 @@ paths: description: Response content: application/json: - schema: *741 + schema: *742 examples: - default: *745 + default: *746 '404': *6 x-github: githubCloudOnly: false @@ -107624,9 +110624,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release parameters: - - *484 - *485 - - &746 + - *486 + - &747 name: release_id description: The unique identifier of the release. in: path @@ -107640,9 +110640,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: *741 + schema: *742 examples: - default: *745 + default: *746 '401': description: Unauthorized x-github: @@ -107660,9 +110660,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#update-a-release parameters: - - *484 - *485 - - *746 + - *486 + - *747 requestBody: required: false content: @@ -107726,9 +110726,9 @@ paths: description: Response content: application/json: - schema: *741 + schema: *742 examples: - default: *745 + default: *746 '404': description: Not Found if the discussion category name is invalid content: @@ -107749,9 +110749,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#delete-a-release parameters: - - *484 - *485 - - *746 + - *486 + - *747 responses: '204': description: Response @@ -107772,9 +110772,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#list-release-assets parameters: - - *484 - *485 - - *746 + - *486 + - *747 - *17 - *19 responses: @@ -107784,7 +110784,7 @@ paths: application/json: schema: type: array - items: *742 + items: *743 examples: default: value: @@ -107866,9 +110866,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: - - *484 - *485 - - *746 + - *486 + - *747 - name: name in: query required: true @@ -107894,7 +110894,7 @@ paths: description: Response for successful upload content: application/json: - schema: *742 + schema: *743 examples: response-for-successful-upload: value: @@ -107949,9 +110949,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *484 - *485 - - *746 + - *486 + - *747 - 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. @@ -107975,9 +110975,9 @@ paths: application/json: schema: type: array - items: *599 + items: *600 examples: - default: *680 + default: *681 headers: Link: *47 '404': *6 @@ -107998,9 +110998,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *484 - *485 - - *746 + - *486 + - *747 requestBody: required: true content: @@ -108030,16 +111030,16 @@ paths: description: Reaction exists content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 '201': description: Reaction created content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 '422': *15 x-github: githubCloudOnly: false @@ -108061,10 +111061,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-release-reaction parameters: - - *484 - *485 - - *746 - - *681 + - *486 + - *747 + - *682 responses: '204': description: Response @@ -108088,9 +111088,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-rules-for-a-branch parameters: - - *484 - *485 - - *537 + - *486 + - *538 - *17 - *19 responses: @@ -108107,7 +111107,7 @@ paths: oneOf: - allOf: - *174 - - &747 + - &748 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -108128,67 +111128,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *175 - - *747 + - *748 - allOf: - *176 - - *747 + - *748 - allOf: - *177 - - *747 + - *748 - allOf: + - *749 - *748 - - *747 - allOf: - *178 - - *747 + - *748 - allOf: - *179 - - *747 + - *748 - allOf: - *180 - - *747 + - *748 - allOf: - *181 - - *747 + - *748 - allOf: - *182 - - *747 + - *748 - allOf: - *183 - - *747 + - *748 - allOf: - *184 - - *747 + - *748 - allOf: - *185 - - *747 + - *748 - allOf: - *186 - - *747 + - *748 - allOf: - *187 - - *747 + - *748 - allOf: - *188 - - *747 + - *748 - allOf: - *189 - - *747 + - *748 - allOf: - *190 - - *747 + - *748 - allOf: - *191 - - *747 + - *748 - allOf: - *192 - - *747 + - *748 - allOf: - *193 - - *747 + - *748 - allOf: - *194 - - *747 + - *748 examples: default: value: @@ -108227,8 +111227,8 @@ paths: category: repos subcategory: rules parameters: - - *484 - *485 + - *486 - *17 - *19 - name: includes_parents @@ -108239,7 +111239,7 @@ paths: schema: type: boolean default: true - - *749 + - *750 responses: '200': description: Response @@ -108294,8 +111294,8 @@ paths: category: repos subcategory: rules parameters: - - *484 - *485 + - *486 requestBody: description: Request body required: true @@ -108324,7 +111324,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *750 + items: *751 required: - name - enforcement @@ -108357,7 +111357,7 @@ paths: application/json: schema: *195 examples: - default: &759 + default: &760 value: id: 42 name: super cool ruleset @@ -108405,12 +111405,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *484 - *485 - - *751 - - *107 + - *486 - *752 + - *107 - *753 + - *754 - *17 - *19 responses: @@ -108418,9 +111418,9 @@ paths: description: Response content: application/json: - schema: *754 + schema: *755 examples: - default: *755 + default: *756 '404': *6 '500': *40 x-github: @@ -108441,17 +111441,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *484 - *485 - - *756 + - *486 + - *757 responses: '200': description: Response content: application/json: - schema: *757 + schema: *758 examples: - default: *758 + default: *759 '404': *6 '500': *40 x-github: @@ -108479,8 +111479,8 @@ paths: category: repos subcategory: rules parameters: - - *484 - *485 + - *486 - name: ruleset_id description: The ID of the ruleset. in: path @@ -108502,7 +111502,7 @@ paths: application/json: schema: *195 examples: - default: *759 + default: *760 '404': *6 '500': *40 put: @@ -108520,8 +111520,8 @@ paths: category: repos subcategory: rules parameters: - - *484 - *485 + - *486 - name: ruleset_id description: The ID of the ruleset. in: path @@ -108555,7 +111555,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *750 + items: *751 examples: default: value: @@ -108585,7 +111585,7 @@ paths: application/json: schema: *195 examples: - default: *759 + default: *760 '404': *6 '422': *15 '500': *40 @@ -108604,8 +111604,8 @@ paths: category: repos subcategory: rules parameters: - - *484 - *485 + - *486 - name: ruleset_id description: The ID of the ruleset. in: path @@ -108628,8 +111628,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-history parameters: - - *484 - *485 + - *486 - *17 - *19 - name: ruleset_id @@ -108666,8 +111666,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-version parameters: - - *484 - *485 + - *486 - name: ruleset_id description: The ID of the ruleset. in: path @@ -108740,8 +111740,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: - - *484 - *485 + - *486 - *451 - *452 - *453 @@ -108753,12 +111753,13 @@ paths: - *112 - *19 - *17 - - *760 - *761 + - *762 - *459 - *460 - *461 - *462 + - *463 responses: '200': description: Response @@ -108766,7 +111767,7 @@ paths: application/json: schema: type: array - items: &765 + items: &766 type: object properties: number: *131 @@ -108785,8 +111786,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *762 - resolution: *763 + state: *763 + resolution: *764 resolved_at: type: string format: date-time @@ -108892,7 +111893,7 @@ paths: pull request. ' - oneOf: *764 + oneOf: *765 nullable: true has_more_locations: type: boolean @@ -109056,16 +112057,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: - - *484 - *485 - - *565 + - *486 + - *566 - *462 responses: '200': description: Response content: application/json: - schema: *765 + schema: *766 examples: default: value: @@ -109119,9 +112120,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: - - *484 - *485 - - *565 + - *486 + - *566 requestBody: required: true content: @@ -109129,8 +112130,8 @@ paths: schema: type: object properties: - state: *762 - resolution: *763 + state: *763 + resolution: *764 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -109174,7 +112175,7 @@ paths: description: Response content: application/json: - schema: *765 + schema: *766 examples: default: value: @@ -109241,6 +112242,9 @@ paths: '400': description: Bad request, resolution comment is invalid or the resolution was not changed. + '403': + description: Delegated alert dismissal is enabled and the authenticated + user is not a valid reviewer. '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found @@ -109270,9 +112274,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: - - *484 - *485 - - *565 + - *486 + - *566 - *19 - *17 responses: @@ -109283,7 +112287,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &952 + items: &953 type: object properties: type: @@ -109309,7 +112313,6 @@ paths: example: commit details: oneOf: - - *766 - *767 - *768 - *769 @@ -109322,6 +112325,7 @@ paths: - *776 - *777 - *778 + - *779 examples: default: value: @@ -109407,8 +112411,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -109416,14 +112420,14 @@ paths: schema: type: object properties: - reason: &780 + reason: &781 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *779 + placeholder_id: *780 required: - reason - placeholder_id @@ -109440,7 +112444,7 @@ paths: schema: type: object properties: - reason: *780 + reason: *781 expire_at: type: string format: date-time @@ -109486,8 +112490,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: - - *484 - *485 + - *486 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -109502,7 +112506,7 @@ paths: properties: incremental_scans: type: array - items: &781 + items: &782 description: Information on a single scan performed by secret scanning on the repository type: object @@ -109528,15 +112532,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *781 + items: *782 backfill_scans: type: array - items: *781 + items: *782 custom_pattern_backfill_scans: type: array items: allOf: - - *781 + - *782 - type: object properties: pattern_name: @@ -109549,7 +112553,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *781 + items: *782 examples: default: value: @@ -109614,8 +112618,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *484 - *485 + - *486 - *112 - name: sort description: The property to sort the results by. @@ -109659,9 +112663,9 @@ paths: application/json: schema: type: array - items: *782 + items: *783 examples: - default: *783 + default: *784 '400': *14 '404': *6 x-github: @@ -109684,8 +112688,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -109758,7 +112762,7 @@ paths: login: type: string description: The username of the user credited. - type: *467 + type: *468 required: - login - type @@ -109845,9 +112849,9 @@ paths: description: Response content: application/json: - schema: *782 + schema: *783 examples: - default: &785 + default: &786 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -110080,8 +113084,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -110185,7 +113189,7 @@ paths: description: Response content: application/json: - schema: *782 + schema: *783 examples: default: value: @@ -110332,17 +113336,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: - - *484 - *485 - - *784 + - *486 + - *785 responses: '200': description: Response content: application/json: - schema: *782 + schema: *783 examples: - default: *785 + default: *786 '403': *29 '404': *6 x-github: @@ -110366,9 +113370,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: - - *484 - *485 - - *784 + - *486 + - *785 requestBody: required: true content: @@ -110441,7 +113445,7 @@ paths: login: type: string description: The username of the user credited. - type: *467 + type: *468 required: - login - type @@ -110527,10 +113531,10 @@ paths: description: Response content: application/json: - schema: *782 + schema: *783 examples: - default: *785 - add_credit: *785 + default: *786 + add_credit: *786 '403': *29 '404': *6 '422': @@ -110568,9 +113572,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: - - *484 - *485 - - *784 + - *486 + - *785 responses: '202': *39 '400': *14 @@ -110597,17 +113601,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: - - *484 - *485 - - *784 + - *486 + - *785 responses: '202': description: Response content: application/json: - schema: *489 + schema: *490 examples: - default: *491 + default: *492 '400': *14 '422': *15 '403': *29 @@ -110633,8 +113637,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-stargazers parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -110733,8 +113737,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *484 - *485 + - *486 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -110743,7 +113747,7 @@ paths: application/json: schema: type: array - items: &786 + items: &787 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -110776,8 +113780,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -110853,8 +113857,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *484 - *485 + - *486 responses: '200': description: Response @@ -110950,8 +113954,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *484 - *485 + - *486 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -111105,8 +114109,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: - - *484 - *485 + - *486 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -111116,7 +114120,7 @@ paths: application/json: schema: type: array - items: *786 + items: *787 examples: default: value: @@ -111149,8 +114153,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#create-a-commit-status parameters: - - *484 - *485 + - *486 - name: sha in: path required: true @@ -111204,7 +114208,7 @@ paths: description: Response content: application/json: - schema: *787 + schema: *788 examples: default: value: @@ -111258,8 +114262,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#list-watchers parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -111291,14 +114295,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#get-a-repository-subscription parameters: - - *484 - *485 + - *486 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &788 + schema: &789 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -111366,8 +114370,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#set-a-repository-subscription parameters: - - *484 - *485 + - *486 requestBody: required: false content: @@ -111393,7 +114397,7 @@ paths: description: Response content: application/json: - schema: *788 + schema: *789 examples: default: value: @@ -111420,8 +114424,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#delete-a-repository-subscription parameters: - - *484 - *485 + - *486 responses: '204': description: Response @@ -111441,8 +114445,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-tags parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -111521,8 +114525,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *484 - *485 + - *486 - name: ref in: path required: true @@ -111558,8 +114562,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-teams parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -111591,8 +114595,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-all-repository-topics parameters: - - *484 - *485 + - *486 - *19 - *17 responses: @@ -111600,7 +114604,7 @@ paths: description: Response content: application/json: - schema: &789 + schema: &790 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -111612,7 +114616,7 @@ paths: required: - names examples: - default: &790 + default: &791 value: names: - octocat @@ -111635,8 +114639,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#replace-all-repository-topics parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -111667,9 +114671,9 @@ paths: description: Response content: application/json: - schema: *789 + schema: *790 examples: - default: *790 + default: *791 '404': *6 '422': *7 x-github: @@ -111690,9 +114694,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-repository-clones parameters: - - *484 - *485 - - &791 + - *486 + - &792 name: per description: The time frame to display results for. in: query @@ -111721,7 +114725,7 @@ paths: example: 128 clones: type: array - items: &792 + items: &793 title: Traffic type: object properties: @@ -111808,8 +114812,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-paths parameters: - - *484 - *485 + - *486 responses: '200': description: Response @@ -111899,8 +114903,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-sources parameters: - - *484 - *485 + - *486 responses: '200': description: Response @@ -111960,9 +114964,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-page-views parameters: - - *484 - *485 - - *791 + - *486 + - *792 responses: '200': description: Response @@ -111981,7 +114985,7 @@ paths: example: 3782 views: type: array - items: *792 + items: *793 required: - uniques - count @@ -112058,8 +115062,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#transfer-a-repository parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -112333,8 +115337,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: - - *484 - *485 + - *486 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -112357,8 +115361,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-vulnerability-alerts parameters: - - *484 - *485 + - *486 responses: '204': description: Response @@ -112380,8 +115384,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-vulnerability-alerts parameters: - - *484 - *485 + - *486 responses: '204': description: Response @@ -112407,8 +115411,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *484 - *485 + - *486 - name: ref in: path required: true @@ -112500,9 +115504,9 @@ paths: description: Response content: application/json: - schema: *489 + schema: *490 examples: - default: *491 + default: *492 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -112653,7 +115657,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &800 + - &801 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -112662,7 +115666,7 @@ paths: schema: type: string example: members - - &805 + - &806 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -112673,7 +115677,7 @@ paths: default: 1 format: int32 example: 1 - - &806 + - &807 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -112715,7 +115719,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &795 + items: &796 allOf: - type: object required: @@ -112790,7 +115794,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: &807 + meta: &808 type: object description: The metadata associated with the creation/updates to the user. @@ -112850,30 +115854,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &796 + '400': &797 description: Bad request content: application/json: - schema: *793 + schema: *794 application/scim+json: - schema: *793 - '401': *794 - '403': &797 + schema: *794 + '401': *795 + '403': &798 description: Permission denied - '429': &798 + '429': &799 description: Too many requests content: application/json: - schema: *793 + schema: *794 application/scim+json: - schema: *793 - '500': &799 + schema: *794 + '500': &800 description: Internal server error content: application/json: - schema: *793 + schema: *794 application/scim+json: - schema: *793 + schema: *794 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -112897,7 +115901,7 @@ paths: required: true content: application/json: - schema: &803 + schema: &804 type: object required: - schemas @@ -112957,9 +115961,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *795 + schema: *796 examples: - group: &801 + group: &802 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -112978,13 +115982,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': *796 - '401': *794 - '403': *797 - '409': &804 + '400': *797 + '401': *795 + '403': *798 + '409': &805 description: Duplicate record detected - '429': *798 - '500': *799 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113001,7 +116005,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: - - &802 + - &803 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -113009,22 +116013,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *800 + - *801 - *41 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *795 + schema: *796 examples: - default: *801 - '400': *796 - '401': *794 - '403': *797 + default: *802 + '400': *797 + '401': *795 + '403': *798 '404': *6 - '429': *798 - '500': *799 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113043,13 +116047,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: - - *802 + - *803 - *41 requestBody: required: true content: application/json: - schema: *803 + schema: *804 examples: group: summary: Group @@ -113075,17 +116079,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *795 + schema: *796 examples: - group: *801 - groupWithMembers: *801 - '400': *796 - '401': *794 - '403': *797 + group: *802 + groupWithMembers: *802 + '400': *797 + '401': *795 + '403': *798 '404': *6 - '409': *804 - '429': *798 - '500': *799 + '409': *805 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113109,13 +116113,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: - - *802 + - *803 - *41 requestBody: required: true content: application/json: - schema: &814 + schema: &815 type: object required: - Operations @@ -113175,17 +116179,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *795 + schema: *796 examples: - updateGroup: *801 - addMembers: *801 - '400': *796 - '401': *794 - '403': *797 + updateGroup: *802 + addMembers: *802 + '400': *797 + '401': *795 + '403': *798 '404': *6 - '409': *804 - '429': *798 - '500': *799 + '409': *805 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113201,17 +116205,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: - - *802 + - *803 - *41 responses: '204': description: Group was deleted, no content - '400': *796 - '401': *794 - '403': *797 + '400': *797 + '401': *795 + '403': *798 '404': *6 - '429': *798 - '500': *799 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113245,8 +116249,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *805 - *806 + - *807 - *41 responses: '200': @@ -113279,7 +116283,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &809 + items: &810 allOf: - type: object required: @@ -113358,7 +116362,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &808 + roles: &809 type: array description: The roles assigned to the user. items: @@ -113414,7 +116418,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *807 + meta: *808 startIndex: type: integer description: A starting index for the returned page @@ -113451,11 +116455,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *796 - '401': *794 - '403': *797 - '429': *798 - '500': *799 + '400': *797 + '401': *795 + '403': *798 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113479,7 +116483,7 @@ paths: required: true content: application/json: - schema: &812 + schema: &813 type: object required: - schemas @@ -113561,9 +116565,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *808 + roles: *809 examples: - user: &813 + user: &814 summary: User value: schemas: @@ -113610,9 +116614,9 @@ paths: description: User has been created content: application/scim+json: - schema: *809 + schema: *810 examples: - user: &810 + user: &811 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -113638,13 +116642,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: *810 - '400': *796 - '401': *794 - '403': *797 - '409': *804 - '429': *798 - '500': *799 + enterpriseOwner: *811 + '400': *797 + '401': *795 + '403': *798 + '409': *805 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113661,7 +116665,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: - - &811 + - &812 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -113674,15 +116678,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *809 + schema: *810 examples: - default: *810 - '400': *796 - '401': *794 - '403': *797 + default: *811 + '400': *797 + '401': *795 + '403': *798 '404': *6 - '429': *798 - '500': *799 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113733,30 +116737,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: - - *811 + - *812 - *41 requestBody: required: true content: application/json: - schema: *812 + schema: *813 examples: - user: *813 + user: *814 responses: '200': description: User was updated content: application/scim+json: - schema: *809 + schema: *810 examples: - user: *810 - '400': *796 - '401': *794 - '403': *797 + user: *811 + '400': *797 + '401': *795 + '403': *798 '404': *6 - '409': *804 - '429': *798 - '500': *799 + '409': *805 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113797,13 +116801,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: - - *811 + - *812 - *41 requestBody: required: true content: application/json: - schema: *814 + schema: *815 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -113843,18 +116847,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *809 + schema: *810 examples: - userMultiValuedProperties: *810 - userSingleValuedProperties: *810 - disableUser: *810 - '400': *796 - '401': *794 - '403': *797 + userMultiValuedProperties: *811 + userSingleValuedProperties: *811 + disableUser: *811 + '400': *797 + '401': *795 + '403': *798 '404': *6 - '409': *804 - '429': *798 - '500': *799 + '409': *805 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113874,17 +116878,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: - - *811 + - *812 - *41 responses: '204': description: User was deleted, no content - '400': *796 - '401': *794 - '403': *797 + '400': *797 + '401': *795 + '403': *798 '404': *6 - '429': *798 - '500': *799 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113971,7 +116975,7 @@ paths: example: 1 Resources: type: array - items: &815 + items: &816 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -114202,22 +117206,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': *37 - '404': &816 + '404': &817 description: Resource not found content: application/json: - schema: *793 + schema: *794 application/scim+json: - schema: *793 - '403': &817 + schema: *794 + '403': &818 description: Forbidden content: application/json: - schema: *793 + schema: *794 application/scim+json: - schema: *793 - '400': *796 - '429': *798 + schema: *794 + '400': *797 + '429': *799 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -114243,9 +117247,9 @@ paths: description: Response content: application/scim+json: - schema: *815 + schema: *816 examples: - default: &818 + default: &819 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -114268,17 +117272,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': *37 - '404': *816 - '403': *817 - '500': *799 + '404': *817 + '403': *818 + '500': *800 '409': description: Conflict content: application/json: - schema: *793 + schema: *794 application/scim+json: - schema: *793 - '400': *796 + schema: *794 + '400': *797 requestBody: required: true content: @@ -114376,17 +117380,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *89 - - *811 + - *812 responses: '200': description: Response content: application/scim+json: - schema: *815 + schema: *816 examples: - default: *818 - '404': *816 - '403': *817 + default: *819 + '404': *817 + '403': *818 '304': *37 x-github: githubCloudOnly: true @@ -114410,18 +117414,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-a-provisioned-organization-membership parameters: - *89 - - *811 + - *812 responses: '200': description: Response content: application/scim+json: - schema: *815 + schema: *816 examples: - default: *818 + default: *819 '304': *37 - '404': *816 - '403': *817 + '404': *817 + '403': *818 requestBody: required: true content: @@ -114534,19 +117538,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *89 - - *811 + - *812 responses: '200': description: Response content: application/scim+json: - schema: *815 + schema: *816 examples: - default: *818 + default: *819 '304': *37 - '404': *816 - '403': *817 - '400': *796 + '404': *817 + '403': *818 + '400': *797 '429': description: Response content: @@ -114637,12 +117641,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *89 - - *811 + - *812 responses: '204': description: Response - '404': *816 - '403': *817 + '404': *817 + '403': *818 '304': *37 x-github: githubCloudOnly: true @@ -114778,7 +117782,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &819 + text_matches: &820 title: Search Result Text Matches type: array items: @@ -114941,7 +117945,7 @@ paths: enum: - author-date - committer-date - - &820 + - &821 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 @@ -115012,7 +118016,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *535 + properties: *536 nullable: true comment_count: type: integer @@ -115032,7 +118036,7 @@ paths: url: type: string format: uri - verification: *664 + verification: *665 required: - author - committer @@ -115051,7 +118055,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *535 + properties: *536 nullable: true parents: type: array @@ -115069,7 +118073,7 @@ paths: type: number node_id: type: string - text_matches: *819 + text_matches: *820 required: - sha - node_id @@ -115262,7 +118266,7 @@ paths: - interactions - created - updated - - *820 + - *821 - *17 - *19 - name: advanced_search @@ -115376,11 +118380,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: type: string state_reason: @@ -115412,7 +118416,7 @@ paths: type: string format: date-time nullable: true - text_matches: *819 + text_matches: *820 pull_request: type: object properties: @@ -115684,7 +118688,7 @@ paths: enum: - created - updated - - *820 + - *821 - *17 - *19 responses: @@ -115728,7 +118732,7 @@ paths: nullable: true score: type: number - text_matches: *819 + text_matches: *820 required: - id - node_id @@ -115814,7 +118818,7 @@ paths: - forks - help-wanted-issues - updated - - *820 + - *821 - *17 - *19 responses: @@ -116062,7 +119066,7 @@ paths: - admin - pull - push - text_matches: *819 + text_matches: *820 temp_clone_token: type: string allow_merge_commit: @@ -116363,7 +119367,7 @@ paths: type: string format: uri nullable: true - text_matches: *819 + text_matches: *820 related: type: array nullable: true @@ -116556,7 +119560,7 @@ paths: - followers - repositories - joined - - *820 + - *821 - *17 - *19 responses: @@ -116660,7 +119664,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *819 + text_matches: *820 blog: type: string nullable: true @@ -116739,7 +119743,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#get-a-team-legacy parameters: - - &823 + - &824 name: team_id description: The unique identifier of the team. in: path @@ -116751,9 +119755,9 @@ paths: description: Response content: application/json: - schema: *476 + schema: *477 examples: - default: *477 + default: *478 '404': *6 x-github: githubCloudOnly: false @@ -116780,7 +119784,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#update-a-team-legacy parameters: - - *823 + - *824 requestBody: required: true content: @@ -116843,16 +119847,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *476 + schema: *477 examples: - default: *477 + default: *478 '201': description: Response content: application/json: - schema: *476 + schema: *477 examples: - default: *477 + default: *478 '404': *6 '422': *15 '403': *29 @@ -116880,7 +119884,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#delete-a-team-legacy parameters: - - *823 + - *824 responses: '204': description: Response @@ -116909,7 +119913,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *823 + - *824 - *17 - *19 responses: @@ -116947,7 +119951,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-team-members-legacy parameters: - - *823 + - *824 - name: role description: Filters members returned by their role in the team. in: query @@ -116998,7 +120002,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-member-legacy parameters: - - *823 + - *824 - *148 responses: '204': @@ -117035,7 +120039,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-team-member-legacy parameters: - - *823 + - *824 - *148 responses: '204': @@ -117075,7 +120079,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-member-legacy parameters: - - *823 + - *824 - *148 responses: '204': @@ -117112,16 +120116,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: - - *823 + - *824 - *148 responses: '200': description: Response content: application/json: - schema: *483 + schema: *484 examples: - response-if-user-is-a-team-maintainer: *824 + response-if-user-is-a-team-maintainer: *825 '404': *6 x-github: githubCloudOnly: false @@ -117154,7 +120158,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: - - *823 + - *824 - *148 requestBody: required: false @@ -117180,9 +120184,9 @@ paths: description: Response content: application/json: - schema: *483 + schema: *484 examples: - response-if-users-membership-with-team-is-now-pending: *825 + response-if-users-membership-with-team-is-now-pending: *826 '403': description: Forbidden if team synchronization is set up '422': @@ -117216,7 +120220,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: - - *823 + - *824 - *148 responses: '204': @@ -117244,7 +120248,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-team-repositories-legacy parameters: - - *823 + - *824 - *17 - *19 responses: @@ -117286,15 +120290,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: - - *823 - - *484 + - *824 - *485 + - *486 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *826 + schema: *827 examples: alternative-response-with-extra-repository-information: value: @@ -117445,9 +120449,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: - - *823 - - *484 + - *824 - *485 + - *486 requestBody: required: false content: @@ -117497,9 +120501,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: - - *823 - - *484 + - *824 - *485 + - *486 responses: '204': description: Response @@ -117528,15 +120532,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: - - *823 + - *824 responses: '200': description: Response content: application/json: - schema: *486 + schema: *487 examples: - default: *487 + default: *488 '403': *29 '404': *6 x-github: @@ -117563,7 +120567,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: - - *823 + - *824 requestBody: required: true content: @@ -117620,7 +120624,7 @@ paths: description: Response content: application/json: - schema: *486 + schema: *487 examples: default: value: @@ -117651,7 +120655,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-child-teams-legacy parameters: - - *823 + - *824 - *17 - *19 responses: @@ -117663,7 +120667,7 @@ paths: type: array items: *319 examples: - response-if-child-teams-exist: *827 + response-if-child-teams-exist: *828 headers: Link: *47 '404': *6 @@ -117696,7 +120700,7 @@ paths: application/json: schema: oneOf: - - &829 + - &830 title: Private User description: Private User type: object @@ -117899,7 +120903,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *828 + - *829 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -118052,7 +121056,7 @@ paths: description: Response content: application/json: - schema: *829 + schema: *830 examples: default: value: @@ -118398,7 +121402,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -118406,7 +121410,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '401': *25 '403': *29 '404': *6 @@ -118450,7 +121454,7 @@ paths: type: integer secrets: type: array - items: &830 + items: &831 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -118490,7 +121494,7 @@ paths: - visibility - selected_repositories_url examples: - default: *591 + default: *592 headers: Link: *47 x-github: @@ -118566,7 +121570,7 @@ paths: description: Response content: application/json: - schema: *830 + schema: *831 examples: default: value: @@ -118864,7 +121868,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '304': *37 '500': *40 '401': *25 @@ -118922,7 +121926,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '401': *25 '403': *29 '404': *6 @@ -118979,7 +121983,7 @@ paths: description: Response content: application/json: - schema: &831 + schema: &832 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -119020,7 +122024,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &832 + default: &833 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -119065,9 +122069,9 @@ paths: description: Response content: application/json: - schema: *831 + schema: *832 examples: - default: *832 + default: *833 '404': *6 x-github: githubCloudOnly: false @@ -119104,9 +122108,9 @@ paths: type: integer machines: type: array - items: *833 + items: *834 examples: - default: *834 + default: *835 '304': *37 '500': *40 '401': *25 @@ -119185,13 +122189,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *489 + repository: *490 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *589 - required: *590 + properties: *590 + required: *591 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -119973,7 +122977,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '304': *37 '500': *40 '400': *14 @@ -120013,7 +123017,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '500': *40 '401': *25 '403': *29 @@ -120045,7 +123049,7 @@ paths: type: array items: *410 examples: - default: &845 + default: &846 value: - id: 197 name: hello_docker @@ -120146,7 +123150,7 @@ paths: application/json: schema: type: array - items: &835 + items: &836 title: Email description: Email type: object @@ -120211,9 +123215,9 @@ paths: application/json: schema: type: array - items: *835 + items: *836 examples: - default: &847 + default: &848 value: - email: octocat@github.com verified: true @@ -120288,7 +123292,7 @@ paths: application/json: schema: type: array - items: *835 + items: *836 examples: default: value: @@ -120544,7 +123548,7 @@ paths: application/json: schema: type: array - items: &836 + items: &837 title: GPG Key description: A unique encryption key type: object @@ -120675,7 +123679,7 @@ paths: - subkeys - revoked examples: - default: &864 + default: &865 value: - id: 3 name: Octocat's GPG Key @@ -120760,9 +123764,9 @@ paths: description: Response content: application/json: - schema: *836 + schema: *837 examples: - default: &837 + default: &838 value: id: 3 name: Octocat's GPG Key @@ -120819,7 +123823,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: - - &838 + - &839 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -120831,9 +123835,9 @@ paths: description: Response content: application/json: - schema: *836 + schema: *837 examples: - default: *837 + default: *838 '404': *6 '304': *37 '403': *29 @@ -120856,7 +123860,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: - - *838 + - *839 responses: '204': description: Response @@ -121164,7 +124168,7 @@ paths: required: true content: application/json: - schema: *674 + schema: *675 examples: default: value: @@ -121314,7 +124318,7 @@ paths: application/json: schema: type: array - items: &839 + items: &840 title: Key description: Key type: object @@ -121415,9 +124419,9 @@ paths: description: Response content: application/json: - schema: *839 + schema: *840 examples: - default: &840 + default: &841 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -121450,15 +124454,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: - - *709 + - *710 responses: '200': description: Response content: application/json: - schema: *839 + schema: *840 examples: - default: *840 + default: *841 '404': *6 '304': *37 '403': *29 @@ -121481,7 +124485,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: - - *709 + - *710 responses: '204': description: Response @@ -121514,7 +124518,7 @@ paths: application/json: schema: type: array - items: &841 + items: &842 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -121582,7 +124586,7 @@ paths: - account - plan examples: - default: &842 + default: &843 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -121644,9 +124648,9 @@ paths: application/json: schema: type: array - items: *841 + items: *842 examples: - default: *842 + default: *843 headers: Link: *47 '304': *37 @@ -122655,7 +125659,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#unlock-a-user-repository parameters: - *405 - - *843 + - *844 responses: '204': description: Response @@ -122770,7 +125774,7 @@ paths: - docker - nuget - container - - *844 + - *845 - *19 - *17 responses: @@ -122782,8 +125786,8 @@ paths: type: array items: *410 examples: - default: *845 - '400': *846 + default: *846 + '400': *847 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122812,7 +125816,7 @@ paths: application/json: schema: *410 examples: - default: &865 + default: &866 value: id: 40201 name: octo-name @@ -123174,9 +126178,9 @@ paths: application/json: schema: type: array - items: *835 + items: *836 examples: - default: *847 + default: *848 headers: Link: *47 '304': *37 @@ -123289,7 +126293,7 @@ paths: type: array items: *80 examples: - default: &854 + default: &855 summary: Default response value: - id: 1296269 @@ -123593,9 +126597,9 @@ paths: description: Response content: application/json: - schema: *489 + schema: *490 examples: - default: *491 + default: *492 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -123633,9 +126637,9 @@ paths: application/json: schema: type: array - items: *676 + items: *677 examples: - default: *848 + default: *849 headers: Link: *47 '304': *37 @@ -123714,7 +126718,7 @@ paths: application/json: schema: type: array - items: &849 + items: &850 title: Social account description: Social media account type: object @@ -123729,7 +126733,7 @@ paths: - provider - url examples: - default: &850 + default: &851 value: - provider: twitter url: https://twitter.com/github @@ -123791,9 +126795,9 @@ paths: application/json: schema: type: array - items: *849 + items: *850 examples: - default: *850 + default: *851 '422': *15 '304': *37 '404': *6 @@ -123880,7 +126884,7 @@ paths: application/json: schema: type: array - items: &851 + items: &852 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -123900,7 +126904,7 @@ paths: - title - created_at examples: - default: &879 + default: &880 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -123964,9 +126968,9 @@ paths: description: Response content: application/json: - schema: *851 + schema: *852 examples: - default: &852 + default: &853 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -123996,7 +127000,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: - - &853 + - &854 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -124008,9 +127012,9 @@ paths: description: Response content: application/json: - schema: *851 + schema: *852 examples: - default: *852 + default: *853 '404': *6 '304': *37 '403': *29 @@ -124033,7 +127037,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: - - *853 + - *854 responses: '204': description: Response @@ -124062,7 +127066,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: - - &880 + - &881 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 @@ -124087,11 +127091,11 @@ paths: type: array items: *80 examples: - default-response: *854 + default-response: *855 application/vnd.github.v3.star+json: schema: type: array - items: &881 + items: &882 title: Starred Repository description: Starred Repository type: object @@ -124247,8 +127251,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: - - *484 - *485 + - *486 responses: '204': description: Response if this repository is starred by you @@ -124276,8 +127280,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: - - *484 - *485 + - *486 responses: '204': description: Response @@ -124301,8 +127305,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: - - *484 - *485 + - *486 responses: '204': description: Response @@ -124374,7 +127378,7 @@ paths: application/json: schema: type: array - items: *476 + items: *477 examples: default: value: @@ -124460,10 +127464,10 @@ paths: application/json: schema: oneOf: + - *830 - *829 - - *828 examples: - default-response: &858 + default-response: &859 summary: Default response value: login: octocat @@ -124498,7 +127502,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &859 + response-with-git-hub-plan-information: &860 summary: Response with GitHub plan information value: login: octocat @@ -124555,7 +127559,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: - - &856 + - &857 name: user_id description: The unique identifier of the user. in: path @@ -124621,7 +127625,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/users#list-users parameters: - - *855 + - *856 - *17 responses: '200': @@ -124656,7 +127660,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: - - *856 + - *857 - *428 requestBody: required: true @@ -124728,7 +127732,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *857 + schema: *858 examples: table_view: summary: Response for creating a table view @@ -124780,11 +127784,11 @@ paths: application/json: schema: oneOf: + - *830 - *829 - - *828 examples: - default-response: *858 - response-with-git-hub-plan-information: *859 + default-response: *859 + response-with-git-hub-plan-information: *860 '404': *6 x-github: githubCloudOnly: false @@ -124834,8 +127838,8 @@ paths: required: - subject_digests examples: - default: *860 - withPredicateType: *861 + default: *861 + withPredicateType: *862 responses: '200': description: Response @@ -124888,7 +127892,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *862 + default: *863 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -125093,7 +128097,7 @@ paths: initiator: type: string examples: - default: *531 + default: *532 '201': description: Response content: @@ -125374,7 +128378,7 @@ paths: application/json: schema: *334 examples: - default: &863 + default: &864 summary: Example response for a user copilot space value: id: 42 @@ -125475,7 +128479,7 @@ paths: application/json: schema: *334 examples: - default: *863 + default: *864 '403': *29 '404': *6 x-github: @@ -125598,7 +128602,7 @@ paths: application/json: schema: *334 examples: - default: *863 + default: *864 '403': *29 '404': *6 '422': *15 @@ -126366,7 +129370,7 @@ paths: type: array items: *410 examples: - default: *845 + default: *846 '403': *29 '401': *25 x-github: @@ -126750,9 +129754,9 @@ paths: application/json: schema: type: array - items: *836 + items: *837 examples: - default: *864 + default: *865 headers: Link: *47 x-github: @@ -126980,7 +129984,7 @@ paths: - docker - nuget - container - - *844 + - *845 - *148 - *19 - *17 @@ -126993,10 +129997,10 @@ paths: type: array items: *410 examples: - default: *845 + default: *846 '403': *29 '401': *25 - '400': *846 + '400': *847 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -127026,7 +130030,7 @@ paths: application/json: schema: *410 examples: - default: *865 + default: *866 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -127375,7 +130379,7 @@ paths: type: array items: *432 examples: - default: *866 + default: *867 headers: Link: *47 '304': *37 @@ -127435,7 +130439,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *867 + items: *868 required: - name - data_type @@ -127451,7 +130455,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *868 + iteration_configuration: *869 required: - name - data_type @@ -127473,8 +130477,8 @@ paths: value: name: Due date data_type: date - single_select_field: *869 - iteration_field: *870 + single_select_field: *870 + iteration_field: *871 responses: '201': description: Response @@ -127482,11 +130486,11 @@ paths: application/json: schema: *432 examples: - text_field: *871 - number_field: *872 - date_field: *873 - single_select_field: *874 - iteration_field: *875 + text_field: *872 + number_field: *873 + date_field: *874 + single_select_field: *875 + iteration_field: *876 '304': *37 '403': *29 '401': *25 @@ -127508,7 +130512,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-user parameters: - *428 - - *876 + - *877 - *148 responses: '200': @@ -127517,7 +130521,7 @@ paths: application/json: schema: *432 examples: - default: *877 + default: *878 headers: Link: *47 '304': *37 @@ -127871,7 +130875,7 @@ paths: parameters: - *428 - *148 - - *878 + - *879 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -128150,9 +131154,9 @@ paths: application/json: schema: type: array - items: *849 + items: *850 examples: - default: *850 + default: *851 headers: Link: *47 x-github: @@ -128182,9 +131186,9 @@ paths: application/json: schema: type: array - items: *851 + items: *852 examples: - default: *879 + default: *880 headers: Link: *47 x-github: @@ -128209,7 +131213,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *148 - - *880 + - *881 - *112 - *17 - *19 @@ -128221,11 +131225,11 @@ paths: schema: anyOf: - type: array - items: *881 + items: *882 - type: array items: *80 examples: - default-response: *854 + default-response: *855 headers: Link: *47 x-github: @@ -128384,7 +131388,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &882 + enterprise: &883 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -128442,7 +131446,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &883 + installation: &884 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -128461,7 +131465,7 @@ x-webhooks: required: - id - node_id - organization: &884 + organization: &885 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -128521,13 +131525,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &885 + repository: &886 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &924 + properties: &925 id: description: Unique identifier of the repository example: 42 @@ -129222,7 +132226,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &925 + required: &926 - archive_url - assignees_url - blobs_url @@ -129373,10 +132377,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -129452,11 +132456,11 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - rule: &886 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + rule: &887 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) @@ -129679,11 +132683,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - rule: *886 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + rule: *887 sender: *4 required: - action @@ -129866,11 +132870,11 @@ x-webhooks: - everyone required: - from - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - rule: *886 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + rule: *887 sender: *4 required: - action @@ -129943,7 +132947,7 @@ x-webhooks: required: true content: application/json: - schema: &908 + schema: &909 title: Exemption request cancellation event type: object properties: @@ -129951,11 +132955,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - exemption_request: &887 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + exemption_request: &888 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -130259,7 +133263,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &888 + items: &889 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -130369,7 +133373,7 @@ x-webhooks: required: true content: application/json: - schema: &909 + schema: &910 title: Exemption request completed event type: object properties: @@ -130377,11 +133381,11 @@ x-webhooks: type: string enum: - completed - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - exemption_request: *887 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + exemption_request: *888 sender: *4 required: - action @@ -130453,7 +133457,7 @@ x-webhooks: required: true content: application/json: - schema: &906 + schema: &907 title: Exemption request created event type: object properties: @@ -130461,11 +133465,11 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - exemption_request: *887 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + exemption_request: *888 sender: *4 required: - action @@ -130537,7 +133541,7 @@ x-webhooks: required: true content: application/json: - schema: &910 + schema: &911 title: Exemption response dismissed event type: object properties: @@ -130545,12 +133549,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - exemption_request: *887 - exemption_response: *888 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + exemption_request: *888 + exemption_response: *889 sender: *4 required: - action @@ -130624,7 +133628,7 @@ x-webhooks: required: true content: application/json: - schema: &907 + schema: &908 title: Exemption response submitted event type: object properties: @@ -130632,12 +133636,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - exemption_request: *887 - exemption_response: *888 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + exemption_request: *888 + exemption_response: *889 sender: *4 required: - action @@ -130721,7 +133725,7 @@ x-webhooks: type: string enum: - completed - check_run: &890 + check_run: &891 title: CheckRun description: A check performed on the code of a given code change type: object @@ -130812,7 +133816,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *889 + deployment: *890 details_url: example: https://example.com type: string @@ -130897,10 +133901,10 @@ x-webhooks: - output - app - pull_requests - installation: *883 - enterprise: *882 - organization: *884 - repository: *885 + installation: *884 + enterprise: *883 + organization: *885 + repository: *886 sender: *4 required: - check_run @@ -131291,11 +134295,11 @@ x-webhooks: type: string enum: - created - check_run: *890 - installation: *883 - enterprise: *882 - organization: *884 - repository: *885 + check_run: *891 + installation: *884 + enterprise: *883 + organization: *885 + repository: *886 sender: *4 required: - check_run @@ -131689,11 +134693,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *890 - installation: *883 - enterprise: *882 - organization: *884 - repository: *885 + check_run: *891 + installation: *884 + enterprise: *883 + organization: *885 + repository: *886 requested_action: description: The action requested by the user. type: object @@ -132096,11 +135100,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *890 - installation: *883 - enterprise: *882 - organization: *884 - repository: *885 + check_run: *891 + installation: *884 + enterprise: *883 + organization: *885 + repository: *886 sender: *4 required: - check_run @@ -133070,10 +136074,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -133762,10 +136766,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -134448,10 +137452,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -134617,7 +137621,7 @@ x-webhooks: required: - login - id - dismissed_comment: *560 + dismissed_comment: *561 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -134762,20 +137766,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &891 + commit_oid: &892 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: *882 - installation: *883 - organization: *884 - ref: &892 + enterprise: *883 + installation: *884 + organization: *885 + ref: &893 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: *885 + repository: *886 sender: *4 required: - action @@ -134940,7 +137944,7 @@ x-webhooks: required: - login - id - dismissed_comment: *560 + dismissed_comment: *561 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -135170,12 +138174,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *891 - enterprise: *882 - installation: *883 - organization: *884 - ref: *892 - repository: *885 + commit_oid: *892 + enterprise: *883 + installation: *884 + organization: *885 + ref: *893 + repository: *886 sender: *4 required: - action @@ -135270,7 +138274,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *560 + dismissed_comment: *561 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -135441,12 +138445,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *891 - enterprise: *882 - installation: *883 - organization: *884 - ref: *892 - repository: *885 + commit_oid: *892 + enterprise: *883 + installation: *884 + organization: *885 + ref: *893 + repository: *886 sender: *4 required: - action @@ -135612,7 +138616,7 @@ x-webhooks: required: - login - id - dismissed_comment: *560 + dismissed_comment: *561 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -135778,12 +138782,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *891 - enterprise: *882 - installation: *883 - organization: *884 - ref: *892 - repository: *885 + commit_oid: *892 + enterprise: *883 + installation: *884 + organization: *885 + ref: *893 + repository: *886 sender: *4 required: - action @@ -135882,7 +138886,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *560 + dismissed_comment: *561 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -136057,16 +139061,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 ref: 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 nullable: true - repository: *885 + repository: *886 sender: *4 required: - action @@ -136163,7 +139167,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *560 + dismissed_comment: *561 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -136303,12 +139307,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *891 - enterprise: *882 - installation: *883 - organization: *884 - ref: *892 - repository: *885 + commit_oid: *892 + enterprise: *883 + installation: *884 + organization: *885 + ref: *893 + repository: *886 sender: *4 required: - action @@ -136474,7 +139478,7 @@ x-webhooks: required: - login - id - dismissed_comment: *560 + dismissed_comment: *561 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -136619,10 +139623,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -136877,10 +139881,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -136960,18 +139964,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *884 - pusher_type: &893 + organization: *885 + pusher_type: &894 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &894 + ref: &895 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference) resource. type: string @@ -136981,7 +139985,7 @@ x-webhooks: enum: - tag - branch - repository: *885 + repository: *886 sender: *4 required: - ref @@ -137064,9 +140068,9 @@ x-webhooks: enum: - created definition: *161 - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 sender: *4 required: - action @@ -137151,9 +140155,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 sender: *4 required: - action @@ -137231,9 +140235,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *161 - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 sender: *4 required: - action @@ -137311,9 +140315,9 @@ x-webhooks: enum: - updated definition: *161 - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 sender: *4 required: - action @@ -137390,10 +140394,10 @@ x-webhooks: type: string enum: - updated - enterprise: *882 - installation: *883 - repository: *885 - organization: *884 + enterprise: *883 + installation: *884 + repository: *886 + organization: *885 sender: *4 new_property_values: type: array @@ -137478,18 +140482,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *882 - installation: *883 - organization: *884 - pusher_type: *893 - ref: *894 + enterprise: *883 + installation: *884 + organization: *885 + pusher_type: *894 + ref: *895 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *885 + repository: *886 sender: *4 required: - ref @@ -137569,11 +140573,11 @@ x-webhooks: type: string enum: - assignees_changed - alert: *624 - installation: *883 - organization: *884 - enterprise: *882 - repository: *885 + alert: *625 + installation: *884 + organization: *885 + enterprise: *883 + repository: *886 sender: *4 required: - action @@ -137653,11 +140657,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *624 - installation: *883 - organization: *884 - enterprise: *882 - repository: *885 + alert: *625 + installation: *884 + organization: *885 + enterprise: *883 + repository: *886 sender: *4 required: - action @@ -137738,11 +140742,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *624 - installation: *883 - organization: *884 - enterprise: *882 - repository: *885 + alert: *625 + installation: *884 + organization: *885 + enterprise: *883 + repository: *886 sender: *4 required: - action @@ -137823,11 +140827,11 @@ x-webhooks: type: string enum: - created - alert: *624 - installation: *883 - organization: *884 - enterprise: *882 - repository: *885 + alert: *625 + installation: *884 + organization: *885 + enterprise: *883 + repository: *886 sender: *4 required: - action @@ -137906,11 +140910,11 @@ x-webhooks: type: string enum: - dismissed - alert: *624 - installation: *883 - organization: *884 - enterprise: *882 - repository: *885 + alert: *625 + installation: *884 + organization: *885 + enterprise: *883 + repository: *886 sender: *4 required: - action @@ -137989,11 +140993,11 @@ x-webhooks: type: string enum: - fixed - alert: *624 - installation: *883 - organization: *884 - enterprise: *882 - repository: *885 + alert: *625 + installation: *884 + organization: *885 + enterprise: *883 + repository: *886 sender: *4 required: - action @@ -138073,11 +141077,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *624 - installation: *883 - organization: *884 - enterprise: *882 - repository: *885 + alert: *625 + installation: *884 + organization: *885 + enterprise: *883 + repository: *886 sender: *4 required: - action @@ -138156,11 +141160,11 @@ x-webhooks: type: string enum: - reopened - alert: *624 - installation: *883 - organization: *884 - enterprise: *882 - repository: *885 + alert: *625 + installation: *884 + organization: *885 + enterprise: *883 + repository: *886 sender: *4 required: - action @@ -138237,9 +141241,9 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - key: &895 + enterprise: *883 + installation: *884 + key: &896 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -138275,8 +141279,8 @@ x-webhooks: - verified - created_at - read_only - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -138353,11 +141357,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - key: *895 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + key: *896 + organization: *885 + repository: *886 sender: *4 required: - action @@ -138913,12 +141917,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - workflow: &901 + workflow: &902 title: Workflow type: object nullable: true @@ -139659,15 +142663,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *896 - required: *897 + properties: *897 + required: *898 nullable: true pull_requests: type: array - items: *730 - repository: *885 - organization: *884 - installation: *883 + items: *731 + repository: *886 + organization: *885 + installation: *884 sender: *4 responses: '200': @@ -139738,7 +142742,7 @@ x-webhooks: type: string enum: - approved - approver: &898 + approver: &899 type: object properties: avatar_url: @@ -139781,11 +142785,11 @@ x-webhooks: type: string comment: type: string - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - reviewers: &899 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + reviewers: &900 type: array items: type: object @@ -139864,7 +142868,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &900 + workflow_job_run: &901 type: object properties: conclusion: @@ -140595,18 +143599,18 @@ x-webhooks: type: string enum: - rejected - approver: *898 + approver: *899 comment: type: string - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - reviewers: *899 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + reviewers: *900 sender: *4 since: type: string - workflow_job_run: *900 + workflow_job_run: *901 workflow_job_runs: type: array items: @@ -141310,13 +144314,13 @@ x-webhooks: type: string enum: - requested - enterprise: *882 + enterprise: *883 environment: type: string - installation: *883 - organization: *884 - repository: *885 - requestor: &911 + installation: *884 + organization: *885 + repository: *886 + requestor: &912 title: User type: object nullable: true @@ -143205,12 +146209,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - workflow: *901 + workflow: *902 workflow_run: title: Deployment Workflow Run type: object @@ -143890,7 +146894,7 @@ x-webhooks: type: string enum: - answered - answer: &904 + answer: &905 type: object properties: author_association: @@ -144047,11 +147051,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -144178,11 +147182,11 @@ x-webhooks: - from required: - category - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -144265,11 +147269,11 @@ x-webhooks: type: string enum: - closed - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -144351,7 +147355,7 @@ x-webhooks: type: string enum: - created - comment: &903 + comment: &904 type: object properties: author_association: @@ -144508,11 +147512,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -144595,12 +147599,12 @@ x-webhooks: type: string enum: - deleted - comment: *903 - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + comment: *904 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -144695,12 +147699,12 @@ x-webhooks: - from required: - body - comment: *903 - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + comment: *904 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -144784,11 +147788,11 @@ x-webhooks: type: string enum: - created - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -144870,11 +147874,11 @@ x-webhooks: type: string enum: - deleted - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -144974,11 +147978,11 @@ x-webhooks: type: string required: - from - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -145060,10 +148064,10 @@ x-webhooks: type: string enum: - labeled - discussion: *902 - enterprise: *882 - installation: *883 - label: &905 + discussion: *903 + enterprise: *883 + installation: *884 + label: &906 title: Label type: object properties: @@ -145095,8 +148099,8 @@ x-webhooks: - color - default - description - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -145179,11 +148183,11 @@ x-webhooks: type: string enum: - locked - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -145265,11 +148269,11 @@ x-webhooks: type: string enum: - pinned - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -145351,11 +148355,11 @@ x-webhooks: type: string enum: - reopened - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -145440,16 +148444,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *902 - new_repository: *885 + new_discussion: *903 + new_repository: *886 required: - new_discussion - new_repository - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -145532,10 +148536,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *902 - old_answer: *904 - organization: *884 - repository: *885 + discussion: *903 + old_answer: *905 + organization: *885 + repository: *886 sender: *4 required: - action @@ -145617,12 +148621,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *902 - enterprise: *882 - installation: *883 - label: *905 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + label: *906 + organization: *885 + repository: *886 sender: *4 required: - action @@ -145705,11 +148709,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -145791,11 +148795,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -145864,7 +148868,7 @@ x-webhooks: required: true content: application/json: - schema: *906 + schema: *907 responses: '200': description: Return a 200 status to indicate that the data was received @@ -145927,7 +148931,7 @@ x-webhooks: required: true content: application/json: - schema: *907 + schema: *908 responses: '200': description: Return a 200 status to indicate that the data was received @@ -145990,7 +148994,7 @@ x-webhooks: required: true content: application/json: - schema: *908 + schema: *909 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146053,7 +149057,7 @@ x-webhooks: required: true content: application/json: - schema: *906 + schema: *907 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146116,7 +149120,7 @@ x-webhooks: required: true content: application/json: - schema: *907 + schema: *908 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146182,7 +149186,7 @@ x-webhooks: required: true content: application/json: - schema: *908 + schema: *909 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146248,7 +149252,7 @@ x-webhooks: required: true content: application/json: - schema: *909 + schema: *910 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146314,7 +149318,7 @@ x-webhooks: required: true content: application/json: - schema: *906 + schema: *907 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146380,7 +149384,7 @@ x-webhooks: required: true content: application/json: - schema: *910 + schema: *911 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146446,7 +149450,7 @@ x-webhooks: required: true content: application/json: - schema: *907 + schema: *908 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146511,7 +149515,7 @@ x-webhooks: required: true content: application/json: - schema: *908 + schema: *909 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146576,7 +149580,7 @@ x-webhooks: required: true content: application/json: - schema: *909 + schema: *910 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146641,7 +149645,7 @@ x-webhooks: required: true content: application/json: - schema: *906 + schema: *907 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146706,7 +149710,7 @@ x-webhooks: required: true content: application/json: - schema: *910 + schema: *911 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146772,7 +149776,7 @@ x-webhooks: required: true content: application/json: - schema: *907 + schema: *908 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146839,7 +149843,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *882 + enterprise: *883 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) resource. @@ -147499,9 +150503,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - forkee @@ -147647,9 +150651,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 pages: description: The pages that were updated. type: array @@ -147686,7 +150690,7 @@ x-webhooks: - action - sha - html_url - repository: *885 + repository: *886 sender: *4 required: - pages @@ -147762,10 +150766,10 @@ x-webhooks: type: string enum: - created - enterprise: *882 + enterprise: *883 installation: *22 - organization: *884 - repositories: &912 + organization: *885 + repositories: &913 description: An array of repository objects that the installation can access. type: array @@ -147791,8 +150795,8 @@ x-webhooks: - name - full_name - private - repository: *885 - requester: *911 + repository: *886 + requester: *912 sender: *4 required: - action @@ -147867,11 +150871,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 + enterprise: *883 installation: *22 - organization: *884 - repositories: *912 - repository: *885 + organization: *885 + repositories: *913 + repository: *886 requester: nullable: true sender: *4 @@ -147947,11 +150951,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *882 + enterprise: *883 installation: *22 - organization: *884 - repositories: *912 - repository: *885 + organization: *885 + repositories: *913 + repository: *886 requester: nullable: true sender: *4 @@ -148027,10 +151031,10 @@ x-webhooks: type: string enum: - added - enterprise: *882 + enterprise: *883 installation: *22 - organization: *884 - repositories_added: &913 + organization: *885 + repositories_added: &914 description: An array of repository objects, which were added to the installation. type: array @@ -148076,15 +151080,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *885 - repository_selection: &914 + repository: *886 + repository_selection: &915 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *911 + requester: *912 sender: *4 required: - action @@ -148163,10 +151167,10 @@ x-webhooks: type: string enum: - removed - enterprise: *882 + enterprise: *883 installation: *22 - organization: *884 - repositories_added: *913 + organization: *885 + repositories_added: *914 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -148193,9 +151197,9 @@ x-webhooks: - name - full_name - private - repository: *885 - repository_selection: *914 - requester: *911 + repository: *886 + repository_selection: *915 + requester: *912 sender: *4 required: - action @@ -148274,11 +151278,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *882 + enterprise: *883 installation: *22 - organization: *884 - repositories: *912 - repository: *885 + organization: *885 + repositories: *913 + repository: *886 requester: nullable: true sender: *4 @@ -148457,10 +151461,10 @@ x-webhooks: type: string required: - from - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 target_type: type: string @@ -148539,11 +151543,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *882 + enterprise: *883 installation: *22 - organization: *884 - repositories: *912 - repository: *885 + organization: *885 + repositories: *913 + repository: *886 requester: nullable: true sender: *4 @@ -148717,8 +151721,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *705 - required: *706 + properties: *706 + required: *707 nullable: true user: title: User @@ -148803,8 +151807,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -149593,8 +152597,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149943,8 +152947,8 @@ x-webhooks: - state - locked - assignee - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -150024,7 +153028,7 @@ x-webhooks: type: string enum: - deleted - comment: &915 + comment: &916 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself. @@ -150181,8 +153185,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *705 - required: *706 + properties: *706 + required: *707 nullable: true required: - url @@ -150197,8 +153201,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -150983,8 +153987,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151335,8 +154339,8 @@ x-webhooks: - state - locked - assignee - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -151416,7 +154420,7 @@ x-webhooks: type: string enum: - edited - changes: &944 + changes: &945 description: The changes to the comment. type: object properties: @@ -151428,9 +154432,9 @@ x-webhooks: type: string required: - from - comment: *915 - enterprise: *882 - installation: *883 + comment: *916 + enterprise: *883 + installation: *884 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -152218,8 +155222,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152568,8 +155572,8 @@ x-webhooks: - state - locked - assignee - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -152650,9 +155654,9 @@ x-webhooks: type: string enum: - pinned - comment: *915 - enterprise: *882 - installation: *883 + comment: *916 + enterprise: *883 + installation: *884 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -153442,8 +156446,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153794,8 +156798,8 @@ x-webhooks: - state - locked - assignee - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -153875,9 +156879,9 @@ x-webhooks: type: string enum: - unpinned - comment: *915 - enterprise: *882 - installation: *883 + comment: *916 + enterprise: *883 + installation: *884 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -154667,8 +157671,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155019,8 +158023,8 @@ x-webhooks: - state - locked - assignee - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -155109,9 +158113,9 @@ x-webhooks: type: number blocking_issue: *229 blocking_issue_repo: *80 - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -155200,9 +158204,9 @@ x-webhooks: type: number blocking_issue: *229 blocking_issue_repo: *80 - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -155290,9 +158294,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *229 - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -155381,9 +158385,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *229 - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -155463,10 +158467,10 @@ x-webhooks: type: string enum: - assigned - assignee: *911 - enterprise: *882 - installation: *883 - issue: &916 + assignee: *912 + enterprise: *883 + installation: *884 + issue: &917 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. @@ -156258,11 +159262,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156379,8 +159383,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -156460,8 +159464,8 @@ x-webhooks: type: string enum: - closed - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. @@ -157258,11 +160262,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157514,8 +160518,8 @@ x-webhooks: required: - state - closed_at - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -157594,8 +160598,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -158383,11 +161387,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -158503,8 +161507,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -158583,8 +161587,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -159394,11 +162398,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159493,7 +162497,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &917 + milestone: &918 title: Milestone description: A collection of related issues and pull requests. type: object @@ -159631,8 +162635,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -159731,8 +162735,8 @@ x-webhooks: type: string required: - from - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -160524,11 +163528,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160645,9 +163649,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *905 - organization: *884 - repository: *885 + label: *906 + organization: *885 + repository: *886 sender: *4 required: - action @@ -160727,9 +163731,9 @@ x-webhooks: type: string enum: - field_added - enterprise: *882 - installation: *883 - issue: *916 + enterprise: *883 + installation: *884 + issue: *917 issue_field: type: object description: The issue field whose value was set or updated on the @@ -160838,8 +163842,8 @@ x-webhooks: - id required: - from - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -160919,9 +163923,9 @@ x-webhooks: type: string enum: - field_removed - enterprise: *882 - installation: *883 - issue: *916 + enterprise: *883 + installation: *884 + issue: *917 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -160979,8 +163983,8 @@ x-webhooks: nullable: true required: - id - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -161060,8 +164064,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -161852,11 +164856,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -161973,9 +164977,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *905 - organization: *884 - repository: *885 + label: *906 + organization: *885 + repository: *886 sender: *4 required: - action @@ -162055,8 +165059,8 @@ x-webhooks: type: string enum: - locked - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -162871,11 +165875,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -162969,8 +165973,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -163049,8 +166053,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -163859,11 +166863,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -163957,9 +166961,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *917 - organization: *884 - repository: *885 + milestone: *918 + organization: *885 + repository: *886 sender: *4 required: - action @@ -164822,11 +167826,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -165407,8 +168411,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -166192,11 +169196,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -166320,8 +169324,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -166401,9 +169405,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *882 - installation: *883 - issue: &918 + enterprise: *883 + installation: *884 + issue: &919 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. @@ -167189,11 +170193,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -167309,8 +170313,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -167389,8 +170393,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -168203,11 +171207,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -168302,8 +171306,8 @@ x-webhooks: user_view_type: type: string type: *394 - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -169172,11 +172176,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -169771,11 +172775,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *882 - installation: *883 - issue: *918 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + issue: *919 + organization: *885 + repository: *886 sender: *4 required: - action @@ -169855,12 +172859,12 @@ x-webhooks: type: string enum: - typed - enterprise: *882 - installation: *883 - issue: *916 + enterprise: *883 + installation: *884 + issue: *917 type: *394 - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -169941,7 +172945,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &947 + assignee: &948 title: User type: object nullable: true @@ -170011,11 +173015,11 @@ x-webhooks: required: - login - id - enterprise: *882 - installation: *883 - issue: *916 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + issue: *917 + organization: *885 + repository: *886 sender: *4 required: - action @@ -170094,12 +173098,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *882 - installation: *883 - issue: *916 - label: *905 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + issue: *917 + label: *906 + organization: *885 + repository: *886 sender: *4 required: - action @@ -170179,8 +173183,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -170993,11 +173997,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -171091,8 +174095,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -171172,11 +174176,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *882 - installation: *883 - issue: *918 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + issue: *919 + organization: *885 + repository: *886 sender: *4 required: - action @@ -171255,12 +174259,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *882 - installation: *883 - issue: *916 + enterprise: *883 + installation: *884 + issue: *917 type: *394 - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -171340,11 +174344,11 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - label: *905 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + label: *906 + organization: *885 + repository: *886 sender: *4 required: - action @@ -171422,11 +174426,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - label: *905 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + label: *906 + organization: *885 + repository: *886 sender: *4 required: - action @@ -171536,11 +174540,11 @@ x-webhooks: type: string required: - from - enterprise: *882 - installation: *883 - label: *905 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + label: *906 + organization: *885 + repository: *886 sender: *4 required: - action @@ -171622,9 +174626,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *882 - installation: *883 - marketplace_purchase: &919 + enterprise: *883 + installation: *884 + marketplace_purchase: &920 title: Marketplace Purchase type: object required: @@ -171707,8 +174711,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *884 - previous_marketplace_purchase: &920 + organization: *885 + previous_marketplace_purchase: &921 title: Marketplace Purchase type: object properties: @@ -171788,7 +174792,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *885 + repository: *886 sender: *4 required: - action @@ -171868,10 +174872,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *882 - installation: *883 - marketplace_purchase: *919 - organization: *884 + enterprise: *883 + installation: *884 + marketplace_purchase: *920 + organization: *885 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -171954,7 +174958,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *885 + repository: *886 sender: *4 required: - action @@ -172036,10 +175040,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *882 - installation: *883 - marketplace_purchase: *919 - organization: *884 + enterprise: *883 + installation: *884 + marketplace_purchase: *920 + organization: *885 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -172121,7 +175125,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *885 + repository: *886 sender: *4 required: - action @@ -172202,8 +175206,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 marketplace_purchase: title: Marketplace Purchase type: object @@ -172285,9 +175289,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *884 - previous_marketplace_purchase: *920 - repository: *885 + organization: *885 + previous_marketplace_purchase: *921 + repository: *886 sender: *4 required: - action @@ -172367,12 +175371,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *882 - installation: *883 - marketplace_purchase: *919 - organization: *884 - previous_marketplace_purchase: *920 - repository: *885 + enterprise: *883 + installation: *884 + marketplace_purchase: *920 + organization: *885 + previous_marketplace_purchase: *921 + repository: *886 sender: *4 required: - action @@ -172474,11 +175478,11 @@ x-webhooks: type: string required: - to - enterprise: *882 - installation: *883 - member: *911 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + member: *912 + organization: *885 + repository: *886 sender: *4 required: - action @@ -172578,11 +175582,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *882 - installation: *883 - member: *911 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + member: *912 + organization: *885 + repository: *886 sender: *4 required: - action @@ -172661,11 +175665,11 @@ x-webhooks: type: string enum: - removed - enterprise: *882 - installation: *883 - member: *911 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + member: *912 + organization: *885 + repository: *886 sender: *4 required: - action @@ -172743,11 +175747,11 @@ x-webhooks: type: string enum: - added - enterprise: *882 - installation: *883 - member: *911 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + member: *912 + organization: *885 + repository: *886 scope: description: The scope of the membership. Currently, can only be `team`. @@ -172823,7 +175827,7 @@ x-webhooks: required: - login - id - team: &921 + team: &922 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -173046,11 +176050,11 @@ x-webhooks: type: string enum: - removed - enterprise: *882 - installation: *883 - member: *911 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + member: *912 + organization: *885 + repository: *886 scope: description: The scope of the membership. Currently, can only be `team`. @@ -173127,7 +176131,7 @@ x-webhooks: required: - login - id - team: *921 + team: *922 required: - action - scope @@ -173209,8 +176213,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *883 - merge_group: &923 + installation: *884 + merge_group: &924 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -173229,15 +176233,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *922 + head_commit: *923 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -173323,10 +176327,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *883 - merge_group: *923 - organization: *884 - repository: *885 + installation: *884 + merge_group: *924 + organization: *885 + repository: *886 sender: *4 required: - action @@ -173399,7 +176403,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 + enterprise: *883 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -173508,16 +176512,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *883 - organization: *884 + installation: *884 + organization: *885 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *924 - required: *925 + properties: *925 + required: *926 nullable: true sender: *4 required: @@ -173598,11 +176602,11 @@ x-webhooks: type: string enum: - closed - enterprise: *882 - installation: *883 - milestone: *917 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + milestone: *918 + organization: *885 + repository: *886 sender: *4 required: - action @@ -173681,9 +176685,9 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - milestone: &926 + enterprise: *883 + installation: *884 + milestone: &927 title: Milestone description: A collection of related issues and pull requests. type: object @@ -173820,8 +176824,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -173900,11 +176904,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - milestone: *917 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + milestone: *918 + organization: *885 + repository: *886 sender: *4 required: - action @@ -174014,11 +177018,11 @@ x-webhooks: type: string required: - from - enterprise: *882 - installation: *883 - milestone: *917 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + milestone: *918 + organization: *885 + repository: *886 sender: *4 required: - action @@ -174098,11 +177102,11 @@ x-webhooks: type: string enum: - opened - enterprise: *882 - installation: *883 - milestone: *926 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + milestone: *927 + organization: *885 + repository: *886 sender: *4 required: - action @@ -174181,11 +177185,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *911 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + blocked_user: *912 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -174264,11 +177268,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *911 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + blocked_user: *912 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -174344,7 +177348,7 @@ x-webhooks: enum: - created definition: *156 - enterprise: *882 + enterprise: *883 sender: *4 required: - action @@ -174424,8 +177428,8 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 sender: *4 required: - action @@ -174498,8 +177502,8 @@ x-webhooks: enum: - updated definition: *156 - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 sender: *4 required: - action @@ -174571,9 +177575,9 @@ x-webhooks: type: string enum: - updated - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 sender: *4 new_property_values: type: array @@ -174661,9 +177665,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - membership: &927 + enterprise: *883 + installation: *884 + membership: &928 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -174770,8 +177774,8 @@ x-webhooks: - role - organization_url - user - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -174849,11 +177853,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *882 - installation: *883 - membership: *927 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + membership: *928 + organization: *885 + repository: *886 sender: *4 required: - action @@ -174932,8 +177936,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -175049,10 +178053,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 - user: *911 + user: *912 required: - action - invitation @@ -175130,11 +178134,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *882 - installation: *883 - membership: *927 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + membership: *928 + organization: *885 + repository: *886 sender: *4 required: - action @@ -175221,11 +178225,11 @@ x-webhooks: properties: from: type: string - enterprise: *882 - installation: *883 - membership: *927 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + membership: *928 + organization: *885 + repository: *886 sender: *4 required: - action @@ -175303,9 +178307,9 @@ x-webhooks: type: string enum: - published - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 package: description: Information about the package. type: object @@ -175804,7 +178808,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &928 + items: &929 title: Ruby Gems metadata type: object properties: @@ -175899,7 +178903,7 @@ x-webhooks: - owner - package_version - registry - repository: *885 + repository: *886 sender: *4 required: - action @@ -175976,9 +178980,9 @@ x-webhooks: type: string enum: - updated - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 package: description: Information about the package. type: object @@ -176331,7 +179335,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *928 + items: *929 source_url: type: string format: uri @@ -176401,7 +179405,7 @@ x-webhooks: - owner - package_version - registry - repository: *885 + repository: *886 sender: *4 required: - action @@ -176577,12 +179581,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *882 + enterprise: *883 id: type: integer - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - id @@ -176659,7 +179663,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &929 + personal_access_token_request: &930 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -176805,10 +179809,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *882 - organization: *884 + enterprise: *883 + organization: *885 sender: *4 - installation: *883 + installation: *884 required: - action - personal_access_token_request @@ -176885,11 +179889,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *929 - enterprise: *882 - organization: *884 + personal_access_token_request: *930 + enterprise: *883 + organization: *885 sender: *4 - installation: *883 + installation: *884 required: - action - personal_access_token_request @@ -176965,11 +179969,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *929 - enterprise: *882 - organization: *884 + personal_access_token_request: *930 + enterprise: *883 + organization: *885 sender: *4 - installation: *883 + installation: *884 required: - action - personal_access_token_request @@ -177044,11 +180048,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *929 - organization: *884 - enterprise: *882 + personal_access_token_request: *930 + organization: *885 + enterprise: *883 sender: *4 - installation: *883 + installation: *884 required: - action - personal_access_token_request @@ -177153,7 +180157,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *930 + last_response: *931 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -177185,8 +180189,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 zen: description: Random string of GitHub zen. @@ -177431,10 +180435,10 @@ x-webhooks: - from required: - note - enterprise: *882 - installation: *883 - organization: *884 - project_card: &931 + enterprise: *883 + installation: *884 + organization: *885 + project_card: &932 title: Project Card type: object properties: @@ -177553,7 +180557,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *885 + repository: *886 sender: *4 required: - action @@ -177634,11 +180638,11 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - project_card: *931 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + project_card: *932 + repository: *886 sender: *4 required: - action @@ -177718,9 +180722,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 project_card: title: Project Card type: object @@ -177848,8 +180852,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *924 - required: *925 + properties: *925 + required: *926 nullable: true sender: *4 required: @@ -177943,11 +180947,11 @@ x-webhooks: - from required: - note - enterprise: *882 - installation: *883 - organization: *884 - project_card: *931 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + project_card: *932 + repository: *886 sender: *4 required: - action @@ -178041,9 +181045,9 @@ x-webhooks: - from required: - column_id - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 project_card: allOf: - title: Project Card @@ -178233,7 +181237,7 @@ x-webhooks: type: string required: - after_id - repository: *885 + repository: *886 sender: *4 required: - action @@ -178313,10 +181317,10 @@ x-webhooks: type: string enum: - closed - enterprise: *882 - installation: *883 - organization: *884 - project: &933 + enterprise: *883 + installation: *884 + organization: *885 + project: &934 title: Project type: object properties: @@ -178440,7 +181444,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *885 + repository: *886 sender: *4 required: - action @@ -178520,10 +181524,10 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - project_column: &932 + enterprise: *883 + installation: *884 + organization: *885 + project_column: &933 title: Project Column type: object properties: @@ -178562,7 +181566,7 @@ x-webhooks: - name - created_at - updated_at - repository: *885 + repository: *886 sender: *4 required: - action @@ -178641,18 +181645,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - organization: *884 - project_column: *932 + enterprise: *883 + installation: *884 + organization: *885 + project_column: *933 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *924 - required: *925 + properties: *925 + required: *926 nullable: true sender: *4 required: @@ -178742,11 +181746,11 @@ x-webhooks: type: string required: - from - enterprise: *882 - installation: *883 - organization: *884 - project_column: *932 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + project_column: *933 + repository: *886 sender: *4 required: - action @@ -178826,11 +181830,11 @@ x-webhooks: type: string enum: - moved - enterprise: *882 - installation: *883 - organization: *884 - project_column: *932 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + project_column: *933 + repository: *886 sender: *4 required: - action @@ -178910,11 +181914,11 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - project: *933 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + project: *934 + repository: *886 sender: *4 required: - action @@ -178994,18 +181998,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - organization: *884 - project: *933 + enterprise: *883 + installation: *884 + organization: *885 + project: *934 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *924 - required: *925 + properties: *925 + required: *926 nullable: true sender: *4 required: @@ -179107,11 +182111,11 @@ x-webhooks: type: string required: - from - enterprise: *882 - installation: *883 - organization: *884 - project: *933 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + project: *934 + repository: *886 sender: *4 required: - action @@ -179190,11 +182194,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *882 - installation: *883 - organization: *884 - project: *933 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + project: *934 + repository: *886 sender: *4 required: - action @@ -179275,8 +182279,8 @@ x-webhooks: type: string enum: - closed - installation: *883 - organization: *884 + installation: *884 + organization: *885 projects_v2: *426 sender: *4 required: @@ -179358,8 +182362,8 @@ x-webhooks: type: string enum: - created - installation: *883 - organization: *884 + installation: *884 + organization: *885 projects_v2: *426 sender: *4 required: @@ -179441,8 +182445,8 @@ x-webhooks: type: string enum: - deleted - installation: *883 - organization: *884 + installation: *884 + organization: *885 projects_v2: *426 sender: *4 required: @@ -179560,8 +182564,8 @@ x-webhooks: type: string to: type: string - installation: *883 - organization: *884 + installation: *884 + organization: *885 projects_v2: *426 sender: *4 required: @@ -179645,7 +182649,7 @@ x-webhooks: type: string enum: - archived - changes: &937 + changes: &938 type: object properties: archived_at: @@ -179659,9 +182663,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *883 - organization: *884 - projects_v2_item: &934 + installation: *884 + organization: *885 + projects_v2_item: &935 title: Projects v2 Item description: An item belonging to a project type: object @@ -179796,9 +182800,9 @@ x-webhooks: nullable: true to: type: string - installation: *883 - organization: *884 - projects_v2_item: *934 + installation: *884 + organization: *885 + projects_v2_item: *935 sender: *4 required: - action @@ -179880,9 +182884,9 @@ x-webhooks: type: string enum: - created - installation: *883 - organization: *884 - projects_v2_item: *934 + installation: *884 + organization: *885 + projects_v2_item: *935 sender: *4 required: - action @@ -179963,9 +182967,9 @@ x-webhooks: type: string enum: - deleted - installation: *883 - organization: *884 - projects_v2_item: *934 + installation: *884 + organization: *885 + projects_v2_item: *935 sender: *4 required: - action @@ -180071,7 +183075,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &935 + - &936 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -180093,7 +183097,7 @@ x-webhooks: required: - id - name - - &936 + - &937 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -180127,8 +183131,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *935 - *936 + - *937 required: - field_value - type: object @@ -180144,9 +183148,9 @@ x-webhooks: nullable: true required: - body - installation: *883 - organization: *884 - projects_v2_item: *934 + installation: *884 + organization: *885 + projects_v2_item: *935 sender: *4 required: - action @@ -180241,9 +183245,9 @@ x-webhooks: to: type: string nullable: true - installation: *883 - organization: *884 - projects_v2_item: *934 + installation: *884 + organization: *885 + projects_v2_item: *935 sender: *4 required: - action @@ -180326,10 +183330,10 @@ x-webhooks: type: string enum: - restored - changes: *937 - installation: *883 - organization: *884 - projects_v2_item: *934 + changes: *938 + installation: *884 + organization: *885 + projects_v2_item: *935 sender: *4 required: - action @@ -180411,8 +183415,8 @@ x-webhooks: type: string enum: - reopened - installation: *883 - organization: *884 + installation: *884 + organization: *885 projects_v2: *426 sender: *4 required: @@ -180494,14 +183498,14 @@ x-webhooks: type: string enum: - created - installation: *883 - organization: *884 - projects_v2_status_update: &940 + installation: *884 + organization: *885 + projects_v2_status_update: &941 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *938 - required: *939 + properties: *939 + required: *940 sender: *4 required: - action @@ -180582,9 +183586,9 @@ x-webhooks: type: string enum: - deleted - installation: *883 - organization: *884 - projects_v2_status_update: *940 + installation: *884 + organization: *885 + projects_v2_status_update: *941 sender: *4 required: - action @@ -180720,9 +183724,9 @@ x-webhooks: type: string format: date nullable: true - installation: *883 - organization: *884 - projects_v2_status_update: *940 + installation: *884 + organization: *885 + projects_v2_status_update: *941 sender: *4 required: - action @@ -180793,10 +183797,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - repository @@ -180873,13 +183877,13 @@ x-webhooks: type: string enum: - assigned - assignee: *911 - enterprise: *882 - installation: *883 - number: &941 + assignee: *912 + enterprise: *883 + installation: *884 + number: &942 description: The pull request number. type: integer - organization: *884 + organization: *885 pull_request: title: Pull Request type: object @@ -183184,7 +186188,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 sender: *4 required: - action @@ -183266,11 +186270,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 number: type: integer - organization: *884 + organization: *885 pull_request: title: Pull Request type: object @@ -185570,7 +188574,7 @@ x-webhooks: - draft reason: type: string - repository: *885 + repository: *886 sender: *4 required: - action @@ -185652,11 +188656,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 number: type: integer - organization: *884 + organization: *885 pull_request: title: Pull Request type: object @@ -187956,7 +190960,7 @@ x-webhooks: - draft reason: type: string - repository: *885 + repository: *886 sender: *4 required: - action @@ -188038,13 +191042,13 @@ x-webhooks: type: string enum: - closed - enterprise: *882 - installation: *883 - number: *941 - organization: *884 - pull_request: &942 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 + pull_request: &943 allOf: - - *730 + - *731 - type: object properties: allow_auto_merge: @@ -188106,7 +191110,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *885 + repository: *886 sender: *4 required: - action @@ -188187,12 +191191,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *882 - installation: *883 - number: *941 - organization: *884 - pull_request: *942 - repository: *885 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 + pull_request: *943 + repository: *886 sender: *4 required: - action @@ -188272,11 +191276,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *882 - milestone: *712 - number: *941 - organization: *884 - pull_request: &943 + enterprise: *883 + milestone: *713 + number: *942 + organization: *885 + pull_request: &944 title: Pull Request type: object properties: @@ -190561,7 +193565,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 sender: *4 required: - action @@ -190640,11 +193644,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 number: type: integer - organization: *884 + organization: *885 pull_request: title: Pull Request type: object @@ -192948,7 +195952,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *885 + repository: *886 sender: *4 required: - action @@ -193072,12 +196076,12 @@ x-webhooks: type: string required: - from - enterprise: *882 - installation: *883 - number: *941 - organization: *884 - pull_request: *942 - repository: *885 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 + pull_request: *943 + repository: *886 sender: *4 required: - action @@ -193157,11 +196161,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 number: type: integer - organization: *884 + organization: *885 pull_request: title: Pull Request type: object @@ -195450,7 +198454,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 sender: *4 required: - action @@ -195530,11 +198534,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *882 - installation: *883 - label: *905 - number: *941 - organization: *884 + enterprise: *883 + installation: *884 + label: *906 + number: *942 + organization: *885 pull_request: title: Pull Request type: object @@ -197838,7 +200842,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 sender: *4 required: - action @@ -197919,10 +200923,10 @@ x-webhooks: type: string enum: - locked - enterprise: *882 - installation: *883 - number: *941 - organization: *884 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 pull_request: title: Pull Request type: object @@ -200224,7 +203228,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 sender: *4 required: - action @@ -200304,12 +203308,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *882 - milestone: *712 - number: *941 - organization: *884 - pull_request: *943 - repository: *885 + enterprise: *883 + milestone: *713 + number: *942 + organization: *885 + pull_request: *944 + repository: *886 sender: *4 required: - action @@ -200388,12 +203392,12 @@ x-webhooks: type: string enum: - opened - enterprise: *882 - installation: *883 - number: *941 - organization: *884 - pull_request: *942 - repository: *885 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 + pull_request: *943 + repository: *886 sender: *4 required: - action @@ -200474,12 +203478,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *882 - installation: *883 - number: *941 - organization: *884 - pull_request: *942 - repository: *885 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 + pull_request: *943 + repository: *886 sender: *4 required: - action @@ -200559,12 +203563,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *882 - installation: *883 - number: *941 - organization: *884 - pull_request: *942 - repository: *885 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 + pull_request: *943 + repository: *886 sender: *4 required: - action @@ -200930,9 +203934,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 pull_request: type: object properties: @@ -203124,7 +206128,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *885 + repository: *886 sender: *4 required: - action @@ -203204,7 +206208,7 @@ x-webhooks: type: string enum: - deleted - comment: &945 + comment: &946 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. @@ -203489,9 +206493,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 pull_request: type: object properties: @@ -205671,7 +208675,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *885 + repository: *886 sender: *4 required: - action @@ -205751,11 +208755,11 @@ x-webhooks: type: string enum: - edited - changes: *944 - comment: *945 - enterprise: *882 - installation: *883 - organization: *884 + changes: *945 + comment: *946 + enterprise: *883 + installation: *884 + organization: *885 pull_request: type: object properties: @@ -207938,7 +210942,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *885 + repository: *886 sender: *4 required: - action @@ -208019,9 +211023,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 pull_request: title: Simple Pull Request type: object @@ -210216,7 +213220,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *885 + repository: *886 review: description: The review that was affected. type: object @@ -210463,9 +213467,9 @@ x-webhooks: type: string required: - from - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 pull_request: title: Simple Pull Request type: object @@ -212519,8 +215523,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *885 - review: &946 + repository: *886 + review: &947 description: The review that was affected. type: object properties: @@ -212753,12 +215757,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 number: description: The pull request number. type: integer - organization: *884 + organization: *885 pull_request: title: Pull Request type: object @@ -215063,7 +218067,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 requested_reviewer: title: User type: object @@ -215147,12 +218151,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 number: description: The pull request number. type: integer - organization: *884 + organization: *885 pull_request: title: Pull Request type: object @@ -217464,7 +220468,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 requested_team: title: Team description: Groups of organization members that gives permissions @@ -217656,12 +220660,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 number: description: The pull request number. type: integer - organization: *884 + organization: *885 pull_request: title: Pull Request type: object @@ -219968,7 +222972,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 requested_reviewer: title: User type: object @@ -220053,12 +223057,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 number: description: The pull request number. type: integer - organization: *884 + organization: *885 pull_request: title: Pull Request type: object @@ -222356,7 +225360,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 requested_team: title: Team description: Groups of organization members that gives permissions @@ -222537,9 +225541,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 pull_request: title: Simple Pull Request type: object @@ -224736,8 +227740,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *885 - review: *946 + repository: *886 + review: *947 sender: *4 required: - action @@ -224817,9 +227821,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 pull_request: title: Simple Pull Request type: object @@ -226911,7 +229915,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *885 + repository: *886 sender: *4 thread: type: object @@ -227298,9 +230302,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 pull_request: title: Simple Pull Request type: object @@ -229378,7 +232382,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *885 + repository: *886 sender: *4 thread: type: object @@ -229768,10 +232772,10 @@ x-webhooks: type: string before: type: string - enterprise: *882 - installation: *883 - number: *941 - organization: *884 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 pull_request: title: Pull Request type: object @@ -232064,7 +235068,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 sender: *4 required: - action @@ -232146,11 +235150,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *947 - enterprise: *882 - installation: *883 - number: *941 - organization: *884 + assignee: *948 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 pull_request: title: Pull Request type: object @@ -234455,7 +237459,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 sender: *4 required: - action @@ -234534,11 +237538,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *882 - installation: *883 - label: *905 - number: *941 - organization: *884 + enterprise: *883 + installation: *884 + label: *906 + number: *942 + organization: *885 pull_request: title: Pull Request type: object @@ -236833,7 +239837,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 sender: *4 required: - action @@ -236914,10 +239918,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *882 - installation: *883 - number: *941 - organization: *884 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 pull_request: title: Pull Request type: object @@ -239204,7 +242208,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 sender: *4 required: - action @@ -239404,7 +242408,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *882 + enterprise: *883 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -239496,8 +242500,8 @@ x-webhooks: - url - author - committer - installation: *883 - organization: *884 + installation: *884 + organization: *885 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -240083,9 +243087,9 @@ x-webhooks: type: string enum: - published - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 registry_package: type: object properties: @@ -240531,7 +243535,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *928 + items: *929 summary: type: string tag_name: @@ -240585,7 +243589,7 @@ x-webhooks: - owner - package_version - registry - repository: *885 + repository: *886 sender: *4 required: - action @@ -240663,9 +243667,9 @@ x-webhooks: type: string enum: - updated - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 registry_package: type: object properties: @@ -240973,7 +243977,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *928 + items: *929 summary: type: string tag_name: @@ -241022,7 +244026,7 @@ x-webhooks: - owner - package_version - registry - repository: *885 + repository: *886 sender: *4 required: - action @@ -241099,10 +244103,10 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - release: &948 + enterprise: *883 + installation: *884 + organization: *885 + release: &949 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object. @@ -241420,7 +244424,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *885 + repository: *886 sender: *4 required: - action @@ -241497,11 +244501,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - organization: *884 - release: *948 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + release: *949 + repository: *886 sender: *4 required: - action @@ -241618,11 +244622,11 @@ x-webhooks: type: boolean required: - to - enterprise: *882 - installation: *883 - organization: *884 - release: *948 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + release: *949 + repository: *886 sender: *4 required: - action @@ -241700,9 +244704,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) @@ -242024,7 +245028,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *885 + repository: *886 sender: *4 required: - action @@ -242100,10 +245104,10 @@ x-webhooks: type: string enum: - published - enterprise: *882 - installation: *883 - organization: *884 - release: &949 + enterprise: *883 + installation: *884 + organization: *885 + release: &950 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object. @@ -242422,7 +245426,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *885 + repository: *886 sender: *4 required: - action @@ -242498,11 +245502,11 @@ x-webhooks: type: string enum: - released - enterprise: *882 - installation: *883 - organization: *884 - release: *948 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + release: *949 + repository: *886 sender: *4 required: - action @@ -242578,11 +245582,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *882 - installation: *883 - organization: *884 - release: *949 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + release: *950 + repository: *886 sender: *4 required: - action @@ -242658,11 +245662,11 @@ x-webhooks: type: string enum: - published - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - repository_advisory: *782 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + repository_advisory: *783 sender: *4 required: - action @@ -242738,11 +245742,11 @@ x-webhooks: type: string enum: - reported - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - repository_advisory: *782 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + repository_advisory: *783 sender: *4 required: - action @@ -242818,10 +245822,10 @@ x-webhooks: type: string enum: - archived - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -242898,10 +245902,10 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -242979,10 +245983,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -243066,10 +246070,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -243181,10 +246185,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -243256,10 +246260,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 status: type: string @@ -243340,10 +246344,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -243420,10 +246424,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -243517,10 +246521,10 @@ x-webhooks: - name required: - repository - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -243600,10 +246604,10 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 repository_ruleset: *195 sender: *4 required: @@ -243682,10 +246686,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 repository_ruleset: *195 sender: *4 required: @@ -243764,10 +246768,10 @@ x-webhooks: type: string enum: - edited - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 repository_ruleset: *195 changes: type: object @@ -243829,16 +246833,16 @@ x-webhooks: properties: added: type: array - items: *750 + items: *751 deleted: type: array - items: *750 + items: *751 updated: type: array items: type: object properties: - rule: *750 + rule: *751 changes: type: object properties: @@ -244072,10 +247076,10 @@ x-webhooks: - from required: - owner - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -244153,10 +247157,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -244234,7 +247238,7 @@ x-webhooks: type: string enum: - create - alert: &950 + alert: &951 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -244356,10 +247360,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -244565,10 +247569,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -244646,11 +247650,11 @@ x-webhooks: type: string enum: - reopen - alert: *950 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + alert: *951 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -244849,10 +247853,10 @@ x-webhooks: enum: - fixed - open - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -244930,7 +247934,7 @@ x-webhooks: type: string enum: - assigned - alert: &951 + alert: &952 type: object properties: number: *131 @@ -245073,10 +248077,10 @@ x-webhooks: required: *21 nullable: true assignee: *4 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -245154,11 +248158,11 @@ x-webhooks: type: string enum: - created - alert: *951 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + alert: *952 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -245239,11 +248243,11 @@ x-webhooks: type: string enum: - created - alert: *951 - installation: *883 - location: *952 - organization: *884 - repository: *885 + alert: *952 + installation: *884 + location: *953 + organization: *885 + repository: *886 sender: *4 required: - location @@ -245481,11 +248485,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *951 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + alert: *952 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -245563,11 +248567,11 @@ x-webhooks: type: string enum: - reopened - alert: *951 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + alert: *952 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -245645,11 +248649,11 @@ x-webhooks: type: string enum: - resolved - alert: *951 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + alert: *952 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -245727,12 +248731,12 @@ x-webhooks: type: string enum: - unassigned - alert: *951 + alert: *952 assignee: *4 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -245810,11 +248814,11 @@ x-webhooks: type: string enum: - validated - alert: *951 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + alert: *952 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -245940,10 +248944,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *885 - enterprise: *882 - installation: *883 - organization: *884 + repository: *886 + enterprise: *883 + installation: *884 + organization: *885 sender: *4 required: - action @@ -246021,11 +249025,11 @@ x-webhooks: type: string enum: - published - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - security_advisory: &953 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + security_advisory: &954 description: The details of the security advisory, including summary, description, and severity. type: object @@ -246208,11 +249212,11 @@ x-webhooks: type: string enum: - updated - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - security_advisory: *953 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + security_advisory: *954 sender: *4 required: - action @@ -246285,10 +249289,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -246473,10 +249477,10 @@ x-webhooks: type: object properties: security_and_analysis: *443 - enterprise: *882 - installation: *883 - organization: *884 - repository: *489 + enterprise: *883 + installation: *884 + organization: *885 + repository: *490 sender: *4 required: - changes @@ -246554,12 +249558,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - sponsorship: &954 + sponsorship: &955 type: object properties: created_at: @@ -246860,12 +249864,12 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - sponsorship: *954 + sponsorship: *955 required: - action - sponsorship @@ -246953,12 +249957,12 @@ x-webhooks: type: string required: - from - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - sponsorship: *954 + sponsorship: *955 required: - action - changes @@ -247035,17 +250039,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &955 + effective_date: &956 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: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - sponsorship: *954 + sponsorship: *955 required: - action - sponsorship @@ -247119,7 +250123,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &956 + changes: &957 type: object properties: tier: @@ -247163,13 +250167,13 @@ x-webhooks: - from required: - tier - effective_date: *955 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + effective_date: *956 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - sponsorship: *954 + sponsorship: *955 required: - action - changes @@ -247246,13 +250250,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *956 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + changes: *957 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - sponsorship: *954 + sponsorship: *955 required: - action - changes @@ -247326,10 +250330,10 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -247412,10 +250416,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -247835,15 +250839,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *882 + enterprise: *883 id: description: The unique identifier of the status. type: integer - installation: *883 + installation: *884 name: type: string - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 sha: description: The Commit SHA. @@ -247958,9 +250962,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *229 - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -248050,9 +251054,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *229 - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -248142,9 +251146,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *229 - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -248234,9 +251238,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *229 - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -248313,12 +251317,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - team: &957 + team: &958 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -248541,9 +251545,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 repository: title: Repository description: A git repository @@ -249001,7 +252005,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *957 + team: *958 required: - action - team @@ -249077,9 +252081,9 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 repository: title: Repository description: A git repository @@ -249537,7 +252541,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *957 + team: *958 required: - action - team @@ -249614,9 +252618,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 repository: title: Repository description: A git repository @@ -250074,7 +253078,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *957 + team: *958 required: - action - team @@ -250218,9 +253222,9 @@ x-webhooks: - from required: - permissions - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 repository: title: Repository description: A git repository @@ -250678,7 +253682,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *957 + team: *958 required: - action - changes @@ -250756,9 +253760,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 repository: title: Repository description: A git repository @@ -251216,7 +254220,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *957 + team: *958 required: - action - team @@ -251292,10 +254296,10 @@ x-webhooks: type: string enum: - started - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -251368,16 +254372,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *882 + enterprise: *883 inputs: type: object nullable: true additionalProperties: true - installation: *883 - organization: *884 + installation: *884 + organization: *885 ref: type: string - repository: *885 + repository: *886 sender: *4 workflow: type: string @@ -251459,10 +254463,10 @@ x-webhooks: type: string enum: - completed - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 workflow_job: allOf: @@ -251699,7 +254703,7 @@ x-webhooks: type: string required: - conclusion - deployment: *631 + deployment: *632 required: - action - repository @@ -251778,10 +254782,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 workflow_job: allOf: @@ -252041,7 +255045,7 @@ x-webhooks: required: - status - steps - deployment: *631 + deployment: *632 required: - action - repository @@ -252120,10 +255124,10 @@ x-webhooks: type: string enum: - queued - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 workflow_job: type: object @@ -252258,7 +255262,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *631 + deployment: *632 required: - action - repository @@ -252337,10 +255341,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 workflow_job: type: object @@ -252476,7 +255480,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *631 + deployment: *632 required: - action - repository @@ -252556,12 +255560,12 @@ x-webhooks: type: string enum: - completed - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - workflow: *901 + workflow: *902 workflow_run: title: Workflow Run type: object @@ -253560,12 +256564,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - workflow: *901 + workflow: *902 workflow_run: title: Workflow Run type: object @@ -254549,12 +257553,12 @@ x-webhooks: type: string enum: - requested - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - workflow: *901 + workflow: *902 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json index 5c6ef7444..fbb7260f3 100644 --- a/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json @@ -1980,6 +1980,3164 @@ } } }, + "/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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "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", @@ -65080,6 +68238,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": { @@ -136193,7 +139360,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" ], @@ -136252,20 +139419,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, "example": "1.2.3" @@ -218294,7 +221461,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -218375,6 +221543,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" @@ -218519,7 +221695,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" ], @@ -218608,7 +221784,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", @@ -218616,7 +221792,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -218652,7 +221829,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": { @@ -218670,6 +221847,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": [ @@ -218728,6 +221913,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" + } } } } @@ -218777,7 +221973,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -218864,6 +222061,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" @@ -219191,7 +222396,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -219272,6 +222478,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" @@ -219340,7 +222554,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" ], @@ -219446,7 +222660,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ] }, "tenant_id": { @@ -219482,7 +222697,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": { @@ -219500,6 +222715,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" } } }, @@ -261508,6 +264731,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": { @@ -286768,25 +290000,525 @@ } }, { - "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", + "format": "date-time", + "nullable": true + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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", + "format": "uri", + "description": "API URL for the workflow run.", + "nullable": true + }, + "run_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the workflow run.", + "nullable": true + }, + "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", + "format": "uri", + "description": "API URL for the job.", + "nullable": true + }, + "job_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the job.", + "nullable": true + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "concurrency-groups" } } }, @@ -301786,99 +305518,374 @@ } }, { - "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", + "format": "uri", + "description": "API URL for the workflow run.", + "nullable": true + }, + "run_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the workflow run.", + "nullable": true + }, + "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", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease.", + "nullable": true + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease.", + "nullable": true + }, + "job_url": { + "type": "string", + "format": "uri", + "description": "API URL for the job.", + "nullable": true + }, + "job_html_url": { + "type": "string", + "format": "uri", + "description": "Web URL for the job.", + "nullable": true + }, + "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": { @@ -301902,13 +305909,82 @@ } } } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "workflow-runs" + "subcategory": "concurrency-groups" } } }, @@ -585664,6 +589740,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": { @@ -589527,6 +593612,9 @@ "400": { "description": "Bad request, resolution comment is invalid or the resolution was not changed." }, + "403": { + "description": "Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer." + }, "404": { "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, diff --git a/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml index 31d527135..de3b59936 100644 --- a/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml @@ -842,7 +842,7 @@ paths: - subscriptions_url - type - url - type: &467 + type: &468 type: string description: The type of credit the user is receiving. enum: @@ -1007,7 +1007,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: - - &784 + - &785 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1094,6 +1094,2525 @@ 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 + format: date-time + nullable: true + 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 @@ -1701,7 +4220,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &793 + schema: &794 title: Scim Error description: Scim Error type: object @@ -9054,7 +11573,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &794 + '401': &795 description: Authorization failure '404': *6 x-github: @@ -13265,7 +15784,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &558 + instances_url: &559 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13300,7 +15819,7 @@ paths: format: date-time readOnly: true nullable: true - dismissed_reason: &559 + dismissed_reason: &560 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -13309,13 +15828,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &560 + dismissed_comment: &561 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &561 + rule: &562 type: object properties: id: @@ -13368,7 +15887,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &562 + tool: &563 type: object properties: name: *113 @@ -13378,26 +15897,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *114 - most_recent_instance: &563 + most_recent_instance: &564 type: object properties: - ref: &556 + ref: &557 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &573 + analysis_key: &574 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: &574 + environment: &575 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: &575 + category: &576 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -13417,7 +15936,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: &576 + location: &577 type: object description: Describe a region within a file for the alert. properties: @@ -13438,7 +15957,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: &577 + items: &578 type: string description: A classification of the file. For example to identify it as generated. @@ -17858,7 +20377,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 - - &620 + - &621 name: has in: query description: |- @@ -17981,7 +20500,7 @@ paths: - direct - transitive - inconclusive - security_advisory: &621 + security_advisory: &622 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -18198,14 +20717,14 @@ paths: nullable: true maxLength: 280 fixed_at: *141 - auto_dismissed_at: &622 + auto_dismissed_at: &623 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissal_request: &623 + dismissal_request: &624 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -19995,7 +22514,7 @@ paths: - name - created_on examples: - default: &472 + default: &473 value: total_count: 2 network_configurations: @@ -20246,7 +22765,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: - *41 - - &473 + - &474 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -20258,7 +22777,7 @@ paths: description: Response content: application/json: - schema: &474 + schema: &475 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -20292,7 +22811,7 @@ paths: - subnet_id - region examples: - default: &475 + default: &476 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -22351,7 +24870,7 @@ paths: - *169 rules: type: array - items: &750 + items: &751 title: Repository Rule type: object description: A repository rule. @@ -22360,7 +24879,7 @@ paths: - *175 - *176 - *177 - - &748 + - &749 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -22930,6 +25449,17 @@ paths: schema: type: boolean default: false + - &463 + 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 @@ -22937,7 +25467,7 @@ paths: application/json: schema: type: array - items: &463 + items: &464 type: object properties: number: *131 @@ -22956,14 +25486,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &762 + state: &763 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: &763 + resolution: &764 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -23080,8 +25610,8 @@ paths: pull request. ' - oneOf: &764 - - &766 + oneOf: &765 + - &767 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -23139,7 +25669,7 @@ paths: - blob_url - commit_sha - commit_url - - &767 + - &768 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. @@ -23194,7 +25724,7 @@ paths: - page_url - commit_sha - commit_url - - &768 + - &769 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -23214,7 +25744,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &769 + - &770 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -23234,7 +25764,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &770 + - &771 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -23254,7 +25784,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &771 + - &772 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -23268,7 +25798,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &772 + - &773 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -23282,7 +25812,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &773 + - &774 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -23296,7 +25826,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &774 + - &775 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. @@ -23316,7 +25846,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &775 + - &776 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. @@ -23336,7 +25866,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &776 + - &777 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. @@ -23356,7 +25886,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &777 + - &778 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. @@ -23376,7 +25906,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &778 + - &779 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 request. @@ -23424,7 +25954,7 @@ paths: required: *21 nullable: true examples: - default: &464 + default: &465 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -23633,7 +26163,7 @@ paths: description: Response content: application/json: - schema: &465 + schema: &466 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -23716,7 +26246,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *201 examples: - default: &466 + default: &467 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -23852,7 +26382,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *41 - - &469 + - &470 name: advanced_security_product in: query description: | @@ -23872,7 +26402,7 @@ paths: description: Success content: application/json: - schema: &470 + schema: &471 type: object properties: total_advanced_security_committers: @@ -23927,7 +26457,7 @@ paths: required: - repositories examples: - default: &471 + default: &472 value: total_advanced_security_committers: 2 total_count: 2 @@ -27039,7 +29569,7 @@ paths: properties: action: type: string - discussion: &902 + discussion: &903 title: Discussion description: A Discussion in a repository. type: object @@ -27406,7 +29936,7 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &682 + properties: &683 id: type: integer format: int64 @@ -27775,7 +30305,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &821 + sub_issues_summary: &822 title: Sub-issues Summary type: object properties: @@ -27862,7 +30392,7 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: &705 + properties: &706 pinned_at: type: string format: date-time @@ -27874,7 +30404,7 @@ paths: properties: *20 required: *21 nullable: true - required: &706 + required: &707 - pinned_at - pinned_by nullable: true @@ -27888,7 +30418,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &822 + issue_dependencies_summary: &823 title: Issue Dependencies Summary type: object properties: @@ -27907,7 +30437,7 @@ paths: - total_blocking issue_field_values: type: array - items: &689 + items: &690 title: Issue Field Value description: A value assigned to an issue field type: object @@ -27968,7 +30498,7 @@ paths: - node_id - data_type - value - required: &683 + required: &684 - closed_at - comments - comments_url @@ -28005,7 +30535,7 @@ paths: action: type: string issue: *229 - comment: &678 + comment: &679 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -28669,7 +31199,7 @@ paths: type: string release: allOf: - - &741 + - &742 title: Release description: A release. type: object @@ -28740,7 +31270,7 @@ paths: author: *4 assets: type: array - items: &742 + items: &743 title: Release Asset description: Data related to a release. type: object @@ -32394,14 +34924,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: - - &484 + - &485 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &485 + - &486 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -32463,7 +34993,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &490 + '301': &491 description: Moved permanently content: application/json: @@ -32485,7 +35015,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &715 + - &716 name: all description: If `true`, show notifications marked as read. in: query @@ -32493,7 +35023,7 @@ paths: schema: type: boolean default: false - - &716 + - &717 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -32503,7 +35033,7 @@ paths: type: boolean default: false - *236 - - &717 + - &718 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: @@ -33039,7 +35569,7 @@ paths: - url - subscription_url examples: - default: &718 + default: &719 value: - id: '1' repository: @@ -33811,7 +36341,7 @@ paths: type: array items: *160 examples: - default: &724 + default: &725 value: - property_name: environment value: production @@ -33861,7 +36391,7 @@ paths: required: - properties examples: - default: &725 + default: &726 value: properties: - property_name: environment @@ -34665,7 +37195,7 @@ paths: type: integer repository_cache_usages: type: array - items: &497 + items: &498 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -37971,7 +40501,7 @@ paths: description: Response content: application/json: - schema: &517 + schema: &518 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -38000,7 +40530,7 @@ paths: - key_id - key examples: - default: &518 + default: &519 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -38413,7 +40943,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-organization-variables parameters: - *89 - - &502 + - &503 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)." @@ -39179,6 +41709,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 @@ -39221,24 +41755,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 example: 1.2.3 @@ -39699,12 +42227,12 @@ paths: required: - subject_digests examples: - default: &860 + default: &861 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &861 + withPredicateType: &862 value: subject_digests: - sha256:abc123 @@ -39748,7 +42276,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &862 + default: &863 value: attestations_subject_digests: - sha256:abc: @@ -40081,7 +42609,7 @@ paths: initiator: type: string examples: - default: &531 + default: &532 value: attestations: - bundle: @@ -40998,7 +43526,7 @@ paths: be returned. in: query required: false - schema: &557 + schema: &558 type: string description: Severity of a code scanning alert. enum: @@ -42095,7 +44623,7 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &589 + properties: &590 name: type: string description: The name of the machine. @@ -42137,7 +44665,7 @@ paths: - ready - in_progress nullable: true - required: &590 + required: &591 - name - display_name - operating_system @@ -43005,7 +45533,7 @@ paths: - updated_at - visibility examples: - default: &591 + default: &592 value: total_count: 2 secrets: @@ -43043,7 +45571,7 @@ paths: description: Response content: application/json: - schema: &592 + schema: &593 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -43072,7 +45600,7 @@ paths: - key_id - key examples: - default: &593 + default: &594 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -43104,7 +45632,7 @@ paths: application/json: schema: *333 examples: - default: &595 + default: &596 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -47211,7 +49739,7 @@ paths: description: Response content: application/json: - schema: &626 + schema: &627 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -47228,7 +49756,7 @@ paths: - key_id - key examples: - default: &627 + default: &628 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -47554,7 +50082,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *89 - - &636 + - &637 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -47562,7 +50090,7 @@ paths: required: false schema: type: string - - &637 + - &638 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -47570,7 +50098,7 @@ paths: required: false schema: type: string - - &638 + - &639 name: time_period description: |- The time period to filter by. @@ -47586,7 +50114,7 @@ paths: - week - month default: month - - &639 + - &640 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -47611,7 +50139,7 @@ paths: application/json: schema: type: array - items: &640 + items: &641 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -47767,7 +50295,7 @@ paths: format: uri example: https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &641 + default: &642 value: - id: 21 number: 42 @@ -47869,7 +50397,7 @@ paths: application/json: schema: type: array - items: &642 + items: &643 title: Dependabot alert dismissal request description: Alert dismissal request made by a user asking to dismiss a Dependabot alert. @@ -47986,7 +50514,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/dependabot/1 examples: - default: &643 + default: &644 value: - id: 21 number: 42 @@ -48373,7 +50901,7 @@ paths: description: Response content: application/json: - schema: &481 + schema: &482 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -48454,7 +50982,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &482 + default: &483 value: group_id: '123' group_name: Octocat admins @@ -48509,7 +51037,7 @@ paths: description: Response content: application/json: - schema: &478 + schema: &479 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -48546,7 +51074,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &479 + default: &480 value: groups: - group_id: '123' @@ -50028,7 +52556,7 @@ paths: required: true content: application/json: - schema: &674 + schema: &675 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -51346,7 +53874,7 @@ paths: application/json: schema: *399 examples: - default: &588 + default: &589 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -52596,7 +55124,7 @@ paths: parameters: - *89 - *405 - - &842 + - &843 name: repo_name description: repo_name parameter in: path @@ -53517,7 +56045,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &468 + items: &469 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -53811,7 +56339,7 @@ paths: - nuget - container - *89 - - &843 + - &844 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -53852,7 +56380,7 @@ paths: default: *411 '403': *29 '401': *25 - '400': &845 + '400': &846 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -55167,6 +57695,7 @@ paths: - oidc_aws - oidc_jfrog - oidc_cloudsmith + - oidc_gcp type: string url: description: The URL of the private registry. @@ -55235,6 +57764,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 @@ -55272,7 +57810,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: @@ -55365,7 +57903,472 @@ 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. + example: MAVEN_REPOSITORY_SECRET + type: string + 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. + example: monalisa + type: string + 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: &425 + 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: + - *89 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - key_id + - key + properties: + key_id: + description: The identifier for the key. + example: '012345678912345678' + type: string + key: + description: The Base64 encoded public key. + example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + type: string + examples: + default: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + headers: + Link: *47 + '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: + - *89 + - *300 + responses: + '200': + description: The specified private registry configuration for the organization + content: + application/json: + schema: *424 + examples: + default: *425 + '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: + - *89 + - *300 + 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 + nullable: true + 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 @@ -55374,6 +58377,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`. @@ -55406,7 +58410,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` @@ -55424,440 +58428,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. - example: MAVEN_REPOSITORY_SECRET - type: string - 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. - example: monalisa - type: string - 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: &425 - 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: - - *89 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - key_id - - key - properties: - key_id: - description: The identifier for the key. - example: '012345678912345678' - type: string - key: - description: The Base64 encoded public key. - example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - type: string - examples: - default: - value: - key_id: '012345678912345678' - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - headers: - Link: *47 - '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: - - *89 - - *300 - responses: - '200': - description: The specified private registry configuration for the organization - content: - application/json: - schema: *424 - examples: - default: *425 - '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: - - *89 - - *300 - 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. + 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 - 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 - nullable: true - 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 - - 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: @@ -56009,7 +58588,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &938 + properties: &939 id: type: number description: The unique identifier of the status update. @@ -56057,7 +58636,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &939 + required: &940 - id - node_id - created_at @@ -56271,7 +58850,7 @@ paths: content: oneOf: - *229 - - &605 + - &606 title: Pull Request Simple description: Pull Request Simple type: object @@ -56486,7 +59065,7 @@ paths: - review_comment - self author_association: *226 - auto_merge: &727 + auto_merge: &728 title: Auto merge description: The status of auto merging a pull request. type: object @@ -56862,7 +59441,7 @@ paths: - updated_at - project_url examples: - default: &866 + default: &867 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -57039,7 +59618,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &867 + items: &868 type: object properties: name: @@ -57076,7 +59655,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &868 + iteration_configuration: &869 type: object description: The configuration for iteration fields. properties: @@ -57126,7 +59705,7 @@ paths: value: name: Due date data_type: date - single_select_field: &869 + single_select_field: &870 summary: Create a single select field value: name: Priority @@ -57153,7 +59732,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &870 + iteration_field: &871 summary: Create an iteration field value: name: Sprint @@ -57179,7 +59758,7 @@ paths: application/json: schema: *432 examples: - text_field: &871 + text_field: &872 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -57188,7 +59767,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: &872 + number_field: &873 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -57197,7 +59776,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: &873 + date_field: &874 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -57206,7 +59785,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: &874 + single_select_field: &875 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -57240,7 +59819,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &875 + iteration_field: &876 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -57286,7 +59865,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-organization parameters: - *428 - - &876 + - &877 name: field_id description: The unique identifier of the field. in: path @@ -57301,7 +59880,7 @@ paths: application/json: schema: *432 examples: - default: &877 + default: &878 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -58498,7 +61077,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &857 + schema: &858 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -58675,7 +61254,7 @@ paths: parameters: - *428 - *89 - - &878 + - &879 name: view_number description: The number that identifies the project view. in: path @@ -59441,7 +62020,7 @@ paths: description: Response content: application/json: - schema: &489 + schema: &490 title: Full Repository description: Full Repository type: object @@ -59839,7 +62418,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &610 + properties: &611 url: type: string format: uri @@ -59855,7 +62434,7 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &611 + required: &612 - url - key - name @@ -59944,7 +62523,7 @@ paths: - network_count - subscribers_count examples: - default: &491 + default: &492 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -60497,7 +63076,7 @@ paths: - *89 - *17 - *19 - - &749 + - &750 name: targets description: | A comma-separated list of rule targets to filter by. @@ -60713,7 +63292,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *89 - - &751 + - &752 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 @@ -60725,14 +63304,14 @@ paths: x-multi-segment: true - *316 - *107 - - &752 + - &753 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 - - &753 + - &754 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -60752,7 +63331,7 @@ paths: description: Response content: application/json: - schema: &754 + schema: &755 title: Rule Suites description: Response type: array @@ -60807,7 +63386,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &755 + default: &756 value: - id: 21 actor_id: 12 @@ -60851,7 +63430,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *89 - - &756 + - &757 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -60867,7 +63446,7 @@ paths: description: Response content: application/json: - schema: &757 + schema: &758 title: Rule Suite description: Response type: object @@ -60966,7 +63545,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &758 + default: &759 value: id: 21 actor_id: 12 @@ -61302,7 +63881,7 @@ paths: - *112 - *19 - *17 - - &760 + - &761 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 @@ -61312,7 +63891,7 @@ paths: required: false schema: type: string - - &761 + - &762 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 @@ -61326,6 +63905,7 @@ paths: - *460 - *461 - *462 + - *463 responses: '200': description: Response @@ -61333,9 +63913,9 @@ paths: application/json: schema: type: array - items: *463 + items: *464 examples: - default: *464 + default: *465 headers: Link: *47 '404': *6 @@ -61370,9 +63950,9 @@ paths: description: Response content: application/json: - schema: *465 + schema: *466 examples: - default: *466 + default: *467 '403': *29 '404': *6 patch: @@ -61525,7 +64105,7 @@ paths: application/json: schema: type: array - items: &782 + items: &783 description: A repository security advisory. type: object properties: @@ -61727,7 +64307,7 @@ paths: login: type: string description: The username of the user credited. - type: *467 + type: *468 credits_detailed: type: array nullable: true @@ -61737,7 +64317,7 @@ paths: type: object properties: user: *4 - type: *467 + type: *468 state: type: string description: The state of the user's acceptance of the @@ -61797,7 +64377,7 @@ paths: - private_fork additionalProperties: false examples: - default: &783 + default: &784 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -62184,7 +64764,7 @@ paths: application/json: schema: type: array - items: *468 + items: *469 examples: default: value: @@ -62283,7 +64863,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *89 - - *469 + - *470 - *17 - *19 responses: @@ -62291,9 +64871,9 @@ paths: description: Success content: application/json: - schema: *470 + schema: *471 examples: - default: *471 + default: *472 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -62574,7 +65154,7 @@ paths: type: array items: *153 examples: - default: *472 + default: *473 headers: Link: *47 x-github: @@ -62803,15 +65383,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: - *89 - - *473 + - *474 responses: '200': description: Response content: application/json: - schema: *474 + schema: *475 examples: - default: *475 + default: *476 headers: Link: *47 x-github: @@ -62849,7 +65429,7 @@ paths: description: Response content: application/json: - schema: &486 + schema: &487 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -62895,7 +65475,7 @@ paths: type: string nullable: true examples: - default: &487 + default: &488 value: groups: - group_id: '123' @@ -63107,7 +65687,7 @@ paths: description: Response content: application/json: - schema: &476 + schema: &477 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -63434,7 +66014,7 @@ paths: - repos_count - organization examples: - default: &477 + default: &478 value: id: 1 node_id: MDQ6VGVhbTE= @@ -63511,9 +66091,9 @@ paths: description: Response content: application/json: - schema: *476 + schema: *477 examples: - default: *477 + default: *478 '404': *6 x-github: githubCloudOnly: false @@ -63597,16 +66177,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *476 + schema: *477 examples: - default: *477 + default: *478 '201': description: Response content: application/json: - schema: *476 + schema: *477 examples: - default: *477 + default: *478 '404': *6 '422': *15 '403': *29 @@ -63636,7 +66216,7 @@ paths: responses: '204': description: Response - '422': &480 + '422': &481 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -63665,10 +66245,10 @@ paths: description: Response content: application/json: - schema: *478 + schema: *479 examples: - default: *479 - '422': *480 + default: *480 + '422': *481 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -63711,10 +66291,10 @@ paths: description: Response content: application/json: - schema: *481 + schema: *482 examples: - default: *482 - '422': *480 + default: *483 + '422': *481 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -63738,7 +66318,7 @@ paths: responses: '204': description: Response - '422': *480 + '422': *481 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -63775,7 +66355,7 @@ paths: default: *389 headers: Link: *47 - '422': *480 + '422': *481 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63857,7 +66437,7 @@ paths: description: Response content: application/json: - schema: &483 + schema: &484 title: Team Membership description: Team Membership type: object @@ -63884,7 +66464,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &824 + response-if-user-is-a-team-maintainer: &825 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -63947,9 +66527,9 @@ paths: description: Response content: application/json: - schema: *483 + schema: *484 examples: - response-if-users-membership-with-team-is-now-pending: &825 + response-if-users-membership-with-team-is-now-pending: &826 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -64056,14 +66636,14 @@ paths: parameters: - *89 - *222 - - *484 - *485 + - *486 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &826 + schema: &827 title: Team Repository description: A team's access to a repository. type: object @@ -64627,8 +67207,8 @@ paths: parameters: - *89 - *222 - - *484 - *485 + - *486 requestBody: required: false content: @@ -64675,8 +67255,8 @@ paths: parameters: - *89 - *222 - - *484 - *485 + - *486 responses: '204': description: Response @@ -64709,10 +67289,10 @@ paths: description: Response content: application/json: - schema: *486 + schema: *487 examples: - default: *487 - '422': *480 + default: *488 + '422': *481 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -64778,7 +67358,7 @@ paths: description: Response content: application/json: - schema: *486 + schema: *487 examples: default: value: @@ -64790,7 +67370,7 @@ paths: group_name: Octocat docs members group_description: The people who make your octoworld come to life. - '422': *480 + '422': *481 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -64824,7 +67404,7 @@ paths: type: array items: *319 examples: - response-if-child-teams-exist: &827 + response-if-child-teams-exist: &828 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -64978,7 +67558,7 @@ paths: resources: type: object properties: - core: &488 + core: &489 title: Rate Limit type: object properties: @@ -64995,17 +67575,17 @@ paths: - remaining - reset - used - graphql: *488 - search: *488 - code_search: *488 - source_import: *488 - integration_manifest: *488 - code_scanning_upload: *488 - actions_runner_registration: *488 - scim: *488 - dependency_snapshots: *488 - dependency_sbom: *488 - code_scanning_autofix: *488 + graphql: *489 + search: *489 + code_search: *489 + source_import: *489 + integration_manifest: *489 + code_scanning_upload: *489 + actions_runner_registration: *489 + scim: *489 + dependency_snapshots: *489 + dependency_sbom: *489 + code_scanning_autofix: *489 required: - core - search @@ -65107,14 +67687,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository parameters: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: *489 + schema: *490 examples: default-response: summary: Default response @@ -65622,7 +68202,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *490 + '301': *491 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65640,8 +68220,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#update-a-repository parameters: - - *484 - *485 + - *486 requestBody: required: false content: @@ -65949,10 +68529,10 @@ paths: description: Response content: application/json: - schema: *489 + schema: *490 examples: - default: *491 - '307': &492 + default: *492 + '307': &493 description: Temporary Redirect content: application/json: @@ -65981,8 +68561,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#delete-a-repository parameters: - - *484 - *485 + - *486 responses: '204': description: Response @@ -66004,7 +68584,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': *492 + '307': *493 '404': *6 '409': *121 x-github: @@ -66028,11 +68608,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *484 - *485 + - *486 - *17 - *19 - - &509 + - &510 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -66055,7 +68635,7 @@ paths: type: integer artifacts: type: array - items: &493 + items: &494 title: Artifact description: An artifact type: object @@ -66133,7 +68713,7 @@ paths: - expires_at - updated_at examples: - default: &510 + default: &511 value: total_count: 2 artifacts: @@ -66194,9 +68774,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#get-an-artifact parameters: - - *484 - *485 - - &494 + - *486 + - &495 name: artifact_id description: The unique identifier of the artifact. in: path @@ -66208,7 +68788,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *494 examples: default: value: @@ -66246,9 +68826,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#delete-an-artifact parameters: - - *484 - *485 - - *494 + - *486 + - *495 responses: '204': description: Response @@ -66272,9 +68852,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#download-an-artifact parameters: - - *484 - *485 - - *494 + - *486 + - *495 - name: archive_format in: path required: true @@ -66284,11 +68864,11 @@ paths: '302': description: Response headers: - Location: &629 + Location: &630 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': &677 + '410': &678 description: Gone content: application/json: @@ -66313,14 +68893,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: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: &495 + schema: &496 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -66353,13 +68933,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: - - *484 - *485 + - *486 requestBody: required: true content: application/json: - schema: *495 + schema: *496 examples: selected_actions: *44 responses: @@ -66388,14 +68968,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: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: &496 + schema: &497 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -66428,13 +69008,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: - - *484 - *485 + - *486 requestBody: required: true content: application/json: - schema: *496 + schema: *497 examples: selected_actions: *46 responses: @@ -66465,14 +69045,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: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: *497 + schema: *498 examples: default: value: @@ -66498,11 +69078,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: - - *484 - *485 + - *486 - *17 - *19 - - &498 + - &499 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 @@ -66536,7 +69116,7 @@ paths: description: Response content: application/json: - schema: &499 + schema: &500 title: Repository actions caches description: Repository actions caches type: object @@ -66578,7 +69158,7 @@ paths: - total_count - actions_caches examples: - default: &500 + default: &501 value: total_count: 1 actions_caches: @@ -66610,23 +69190,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: - - *484 - *485 + - *486 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *498 + - *499 responses: '200': description: Response content: application/json: - schema: *499 + schema: *500 examples: - default: *500 + default: *501 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66646,8 +69226,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: - - *484 - *485 + - *486 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -66662,6 +69242,240 @@ 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: + - *485 + - *486 + - *17 + - *111 + 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 + format: date-time + nullable: true + 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: *47 + '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: + - *485 + - *486 + - 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 + format: uri + description: API URL for the workflow run. + nullable: true + run_html_url: + type: string + format: uri + description: Web URL for the workflow run. + nullable: true + 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 + format: uri + description: API URL for the job. + nullable: true + job_html_url: + type: string + format: uri + description: Web URL for the job. + nullable: true + 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 @@ -66678,9 +69492,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: - - *484 - *485 - - &501 + - *486 + - &502 name: job_id description: The unique identifier of the job. in: path @@ -66692,7 +69506,7 @@ paths: description: Response content: application/json: - schema: &513 + schema: &514 title: Job description: Information of a job execution in a workflow run type: object @@ -66999,9 +69813,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: - - *484 - *485 - - *501 + - *486 + - *502 responses: '302': description: Response @@ -67029,9 +69843,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: - - *484 - *485 - - *501 + - *486 + - *502 requestBody: required: false content: @@ -67076,8 +69890,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: - - *484 - *485 + - *486 responses: '200': description: Status response @@ -67136,8 +69950,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -67205,8 +70019,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-organization-secrets parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -67224,7 +70038,7 @@ paths: type: integer secrets: type: array - items: &515 + items: &516 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -67244,7 +70058,7 @@ paths: - created_at - updated_at examples: - default: &516 + default: &517 value: total_count: 2 secrets: @@ -67277,9 +70091,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-organization-variables parameters: - - *484 - *485 - - *502 + - *486 + - *503 - *19 responses: '200': @@ -67296,7 +70110,7 @@ paths: type: integer variables: type: array - items: &519 + items: &520 title: Actions Variable type: object properties: @@ -67326,7 +70140,7 @@ paths: - created_at - updated_at examples: - default: &520 + default: &521 value: total_count: 2 variables: @@ -67359,8 +70173,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -67369,7 +70183,7 @@ paths: schema: type: object properties: - enabled: &503 + enabled: &504 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *62 @@ -67404,8 +70218,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: - - *484 - *485 + - *486 responses: '204': description: Response @@ -67416,7 +70230,7 @@ paths: schema: type: object properties: - enabled: *503 + enabled: *504 allowed_actions: *62 sha_pinning_required: *63 required: @@ -67449,14 +70263,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: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: &504 + schema: &505 type: object properties: access_level: @@ -67474,7 +70288,7 @@ paths: required: - access_level examples: - default: &505 + default: &506 value: access_level: organization x-github: @@ -67499,15 +70313,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: - - *484 - *485 + - *486 requestBody: required: true content: application/json: - schema: *504 + schema: *505 examples: - default: *505 + default: *506 responses: '204': description: Response @@ -67531,8 +70345,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -67562,8 +70376,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: - - *484 - *485 + - *486 responses: '204': description: Empty response for successful settings update @@ -67597,8 +70411,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -67625,8 +70439,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: - - *484 - *485 + - *486 responses: '204': description: Response @@ -67660,8 +70474,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -67689,8 +70503,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -67721,8 +70535,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -67753,8 +70567,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: - - *484 - *485 + - *486 responses: '204': description: Response @@ -67786,8 +70600,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -67816,8 +70630,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: - - *484 - *485 + - *486 responses: '204': description: Success response @@ -67857,8 +70671,8 @@ paths: in: query schema: type: string - - *484 - *485 + - *486 - *17 - *19 responses: @@ -67902,8 +70716,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -67935,8 +70749,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -68010,8 +70824,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: - - *484 - *485 + - *486 responses: '201': description: Response @@ -68047,8 +70861,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: - - *484 - *485 + - *486 responses: '201': description: Response @@ -68078,8 +70892,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: - - *484 - *485 + - *486 - *77 responses: '200': @@ -68109,8 +70923,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: - - *484 - *485 + - *486 - *77 responses: '204': @@ -68137,8 +70951,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: - - *484 - *485 + - *486 - *77 responses: '200': *83 @@ -68163,8 +70977,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: - - *484 - *485 + - *486 - *77 requestBody: required: true @@ -68213,8 +71027,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: - - *484 - *485 + - *486 - *77 requestBody: required: true @@ -68264,8 +71078,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: - - *484 - *485 + - *486 - *77 responses: '200': *297 @@ -68295,8 +71109,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: - - *484 - *485 + - *486 - *77 - *298 responses: @@ -68326,9 +71140,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: - - *484 - *485 - - &523 + - *486 + - &524 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. @@ -68336,7 +71150,7 @@ paths: required: false schema: type: string - - &524 + - &525 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -68344,7 +71158,7 @@ paths: required: false schema: type: string - - &525 + - &526 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -68353,7 +71167,7 @@ paths: required: false schema: type: string - - &526 + - &527 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 @@ -68380,7 +71194,7 @@ paths: - pending - *17 - *19 - - &527 + - &528 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)." @@ -68389,7 +71203,7 @@ paths: schema: type: string format: date-time - - &506 + - &507 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -68398,13 +71212,13 @@ paths: schema: type: boolean default: false - - &528 + - &529 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &529 + - &530 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -68427,7 +71241,7 @@ paths: type: integer workflow_runs: type: array - items: &507 + items: &508 title: Workflow Run description: An invocation of a workflow type: object @@ -68575,7 +71389,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &551 + properties: &552 id: type: string description: SHA for the commit @@ -68626,7 +71440,7 @@ paths: - name - email nullable: true - required: &552 + required: &553 - id - tree_id - message @@ -68673,7 +71487,7 @@ paths: - workflow_url - pull_requests examples: - default: &530 + default: &531 value: total_count: 1 workflow_runs: @@ -68909,24 +71723,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *484 - *485 - - &508 + - *486 + - &509 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *506 + - *507 responses: '200': description: Response content: application/json: - schema: *507 + schema: *508 examples: - default: &511 + default: &512 value: id: 30433642 name: Build @@ -69167,9 +71981,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *484 - *485 - - *508 + - *486 + - *509 responses: '204': description: Response @@ -69192,9 +72006,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: - - *484 - *485 - - *508 + - *486 + - *509 responses: '200': description: Response @@ -69313,9 +72127,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: - - *484 - *485 - - *508 + - *486 + - *509 responses: '201': description: Response @@ -69348,12 +72162,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *484 - *485 - - *508 + - *486 + - *509 - *17 - *19 - - *509 + - *510 - *112 responses: '200': @@ -69370,9 +72184,9 @@ paths: type: integer artifacts: type: array - items: *493 + items: *494 examples: - default: *510 + default: *511 headers: Link: *47 x-github: @@ -69396,25 +72210,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *484 - *485 - - *508 - - &512 + - *486 + - *509 + - &513 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *506 + - *507 responses: '200': description: Response content: application/json: - schema: *507 + schema: *508 examples: - default: *511 + default: *512 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69437,10 +72251,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: - - *484 - *485 - - *508 - - *512 + - *486 + - *509 + - *513 - *17 - *19 responses: @@ -69458,9 +72272,9 @@ paths: type: integer jobs: type: array - items: *513 + items: *514 examples: - default: &514 + default: &515 value: total_count: 1 jobs: @@ -69573,10 +72387,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *484 - *485 - - *508 - - *512 + - *486 + - *509 + - *513 responses: '302': description: Response @@ -69604,9 +72418,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *484 - *485 - - *508 + - *486 + - *509 responses: '202': description: Response @@ -69622,6 +72436,192 @@ 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: + - *485 + - *486 + - *509 + - *17 + - *110 + - *111 + 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 + format: uri + description: API URL for the workflow run. + nullable: true + run_html_url: + type: string + format: uri + description: Web URL for the workflow run. + nullable: true + 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 + description: The ID of the job, when the item represents + a job-level or reusable-workflow-level lease. + nullable: true + job_name: + type: string + description: The display name of the job, when the + item represents a job-level or reusable-workflow-level + lease. + nullable: true + job_url: + type: string + format: uri + description: API URL for the job. + nullable: true + job_html_url: + type: string + format: uri + description: Web URL for the job. + nullable: true + 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: *47 + '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 @@ -69639,9 +72639,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: - - *484 - *485 - - *508 + - *486 + - *509 requestBody: required: true content: @@ -69708,9 +72708,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *484 - *485 - - *508 + - *486 + - *509 responses: '202': description: Response @@ -69743,9 +72743,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: - - *484 - *485 - - *508 + - *486 + - *509 - 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 @@ -69775,9 +72775,9 @@ paths: type: integer jobs: type: array - items: *513 + items: *514 examples: - default: *514 + default: *515 headers: Link: *47 x-github: @@ -69802,9 +72802,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *484 - *485 - - *508 + - *486 + - *509 responses: '302': description: Response @@ -69831,9 +72831,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *484 - *485 - - *508 + - *486 + - *509 responses: '204': description: Response @@ -69860,9 +72860,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: - - *484 - *485 - - *508 + - *486 + - *509 responses: '200': description: Response @@ -69922,7 +72922,7 @@ paths: items: type: object properties: - type: &644 + type: &645 type: string description: The type of reviewer. enum: @@ -70007,9 +73007,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: - - *484 - *485 - - *508 + - *486 + - *509 requestBody: required: true content: @@ -70056,12 +73056,12 @@ paths: application/json: schema: type: array - items: &631 + items: &632 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &896 + properties: &897 url: type: string format: uri @@ -70146,7 +73146,7 @@ paths: nullable: true properties: *224 required: *225 - required: &897 + required: &898 - id - node_id - sha @@ -70162,7 +73162,7 @@ paths: - created_at - updated_at examples: - default: &632 + default: &633 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -70218,9 +73218,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *484 - *485 - - *508 + - *486 + - *509 requestBody: required: false content: @@ -70264,9 +73264,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: - - *484 - *485 - - *508 + - *486 + - *509 requestBody: required: false content: @@ -70320,9 +73320,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *484 - *485 - - *508 + - *486 + - *509 responses: '200': description: Response @@ -70459,8 +73459,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-repository-secrets parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -70478,9 +73478,9 @@ paths: type: integer secrets: type: array - items: *515 + items: *516 examples: - default: *516 + default: *517 headers: Link: *47 x-github: @@ -70505,16 +73505,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-public-key parameters: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: *517 + schema: *518 examples: - default: *518 + default: *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70536,17 +73536,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-a-repository-secret parameters: - - *484 - *485 + - *486 - *300 responses: '200': description: Response content: application/json: - schema: *515 + schema: *516 examples: - default: &657 + default: &658 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -70572,8 +73572,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *484 - *485 + - *486 - *300 requestBody: required: true @@ -70631,8 +73631,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-a-repository-secret parameters: - - *484 - *485 + - *486 - *300 responses: '204': @@ -70658,9 +73658,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-repository-variables parameters: - - *484 - *485 - - *502 + - *486 + - *503 - *19 responses: '200': @@ -70677,9 +73677,9 @@ paths: type: integer variables: type: array - items: *519 + items: *520 examples: - default: *520 + default: *521 headers: Link: *47 x-github: @@ -70702,8 +73702,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-a-repository-variable parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -70755,17 +73755,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-a-repository-variable parameters: - - *484 - *485 + - *486 - *303 responses: '200': description: Response content: application/json: - schema: *519 + schema: *520 examples: - default: &658 + default: &659 value: name: USERNAME value: octocat @@ -70791,8 +73791,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-a-repository-variable parameters: - - *484 - *485 + - *486 - *303 requestBody: required: true @@ -70835,8 +73835,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-a-repository-variable parameters: - - *484 - *485 + - *486 - *303 responses: '204': @@ -70862,8 +73862,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#list-repository-workflows parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -70881,7 +73881,7 @@ paths: type: integer workflows: type: array - items: &521 + items: &522 title: Workflow description: A GitHub Actions workflow type: object @@ -70988,9 +73988,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-a-workflow parameters: - - *484 - *485 - - &522 + - *486 + - &523 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -71005,7 +74005,7 @@ paths: description: Response content: application/json: - schema: *521 + schema: *522 examples: default: value: @@ -71038,9 +74038,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#disable-a-workflow parameters: - - *484 - *485 - - *522 + - *486 + - *523 responses: '204': description: Response @@ -71065,9 +74065,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *484 - *485 - - *522 + - *486 + - *523 responses: '200': description: Response including the workflow run ID and URLs. @@ -71147,9 +74147,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#enable-a-workflow parameters: - - *484 - *485 - - *522 + - *486 + - *523 responses: '204': description: Response @@ -71176,19 +74176,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: - - *484 - *485 - - *522 + - *486 - *523 - *524 - *525 - *526 + - *527 - *17 - *19 - - *527 - - *506 - *528 + - *507 - *529 + - *530 responses: '200': description: Response @@ -71204,9 +74204,9 @@ paths: type: integer workflow_runs: type: array - items: *507 + items: *508 examples: - default: *530 + default: *531 headers: Link: *47 x-github: @@ -71239,9 +74239,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/workflows#get-workflow-usage parameters: - - *484 - *485 - - *522 + - *486 + - *523 responses: '200': description: Response @@ -71302,8 +74302,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-activities parameters: - - *484 - *485 + - *486 - *112 - *17 - *110 @@ -71467,8 +74467,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#list-assignees parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -71505,8 +74505,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: - - *484 - *485 + - *486 - name: assignee in: path required: true @@ -71542,8 +74542,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#create-an-attestation parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -71653,8 +74653,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/attestations#list-attestations parameters: - - *484 - *485 + - *486 - *17 - *110 - *111 @@ -71695,7 +74695,7 @@ paths: initiator: type: string examples: - default: *531 + default: *532 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71715,8 +74715,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *484 - *485 + - *486 responses: '200': description: Response @@ -71724,7 +74724,7 @@ paths: application/json: schema: type: array - items: &532 + items: &533 title: Autolink reference description: An autolink reference. type: object @@ -71778,8 +74778,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -71818,9 +74818,9 @@ paths: description: response content: application/json: - schema: *532 + schema: *533 examples: - default: &533 + default: &534 value: id: 1 key_prefix: TICKET- @@ -71851,9 +74851,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: - - *484 - *485 - - &534 + - *486 + - &535 name: autolink_id description: The unique identifier of the autolink. in: path @@ -71865,9 +74865,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *533 examples: - default: *533 + default: *534 '404': *6 x-github: githubCloudOnly: false @@ -71887,9 +74887,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: - - *484 - *485 - - *534 + - *486 + - *535 responses: '204': description: Response @@ -71913,8 +74913,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: - - *484 - *485 + - *486 responses: '200': description: Response if Dependabot is enabled @@ -71962,8 +74962,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-dependabot-security-updates parameters: - - *484 - *485 + - *486 responses: '204': description: Response @@ -71984,8 +74984,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-dependabot-security-updates parameters: - - *484 - *485 + - *486 responses: '204': description: Response @@ -72005,8 +75005,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#list-branches parameters: - - *484 - *485 + - *486 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -72044,7 +75044,7 @@ paths: - url protected: type: boolean - protection: &536 + protection: &537 title: Branch Protection description: Branch Protection type: object @@ -72086,7 +75086,7 @@ paths: required: - contexts - checks - enforce_admins: &539 + enforce_admins: &540 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -72101,7 +75101,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &541 + required_pull_request_reviews: &542 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -72177,7 +75177,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &538 + restrictions: &539 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -72454,9 +75454,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#get-a-branch parameters: - - *484 - *485 - - &537 + - *486 + - &538 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). @@ -72470,14 +75470,14 @@ paths: description: Response content: application/json: - schema: &547 + schema: &548 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &601 + commit: &602 title: Commit description: Commit type: object @@ -72511,7 +75511,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &535 + properties: &536 name: type: string example: '"Chris Wanstrath"' @@ -72527,7 +75527,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *535 + properties: *536 nullable: true message: type: string @@ -72548,7 +75548,7 @@ paths: required: - sha - url - verification: &664 + verification: &665 title: Verification type: object properties: @@ -72618,7 +75618,7 @@ paths: type: integer files: type: array - items: &614 + items: &615 title: Diff Entry description: Diff Entry type: object @@ -72702,7 +75702,7 @@ paths: - self protected: type: boolean - protection: *536 + protection: *537 protection_url: type: string format: uri @@ -72809,7 +75809,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *490 + '301': *491 '404': *6 x-github: githubCloudOnly: false @@ -72831,15 +75831,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-branch-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response content: application/json: - schema: *536 + schema: *537 examples: default: value: @@ -73033,9 +76033,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-branch-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: true content: @@ -73290,7 +76290,7 @@ paths: url: type: string format: uri - required_status_checks: &544 + required_status_checks: &545 title: Status Check Policy description: Status Check Policy type: object @@ -73442,7 +76442,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *538 + restrictions: *539 required_conversation_resolution: type: object properties: @@ -73554,9 +76554,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-branch-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '204': description: Response @@ -73581,17 +76581,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response content: application/json: - schema: *539 + schema: *540 examples: - default: &540 + default: &541 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -73613,17 +76613,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response content: application/json: - schema: *539 + schema: *540 examples: - default: *540 + default: *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73642,9 +76642,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '204': description: Response @@ -73669,17 +76669,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response content: application/json: - schema: *541 + schema: *542 examples: - default: &542 + default: &543 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -73775,9 +76775,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: false content: @@ -73875,9 +76875,9 @@ paths: description: Response content: application/json: - schema: *541 + schema: *542 examples: - default: *542 + default: *543 '422': *15 x-github: githubCloudOnly: false @@ -73898,9 +76898,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '204': description: Response @@ -73927,17 +76927,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response content: application/json: - schema: *539 + schema: *540 examples: - default: &543 + default: &544 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -73960,17 +76960,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response content: application/json: - schema: *539 + schema: *540 examples: - default: *543 + default: *544 '404': *6 x-github: githubCloudOnly: false @@ -73990,9 +76990,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '204': description: Response @@ -74017,17 +77017,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-status-checks-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response content: application/json: - schema: *544 + schema: *545 examples: - default: &545 + default: &546 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -74053,9 +77053,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#update-status-check-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: false content: @@ -74107,9 +77107,9 @@ paths: description: Response content: application/json: - schema: *544 + schema: *545 examples: - default: *545 + default: *546 '404': *6 '422': *15 x-github: @@ -74131,9 +77131,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-protection parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '204': description: Response @@ -74157,9 +77157,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response @@ -74193,9 +77193,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-status-check-contexts parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: false content: @@ -74262,9 +77262,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-status-check-contexts parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: false content: @@ -74328,9 +77328,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: content: application/json: @@ -74396,15 +77396,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#get-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response content: application/json: - schema: *538 + schema: *539 examples: default: value: @@ -74495,9 +77495,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#delete-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 responses: '204': description: Response @@ -74520,9 +77520,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: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response @@ -74532,7 +77532,7 @@ paths: type: array items: *5 examples: - default: &546 + default: &547 value: - id: 1 slug: octoapp @@ -74589,9 +77589,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: true content: @@ -74625,7 +77625,7 @@ paths: type: array items: *5 examples: - default: *546 + default: *547 '422': *15 x-github: githubCloudOnly: false @@ -74646,9 +77646,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: true content: @@ -74682,7 +77682,7 @@ paths: type: array items: *5 examples: - default: *546 + default: *547 '422': *15 x-github: githubCloudOnly: false @@ -74703,9 +77703,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: true content: @@ -74739,7 +77739,7 @@ paths: type: array items: *5 examples: - default: *546 + default: *547 '422': *15 x-github: githubCloudOnly: false @@ -74761,9 +77761,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: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response @@ -74793,9 +77793,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: false content: @@ -74854,9 +77854,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: false content: @@ -74915,9 +77915,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: content: application/json: @@ -74976,9 +77976,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: - - *484 - *485 - - *537 + - *486 + - *538 responses: '200': description: Response @@ -75012,9 +78012,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: true content: @@ -75072,9 +78072,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: true content: @@ -75132,9 +78132,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: true content: @@ -75194,9 +78194,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#rename-a-branch parameters: - - *484 - *485 - - *537 + - *486 + - *538 requestBody: required: true content: @@ -75218,7 +78218,7 @@ paths: description: Response content: application/json: - schema: *547 + schema: *548 examples: default: value: @@ -75332,8 +78332,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *484 - *485 + - *486 - *105 - *106 - *107 @@ -75369,8 +78369,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *484 - *485 + - *486 - name: bypass_request_number in: path required: true @@ -75443,8 +78443,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *484 - *485 + - *486 - *105 - *106 - *107 @@ -75484,8 +78484,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *484 - *485 + - *486 - name: bypass_request_number in: path required: true @@ -75555,8 +78555,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *484 - *485 + - *486 - name: bypass_request_number in: path required: true @@ -75627,8 +78627,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *484 - *485 + - *486 - name: bypass_response_id in: path required: true @@ -75661,8 +78661,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#create-a-check-run parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -75941,7 +78941,7 @@ paths: description: Response content: application/json: - schema: &548 + schema: &549 title: CheckRun description: A check performed on the code of a given code change type: object @@ -76061,7 +79061,7 @@ paths: check. type: array items: *234 - deployment: &889 + deployment: &890 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -76341,9 +79341,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#get-a-check-run parameters: - - *484 - *485 - - &549 + - *486 + - &550 name: check_run_id description: The unique identifier of the check run. in: path @@ -76355,9 +79355,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *549 examples: - default: &550 + default: &551 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -76457,9 +79457,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#update-a-check-run parameters: - - *484 - *485 - - *549 + - *486 + - *550 requestBody: required: true content: @@ -76699,9 +79699,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *549 examples: - default: *550 + default: *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76721,9 +79721,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#list-check-run-annotations parameters: - - *484 - *485 - - *549 + - *486 + - *550 - *17 - *19 responses: @@ -76818,9 +79818,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#rerequest-a-check-run parameters: - - *484 - *485 - - *549 + - *486 + - *550 responses: '201': description: Response @@ -76864,8 +79864,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -76887,7 +79887,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &553 + schema: &554 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -76973,12 +79973,12 @@ paths: type: string format: date-time nullable: true - head_commit: &922 + head_commit: &923 title: Simple Commit description: A commit. type: object - properties: *551 - required: *552 + properties: *552 + required: *553 latest_check_runs_count: type: integer check_runs_url: @@ -77006,7 +80006,7 @@ paths: - check_runs_url - pull_requests examples: - default: &554 + default: &555 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -77297,9 +80297,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *553 + schema: *554 examples: - default: *554 + default: *555 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77318,8 +80318,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -77628,9 +80628,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite parameters: - - *484 - *485 - - &555 + - *486 + - &556 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -77642,9 +80642,9 @@ paths: description: Response content: application/json: - schema: *553 + schema: *554 examples: - default: *554 + default: *555 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77667,17 +80667,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: - - *484 - *485 - - *555 - - &607 + - *486 + - *556 + - &608 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &608 + - &609 name: status description: Returns check runs with the specified `status`. in: query @@ -77716,9 +80716,9 @@ paths: type: integer check_runs: type: array - items: *548 + items: *549 examples: - default: &609 + default: &610 value: total_count: 1 check_runs: @@ -77820,9 +80820,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#rerequest-a-check-suite parameters: - - *484 - *485 - - *555 + - *486 + - *556 responses: '201': description: Response @@ -77855,21 +80855,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: - - *484 - *485 + - *486 - *323 - *324 - *19 - *17 - - &571 + - &572 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: *556 - - &572 + schema: *557 + - &573 name: pr description: The number of the pull request for the results you want to list. in: query @@ -77900,7 +80900,7 @@ paths: be returned. in: query required: false - schema: *557 + schema: *558 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -77924,7 +80924,7 @@ paths: updated_at: *139 url: *136 html_url: *137 - instances_url: *558 + instances_url: *559 state: *115 fixed_at: *141 dismissed_by: @@ -77935,11 +80935,11 @@ paths: required: *21 nullable: true dismissed_at: *140 - dismissed_reason: *559 - dismissed_comment: *560 - rule: *561 - tool: *562 - most_recent_instance: *563 + dismissed_reason: *560 + dismissed_comment: *561 + rule: *562 + tool: *563 + most_recent_instance: *564 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -78065,7 +81065,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &564 + '403': &565 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -78092,9 +81092,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: - - *484 - *485 - - &565 + - *486 + - &566 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -78108,7 +81108,7 @@ paths: description: Response content: application/json: - schema: &566 + schema: &567 type: object properties: number: *131 @@ -78116,7 +81116,7 @@ paths: updated_at: *139 url: *136 html_url: *137 - instances_url: *558 + instances_url: *559 state: *115 fixed_at: *141 dismissed_by: @@ -78127,8 +81127,8 @@ paths: required: *21 nullable: true dismissed_at: *140 - dismissed_reason: *559 - dismissed_comment: *560 + dismissed_reason: *560 + dismissed_comment: *561 rule: type: object properties: @@ -78182,8 +81182,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *562 - most_recent_instance: *563 + tool: *563 + most_recent_instance: *564 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -78282,7 +81282,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *564 + '403': *565 '404': *6 '503': *200 x-github: @@ -78302,9 +81302,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: - - *484 - *485 - - *565 + - *486 + - *566 requestBody: required: true content: @@ -78319,8 +81319,8 @@ paths: enum: - open - dismissed - dismissed_reason: *559 - dismissed_comment: *560 + dismissed_reason: *560 + dismissed_comment: *561 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -78348,7 +81348,7 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: default: value: @@ -78424,7 +81424,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &570 + '403': &571 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -78451,15 +81451,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: - - *484 - *485 - - *565 + - *486 + - *566 responses: '200': description: Response content: application/json: - schema: &567 + schema: &568 type: object properties: status: @@ -78485,13 +81485,13 @@ paths: - description - started_at examples: - default: &568 + default: &569 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &569 + '400': &570 description: Bad Request content: application/json: @@ -78502,7 +81502,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': *564 + '403': *565 '404': *6 '503': *200 x-github: @@ -78527,29 +81527,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: - - *484 - *485 - - *565 + - *486 + - *566 responses: '200': description: OK content: application/json: - schema: *567 + schema: *568 examples: - default: *568 + default: *569 '202': description: Accepted content: application/json: - schema: *567 + schema: *568 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *569 + '400': *570 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -78581,9 +81581,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: - - *484 - *485 - - *565 + - *486 + - *566 requestBody: required: false content: @@ -78628,8 +81628,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *569 - '403': *570 + '400': *570 + '403': *571 '404': *6 '422': description: Unprocessable Entity @@ -78653,13 +81653,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: - - *484 - *485 - - *565 + - *486 + - *566 - *19 - *17 - - *571 - *572 + - *573 responses: '200': description: Response @@ -78670,10 +81670,10 @@ paths: items: type: object properties: - ref: *556 - analysis_key: *573 - environment: *574 - category: *575 + ref: *557 + analysis_key: *574 + environment: *575 + category: *576 state: type: string description: State of a code scanning alert instance. @@ -78688,7 +81688,7 @@ paths: properties: text: type: string - location: *576 + location: *577 html_url: type: string classifications: @@ -78696,7 +81696,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: *577 + items: *578 examples: default: value: @@ -78733,7 +81733,7 @@ paths: end_column: 50 classifications: - source - '403': *564 + '403': *565 '404': *6 '503': *200 x-github: @@ -78767,25 +81767,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: - - *484 - *485 + - *486 - *323 - *324 - *19 - *17 - - *572 + - *573 - 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: *556 + schema: *557 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &578 + schema: &579 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -78806,23 +81806,23 @@ paths: application/json: schema: type: array - items: &579 + items: &580 type: object properties: - ref: *556 - commit_sha: &587 + ref: *557 + commit_sha: &588 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: *573 + analysis_key: *574 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *575 + category: *576 error: type: string example: error reading field xyz @@ -78846,8 +81846,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *578 - tool: *562 + sarif_id: *579 + tool: *563 deletable: type: boolean warning: @@ -78908,7 +81908,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *564 + '403': *565 '404': *6 '503': *200 x-github: @@ -78944,8 +81944,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: - - *484 - *485 + - *486 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -78958,7 +81958,7 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: response: summary: application/json response @@ -79012,7 +82012,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *564 + '403': *565 '404': *6 '422': description: Response if analysis could not be processed @@ -79099,8 +82099,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: - - *484 - *485 + - *486 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -79153,7 +82153,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': *570 + '403': *571 '404': *6 '503': *200 x-github: @@ -79175,8 +82175,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -79184,7 +82184,7 @@ paths: application/json: schema: type: array - items: &580 + items: &581 title: CodeQL Database description: A CodeQL database. type: object @@ -79295,7 +82295,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': *564 + '403': *565 '404': *6 '503': *200 x-github: @@ -79324,8 +82324,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: - - *484 - *485 + - *486 - name: language in: path description: The language of the CodeQL database. @@ -79337,7 +82337,7 @@ paths: description: Response content: application/json: - schema: *580 + schema: *581 examples: default: value: @@ -79369,9 +82369,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': &618 + '302': &619 description: Found - '403': *564 + '403': *565 '404': *6 '503': *200 x-github: @@ -79393,8 +82393,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *484 - *485 + - *486 - name: language in: path description: The language of the CodeQL database. @@ -79404,7 +82404,7 @@ paths: responses: '204': description: Response - '403': *570 + '403': *571 '404': *6 '503': *200 x-github: @@ -79432,8 +82432,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -79442,7 +82442,7 @@ paths: type: object additionalProperties: false properties: - language: &581 + language: &582 type: string description: The language targeted by the CodeQL query enum: @@ -79522,7 +82522,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &585 + schema: &586 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -79532,7 +82532,7 @@ paths: description: The ID of the variant analysis. controller_repo: *122 actor: *4 - query_language: *581 + query_language: *582 query_pack_url: type: string description: The download url for the query pack. @@ -79579,7 +82579,7 @@ paths: items: type: object properties: - repository: &582 + repository: &583 title: Repository Identifier description: Repository Identifier type: object @@ -79615,7 +82615,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &586 + analysis_status: &587 type: string description: The new status of the CodeQL variant analysis repository task. @@ -79647,7 +82647,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &583 + access_mismatch_repos: &584 type: object properties: repository_count: @@ -79661,7 +82661,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: *582 + items: *583 required: - repository_count - repositories @@ -79683,8 +82683,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *583 - over_limit_repos: *583 + no_codeql_db_repos: *584 + over_limit_repos: *584 required: - access_mismatch_repos - not_found_repos @@ -79700,7 +82700,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &584 + value: &585 summary: Default response value: id: 1 @@ -79846,10 +82846,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *584 + value: *585 repository_lists: summary: Response for a successful variant analysis submission - value: *584 + value: *585 '404': *6 '422': description: Unable to process variant analysis submission @@ -79877,8 +82877,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: - - *484 - *485 + - *486 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -79890,9 +82890,9 @@ paths: description: Response content: application/json: - schema: *585 + schema: *586 examples: - default: *584 + default: *585 '404': *6 '503': *200 x-github: @@ -79915,7 +82915,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: - - *484 + - *485 - name: repo in: path description: The name of the controller repository. @@ -79950,7 +82950,7 @@ paths: type: object properties: repository: *122 - analysis_status: *586 + analysis_status: *587 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -80075,8 +83075,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -80159,7 +83159,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *564 + '403': *565 '404': *6 '503': *200 x-github: @@ -80180,8 +83180,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -80273,7 +83273,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *570 + '403': *571 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -80344,8 +83344,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -80353,7 +83353,7 @@ paths: schema: type: object properties: - commit_sha: *587 + commit_sha: *588 ref: type: string description: |- @@ -80411,7 +83411,7 @@ paths: schema: type: object properties: - id: *578 + id: *579 url: type: string description: The REST API URL for checking the status of the upload. @@ -80425,7 +83425,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': *570 + '403': *571 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -80448,8 +83448,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: - - *484 - *485 + - *486 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -80495,7 +83495,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': *564 + '403': *565 '404': description: Not Found if the sarif id does not match any upload '503': *200 @@ -80520,8 +83520,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -80602,8 +83602,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-codeowners-errors parameters: - - *484 - *485 + - *486 - 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 @@ -80723,8 +83723,8 @@ paths: parameters: - *17 - *19 - - *484 - *485 + - *486 responses: '200': description: Response @@ -81038,8 +84038,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -81104,7 +84104,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -81112,7 +84112,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '400': *14 '401': *25 '403': *29 @@ -81141,8 +84141,8 @@ paths: parameters: - *17 - *19 - - *484 - *485 + - *486 responses: '200': description: Response @@ -81206,8 +84206,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: - - *484 - *485 + - *486 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -81242,14 +84242,14 @@ paths: type: integer machines: type: array - items: &832 + items: &833 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *589 - required: *590 + properties: *590 + required: *591 examples: - default: &833 + default: &834 value: total_count: 2 machines: @@ -81289,8 +84289,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *484 - *485 + - *486 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -81374,8 +84374,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: - - *484 - *485 + - *486 - 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 @@ -81441,8 +84441,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -81460,7 +84460,7 @@ paths: type: integer secrets: type: array - items: &594 + items: &595 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -81480,7 +84480,7 @@ paths: - created_at - updated_at examples: - default: *591 + default: *592 headers: Link: *47 x-github: @@ -81503,16 +84503,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: *592 + schema: *593 examples: - default: *593 + default: *594 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -81532,17 +84532,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *484 - *485 + - *486 - *300 responses: '200': description: Response content: application/json: - schema: *594 + schema: *595 examples: - default: *595 + default: *596 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81562,8 +84562,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: - - *484 - *485 + - *486 - *300 requestBody: required: true @@ -81616,8 +84616,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *484 - *485 + - *486 - *300 responses: '204': @@ -81646,8 +84646,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *484 - *485 + - *486 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -81689,7 +84689,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &596 + properties: &597 login: type: string example: octocat @@ -81782,7 +84782,7 @@ paths: user_view_type: type: string example: public - required: &597 + required: &598 - avatar_url - events_url - followers_url @@ -81856,8 +84856,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: - - *484 - *485 + - *486 - *148 responses: '204': @@ -81904,8 +84904,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *484 - *485 + - *486 - *148 requestBody: required: false @@ -81932,7 +84932,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &676 + schema: &677 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -82161,8 +85161,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *484 - *485 + - *486 - *148 responses: '204': @@ -82194,8 +85194,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *484 - *485 + - *486 - *148 responses: '200': @@ -82216,8 +85216,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *596 - required: *597 + properties: *597 + required: *598 nullable: true required: - permission @@ -82272,8 +85272,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -82283,7 +85283,7 @@ paths: application/json: schema: type: array - items: &598 + items: &599 title: Commit Comment description: Commit Comment type: object @@ -82341,7 +85341,7 @@ paths: - created_at - updated_at examples: - default: &603 + default: &604 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -82400,17 +85400,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#get-a-commit-comment parameters: - - *484 - *485 + - *486 - *245 responses: '200': description: Response content: application/json: - schema: *598 + schema: *599 examples: - default: &604 + default: &605 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -82467,8 +85467,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#update-a-commit-comment parameters: - - *484 - *485 + - *486 - *245 requestBody: required: true @@ -82491,7 +85491,7 @@ paths: description: Response content: application/json: - schema: *598 + schema: *599 examples: default: value: @@ -82542,8 +85542,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#delete-a-commit-comment parameters: - - *484 - *485 + - *486 - *245 responses: '204': @@ -82565,8 +85565,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *484 - *485 + - *486 - *245 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). @@ -82593,7 +85593,7 @@ paths: application/json: schema: type: array - items: &599 + items: &600 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -82636,7 +85636,7 @@ paths: - content - created_at examples: - default: &680 + default: &681 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -82681,8 +85681,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *484 - *485 + - *486 - *245 requestBody: required: true @@ -82715,9 +85715,9 @@ paths: description: Reaction exists content: application/json: - schema: *599 + schema: *600 examples: - default: &600 + default: &601 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -82746,9 +85746,9 @@ paths: description: Reaction created content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 '422': *15 x-github: githubCloudOnly: false @@ -82770,10 +85770,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *484 - *485 + - *486 - *245 - - &681 + - &682 name: reaction_id description: The unique identifier of the reaction. in: path @@ -82828,8 +85828,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-commits parameters: - - *484 - *485 + - *486 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -82885,9 +85885,9 @@ paths: application/json: schema: type: array - items: *601 + items: *602 examples: - default: &734 + default: &735 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -82981,9 +85981,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#list-branches-for-head-commit parameters: - - *484 - *485 - - &602 + - *486 + - &603 name: commit_sha description: The SHA of the commit. in: path @@ -83055,9 +86055,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#list-commit-comments parameters: - - *484 - *485 - - *602 + - *486 + - *603 - *17 - *19 responses: @@ -83067,9 +86067,9 @@ paths: application/json: schema: type: array - items: *598 + items: *599 examples: - default: *603 + default: *604 headers: Link: *47 x-github: @@ -83097,9 +86097,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/comments#create-a-commit-comment parameters: - - *484 - *485 - - *602 + - *486 + - *603 requestBody: required: true content: @@ -83134,9 +86134,9 @@ paths: description: Response content: application/json: - schema: *598 + schema: *599 examples: - default: *604 + default: *605 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -83164,9 +86164,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: - - *484 - *485 - - *602 + - *486 + - *603 - *17 - *19 responses: @@ -83176,9 +86176,9 @@ paths: application/json: schema: type: array - items: *605 + items: *606 examples: - default: &726 + default: &727 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -83715,11 +86715,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#get-a-commit parameters: - - *484 - *485 + - *486 - *19 - *17 - - &606 + - &607 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)" @@ -83734,9 +86734,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *602 examples: - default: &711 + default: &712 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -83824,7 +86824,7 @@ paths: schema: type: string examples: - default: &615 + default: &616 value: | diff --git a/testfile b/testfile index 9bdeaeb..912c7ef 100644 @@ -83837,7 +86837,7 @@ paths: schema: type: string examples: - default: &616 + default: &617 value: | From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 From: Mona Lisa <87831417+monalisa@users.noreply.github.com> @@ -83890,11 +86890,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: - - *484 - *485 - - *606 + - *486 - *607 - *608 + - *609 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -83928,9 +86928,9 @@ paths: type: integer check_runs: type: array - items: *548 + items: *549 examples: - default: *609 + default: *610 headers: Link: *47 x-github: @@ -83955,9 +86955,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: - - *484 - *485 - - *606 + - *486 + - *607 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -83965,7 +86965,7 @@ paths: schema: type: integer example: 1 - - *607 + - *608 - *17 - *19 responses: @@ -83983,7 +86983,7 @@ paths: type: integer check_suites: type: array - items: *553 + items: *554 examples: default: value: @@ -84183,9 +87183,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: - - *484 - *485 - - *606 + - *486 + - *607 - *17 - *19 responses: @@ -84383,9 +87383,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *484 - *485 - - *606 + - *486 + - *607 - *17 - *19 responses: @@ -84395,7 +87395,7 @@ paths: application/json: schema: type: array - items: &787 + items: &788 title: Status description: The status of a commit. type: object @@ -84476,7 +87476,7 @@ paths: site_admin: false headers: Link: *47 - '301': *490 + '301': *491 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84504,8 +87504,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/community#get-community-profile-metrics parameters: - - *484 - *485 + - *486 responses: '200': description: Response @@ -84534,20 +87534,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *610 - required: *611 + properties: *611 + required: *612 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &612 + properties: &613 url: type: string format: uri html_url: type: string format: uri - required: &613 + required: &614 - url - html_url nullable: true @@ -84561,26 +87561,26 @@ paths: contributing: title: Community Health File type: object - properties: *612 - required: *613 + properties: *613 + required: *614 nullable: true readme: title: Community Health File type: object - properties: *612 - required: *613 + properties: *613 + required: *614 nullable: true issue_template: title: Community Health File type: object - properties: *612 - required: *613 + properties: *613 + required: *614 nullable: true pull_request_template: title: Community Health File type: object - properties: *612 - required: *613 + properties: *613 + required: *614 nullable: true required: - code_of_conduct @@ -84707,8 +87707,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/commits#compare-two-commits parameters: - - *484 - *485 + - *486 - *19 - *17 - name: basehead @@ -84751,8 +87751,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *601 - merge_base_commit: *601 + base_commit: *602 + merge_base_commit: *602 status: type: string enum: @@ -84772,10 +87772,10 @@ paths: example: 6 commits: type: array - items: *601 + items: *602 files: type: array - items: *614 + items: *615 required: - url - html_url @@ -85021,12 +88021,12 @@ paths: schema: type: string examples: - default: *615 + default: *616 application/vnd.github.patch: schema: type: string examples: - default: *616 + default: *617 '404': *6 '500': *40 '503': *200 @@ -85071,8 +88071,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-repository-content parameters: - - *484 - *485 + - *486 - name: path description: path parameter in: path @@ -85232,7 +88232,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &617 + response-if-content-is-a-file-github-object: &618 summary: Response if content is a file value: type: file @@ -85364,7 +88364,7 @@ paths: - size - type - url - - &739 + - &740 title: Content File description: Content File type: object @@ -85565,7 +88565,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *617 + response-if-content-is-a-file: *618 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -85634,7 +88634,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *618 + '302': *619 '304': *37 x-github: githubCloudOnly: false @@ -85657,8 +88657,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#create-or-update-file-contents parameters: - - *484 - *485 + - *486 - name: path description: path parameter in: path @@ -85751,7 +88751,7 @@ paths: description: Response content: application/json: - schema: &619 + schema: &620 title: File Commit description: File Commit type: object @@ -85903,7 +88903,7 @@ paths: description: Response content: application/json: - schema: *619 + schema: *620 examples: example-for-creating-a-file: value: @@ -85957,7 +88957,7 @@ paths: schema: oneOf: - *3 - - &659 + - &660 description: Repository rule violation was detected type: object properties: @@ -85978,7 +88978,7 @@ paths: items: type: object properties: - placeholder_id: &779 + placeholder_id: &780 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -86010,8 +89010,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#delete-a-file parameters: - - *484 - *485 + - *486 - name: path description: path parameter in: path @@ -86072,7 +89072,7 @@ paths: description: Response content: application/json: - schema: *619 + schema: *620 examples: default: value: @@ -86127,8 +89127,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-contributors parameters: - - *484 - *485 + - *486 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -86251,8 +89251,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *484 - *485 + - *486 - *344 - *345 - *346 @@ -86265,7 +89265,7 @@ paths: schema: type: string - *349 - - *620 + - *621 - *350 - *351 - *352 @@ -86280,7 +89280,7 @@ paths: application/json: schema: type: array - items: &624 + items: &625 type: object description: A Dependabot alert. properties: @@ -86327,7 +89327,7 @@ paths: - direct - transitive - inconclusive - security_advisory: *621 + security_advisory: *622 security_vulnerability: *135 url: *136 html_url: *137 @@ -86358,8 +89358,8 @@ paths: nullable: true maxLength: 280 fixed_at: *141 - auto_dismissed_at: *622 - dismissal_request: *623 + auto_dismissed_at: *623 + dismissal_request: *624 assignees: type: array description: The users assigned to this alert. @@ -86614,9 +89614,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *484 - *485 - - &625 + - *486 + - &626 name: alert_number in: path description: |- @@ -86631,7 +89631,7 @@ paths: description: Response content: application/json: - schema: *624 + schema: *625 examples: default: value: @@ -86763,9 +89763,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *484 - *485 - - *625 + - *486 + - *626 requestBody: required: true content: @@ -86821,7 +89821,7 @@ paths: description: Response content: application/json: - schema: *624 + schema: *625 examples: default: value: @@ -86951,8 +89951,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#list-repository-secrets parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -86970,7 +89970,7 @@ paths: type: integer secrets: type: array - items: &628 + items: &629 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -87023,16 +90023,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: *627 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87052,15 +90052,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#get-a-repository-secret parameters: - - *484 - *485 + - *486 - *300 responses: '200': description: Response content: application/json: - schema: *628 + schema: *629 examples: default: value: @@ -87086,8 +90086,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *484 - *485 + - *486 - *300 requestBody: required: true @@ -87140,8 +90140,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *484 - *485 + - *486 - *300 responses: '204': @@ -87164,8 +90164,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: - - *484 - *485 + - *486 - 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 @@ -87325,8 +90325,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -87564,8 +90564,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: - - *484 - *485 + - *486 - name: sbom_uuid in: path required: true @@ -87576,7 +90576,7 @@ paths: '302': description: Redirects to a temporary download URL for the completed SBOM. headers: - Location: *629 + Location: *630 '202': description: SBOM is still being processed, no content is returned. '404': *6 @@ -87597,8 +90597,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: - - *484 - *485 + - *486 responses: '201': description: Response @@ -87636,8 +90636,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -87712,7 +90712,7 @@ paths: - version - url additionalProperties: false - metadata: &630 + metadata: &631 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -87745,7 +90745,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *630 + metadata: *631 resolved: type: object description: A collection of resolved package dependencies. @@ -87758,7 +90758,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *630 + metadata: *631 relationship: type: string description: A notation of whether a dependency is requested @@ -87887,8 +90887,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments parameters: - - *484 - *485 + - *486 - name: sha description: The SHA recorded at creation time. in: query @@ -87928,9 +90928,9 @@ paths: application/json: schema: type: array - items: *631 + items: *632 examples: - default: *632 + default: *633 headers: Link: *47 x-github: @@ -87996,8 +90996,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#create-a-deployment parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -88078,7 +91078,7 @@ paths: description: Response content: application/json: - schema: *631 + schema: *632 examples: simple-example: summary: Simple example @@ -88151,9 +91151,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#get-a-deployment parameters: - - *484 - *485 - - &633 + - *486 + - &634 name: deployment_id description: deployment_id parameter in: path @@ -88165,7 +91165,7 @@ paths: description: Response content: application/json: - schema: *631 + schema: *632 examples: default: value: @@ -88230,9 +91230,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#delete-a-deployment parameters: - - *484 - *485 - - *633 + - *486 + - *634 responses: '204': description: Response @@ -88254,9 +91254,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#list-deployment-statuses parameters: - - *484 - *485 - - *633 + - *486 + - *634 - *17 - *19 responses: @@ -88266,7 +91266,7 @@ paths: application/json: schema: type: array - items: &634 + items: &635 title: Deployment Status description: The status of a deployment. type: object @@ -88427,9 +91427,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#create-a-deployment-status parameters: - - *484 - *485 - - *633 + - *486 + - *634 requestBody: required: true content: @@ -88504,9 +91504,9 @@ paths: description: Response content: application/json: - schema: *634 + schema: *635 examples: - default: &635 + default: &636 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -88562,9 +91562,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/statuses#get-a-deployment-status parameters: - - *484 - *485 - - *633 + - *486 + - *634 - name: status_id in: path required: true @@ -88575,9 +91575,9 @@ paths: description: Response content: application/json: - schema: *634 + schema: *635 examples: - default: *635 + default: *636 '404': *6 x-github: githubCloudOnly: false @@ -88604,12 +91604,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *484 - *485 - - *636 + - *486 - *637 - *638 - *639 + - *640 - *17 - *19 responses: @@ -88619,9 +91619,9 @@ paths: application/json: schema: type: array - items: *640 + items: *641 examples: - default: *641 + default: *642 '404': *6 '403': *29 '500': *40 @@ -88645,8 +91645,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *484 - *485 + - *486 - name: alert_number in: path required: true @@ -88658,7 +91658,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *640 + schema: *641 examples: default: value: @@ -88714,8 +91714,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *484 - *485 + - *486 - name: alert_number in: path required: true @@ -88774,12 +91774,12 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *484 - *485 - - *636 + - *486 - *637 - *638 - *639 + - *640 - *17 - *19 responses: @@ -88789,9 +91789,9 @@ paths: application/json: schema: type: array - items: *642 + items: *643 examples: - default: *643 + default: *644 '404': *6 '403': *29 '500': *40 @@ -88815,8 +91815,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *484 - *485 + - *486 - name: alert_number in: path required: true @@ -88828,7 +91828,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *642 + schema: *643 examples: default: value: @@ -88879,8 +91879,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *484 - *485 + - *486 - name: alert_number in: path required: true @@ -88918,7 +91918,7 @@ paths: description: The created dismissal request. content: application/json: - schema: *642 + schema: *643 examples: default: value: @@ -88969,8 +91969,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *484 - *485 + - *486 - name: alert_number in: path required: true @@ -89041,8 +92041,8 @@ paths: category: dependabot subcategory: alert-dismissal-requests parameters: - - *484 - *485 + - *486 - name: alert_number in: path required: true @@ -89075,8 +92075,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *484 - *485 + - *486 - *105 - *106 - *107 @@ -89117,8 +92117,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *484 - *485 + - *486 - name: alert_number in: path required: true @@ -89188,8 +92188,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *484 - *485 + - *486 - name: alert_number in: path required: true @@ -89258,8 +92258,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -89316,8 +92316,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#list-environments parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -89334,7 +92334,7 @@ paths: type: integer environments: type: array - items: &645 + items: &646 title: Environment description: Details of a deployment environment type: object @@ -89386,7 +92386,7 @@ paths: type: type: string example: wait_timer - wait_timer: &647 + wait_timer: &648 type: integer example: 30 description: The amount of time to delay a job after @@ -89423,7 +92423,7 @@ paths: items: type: object properties: - type: *644 + type: *645 reviewer: anyOf: - *4 @@ -89447,7 +92447,7 @@ paths: - id - node_id - type - deployment_branch_policy: &648 + deployment_branch_policy: &649 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -89563,9 +92563,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#get-an-environment parameters: - - *484 - *485 - - &646 + - *486 + - &647 name: environment_name in: path required: true @@ -89578,9 +92578,9 @@ paths: description: Response content: application/json: - schema: *645 + schema: *646 examples: - default: &649 + default: &650 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -89664,9 +92664,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#create-or-update-an-environment parameters: - - *484 - *485 - - *646 + - *486 + - *647 requestBody: required: false content: @@ -89675,7 +92675,7 @@ paths: type: object nullable: true properties: - wait_timer: *647 + wait_timer: *648 prevent_self_review: type: boolean example: false @@ -89692,13 +92692,13 @@ paths: items: type: object properties: - type: *644 + type: *645 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *648 + deployment_branch_policy: *649 additionalProperties: false examples: default: @@ -89718,9 +92718,9 @@ paths: description: Response content: application/json: - schema: *645 + schema: *646 examples: - default: *649 + default: *650 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -89744,9 +92744,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments#delete-an-environment parameters: - - *484 - *485 - - *646 + - *486 + - *647 responses: '204': description: Default response @@ -89771,9 +92771,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *484 - *485 - - *646 + - *486 + - *647 - *17 - *19 responses: @@ -89791,7 +92791,7 @@ paths: example: 2 branch_policies: type: array - items: &650 + items: &651 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -89848,9 +92848,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *484 - *485 - - *646 + - *486 + - *647 requestBody: required: true content: @@ -89896,9 +92896,9 @@ paths: description: Response content: application/json: - schema: *650 + schema: *651 examples: - example-wildcard: &651 + example-wildcard: &652 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -89940,10 +92940,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *484 - *485 - - *646 - - &652 + - *486 + - *647 + - &653 name: branch_policy_id in: path required: true @@ -89955,9 +92955,9 @@ paths: description: Response content: application/json: - schema: *650 + schema: *651 examples: - default: *651 + default: *652 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89976,10 +92976,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *484 - *485 - - *646 - - *652 + - *486 + - *647 + - *653 requestBody: required: true content: @@ -90007,9 +93007,9 @@ paths: description: Response content: application/json: - schema: *650 + schema: *651 examples: - default: *651 + default: *652 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90028,10 +93028,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *484 - *485 - - *646 - - *652 + - *486 + - *647 + - *653 responses: '204': description: Response @@ -90056,9 +93056,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: - - *646 + - *647 + - *486 - *485 - - *484 responses: '200': description: List of deployment protection rules @@ -90074,7 +93074,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &653 + items: &654 title: Deployment protection rule description: Deployment protection rule type: object @@ -90093,7 +93093,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &654 + app: &655 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -90192,9 +93192,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: - - *646 + - *647 + - *486 - *485 - - *484 requestBody: content: application/json: @@ -90215,9 +93215,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *653 + schema: *654 examples: - default: &655 + default: &656 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -90252,9 +93252,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: - - *646 + - *647 + - *486 - *485 - - *484 - *19 - *17 responses: @@ -90273,7 +93273,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *654 + items: *655 examples: default: value: @@ -90308,10 +93308,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: - - *484 - *485 - - *646 - - &656 + - *486 + - *647 + - &657 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -90323,9 +93323,9 @@ paths: description: Response content: application/json: - schema: *653 + schema: *654 examples: - default: *655 + default: *656 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90346,10 +93346,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: - - *646 + - *647 + - *486 - *485 - - *484 - - *656 + - *657 responses: '204': description: Response @@ -90375,9 +93375,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#list-environment-secrets parameters: - - *484 - *485 - - *646 + - *486 + - *647 - *17 - *19 responses: @@ -90395,9 +93395,9 @@ paths: type: integer secrets: type: array - items: *515 + items: *516 examples: - default: *516 + default: *517 headers: Link: *47 x-github: @@ -90422,17 +93422,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-public-key parameters: - - *484 - *485 - - *646 + - *486 + - *647 responses: '200': description: Response content: application/json: - schema: *517 + schema: *518 examples: - default: *518 + default: *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90454,18 +93454,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#get-an-environment-secret parameters: - - *484 - *485 - - *646 + - *486 + - *647 - *300 responses: '200': description: Response content: application/json: - schema: *515 + schema: *516 examples: - default: *657 + default: *658 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90487,9 +93487,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *484 - *485 - - *646 + - *486 + - *647 - *300 requestBody: required: true @@ -90547,9 +93547,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/secrets#delete-an-environment-secret parameters: - - *484 - *485 - - *646 + - *486 + - *647 - *300 responses: '204': @@ -90575,10 +93575,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#list-environment-variables parameters: - - *484 - *485 - - *646 - - *502 + - *486 + - *647 + - *503 - *19 responses: '200': @@ -90595,9 +93595,9 @@ paths: type: integer variables: type: array - items: *519 + items: *520 examples: - default: *520 + default: *521 headers: Link: *47 x-github: @@ -90620,9 +93620,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#create-an-environment-variable parameters: - - *484 - *485 - - *646 + - *486 + - *647 requestBody: required: true content: @@ -90674,18 +93674,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#get-an-environment-variable parameters: - - *484 - *485 - - *646 + - *486 + - *647 - *303 responses: '200': description: Response content: application/json: - schema: *519 + schema: *520 examples: - default: *658 + default: *659 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90706,10 +93706,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#update-an-environment-variable parameters: - - *484 - *485 + - *486 - *303 - - *646 + - *647 requestBody: required: true content: @@ -90751,10 +93751,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/actions/variables#delete-an-environment-variable parameters: - - *484 - *485 + - *486 - *303 - - *646 + - *647 responses: '204': description: Response @@ -90776,8 +93776,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/events#list-repository-events parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -90845,8 +93845,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#list-forks parameters: - - *484 - *485 + - *486 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -91005,8 +94005,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/forks#create-a-fork parameters: - - *484 - *485 + - *486 requestBody: required: false content: @@ -91038,9 +94038,9 @@ paths: description: Response content: application/json: - schema: *489 + schema: *490 examples: - default: *491 + default: *492 '400': *14 '422': *15 '403': *29 @@ -91061,8 +94061,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#create-a-blob parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -91122,7 +94122,7 @@ paths: schema: oneOf: - *265 - - *659 + - *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91147,8 +94147,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/blobs#get-a-blob parameters: - - *484 - *485 + - *486 - name: file_sha in: path required: true @@ -91247,8 +94247,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/commits#create-a-commit parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -91357,7 +94357,7 @@ paths: description: Response content: application/json: - schema: &660 + schema: &661 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -91571,15 +94571,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/commits#get-a-commit-object parameters: - - *484 - *485 - - *602 + - *486 + - *603 responses: '200': description: Response content: application/json: - schema: *660 + schema: *661 examples: default: value: @@ -91635,9 +94635,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#list-matching-references parameters: - - *484 - *485 - - &661 + - *486 + - &662 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. @@ -91654,7 +94654,7 @@ paths: application/json: schema: type: array - items: &662 + items: &663 title: Git Reference description: Git references within a repository type: object @@ -91729,17 +94729,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference parameters: - - *484 - *485 - - *661 + - *486 + - *662 responses: '200': description: Response content: application/json: - schema: *662 + schema: *663 examples: - default: &663 + default: &664 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -91768,8 +94768,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#create-a-reference parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -91798,9 +94798,9 @@ paths: description: Response content: application/json: - schema: *662 + schema: *663 examples: - default: *663 + default: *664 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -91826,9 +94826,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#update-a-reference parameters: - - *484 - *485 - - *661 + - *486 + - *662 requestBody: required: true content: @@ -91857,9 +94857,9 @@ paths: description: Response content: application/json: - schema: *662 + schema: *663 examples: - default: *663 + default: *664 '422': *15 '409': *121 x-github: @@ -91877,9 +94877,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/refs#delete-a-reference parameters: - - *484 - *485 - - *661 + - *486 + - *662 responses: '204': description: Response @@ -91934,8 +94934,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/tags#create-a-tag-object parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -92002,7 +95002,7 @@ paths: description: Response content: application/json: - schema: &665 + schema: &666 title: Git Tag description: Metadata for a Git tag type: object @@ -92053,7 +95053,7 @@ paths: - sha - type - url - verification: *664 + verification: *665 required: - sha - url @@ -92063,7 +95063,7 @@ paths: - tag - message examples: - default: &666 + default: &667 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -92136,8 +95136,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/tags#get-a-tag parameters: - - *484 - *485 + - *486 - name: tag_sha in: path required: true @@ -92148,9 +95148,9 @@ paths: description: Response content: application/json: - schema: *665 + schema: *666 examples: - default: *666 + default: *667 '404': *6 '409': *121 x-github: @@ -92174,8 +95174,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/trees#create-a-tree parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -92248,7 +95248,7 @@ paths: description: Response content: application/json: - schema: &667 + schema: &668 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -92344,8 +95344,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/git/trees#get-a-tree parameters: - - *484 - *485 + - *486 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -92368,7 +95368,7 @@ paths: description: Response content: application/json: - schema: *667 + schema: *668 examples: default-response: summary: Default response @@ -92427,8 +95427,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-repository-webhooks parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -92438,7 +95438,7 @@ paths: application/json: schema: type: array - items: &668 + items: &669 title: Webhook description: Webhooks for repositories. type: object @@ -92492,7 +95492,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &930 + last_response: &931 title: Hook Response type: object properties: @@ -92566,8 +95566,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#create-a-repository-webhook parameters: - - *484 - *485 + - *486 requestBody: required: false content: @@ -92619,9 +95619,9 @@ paths: description: Response content: application/json: - schema: *668 + schema: *669 examples: - default: &669 + default: &670 value: type: Repository id: 12345678 @@ -92669,17 +95669,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#get-a-repository-webhook parameters: - - *484 - *485 + - *486 - *366 responses: '200': description: Response content: application/json: - schema: *668 + schema: *669 examples: - default: *669 + default: *670 '404': *6 x-github: githubCloudOnly: false @@ -92699,8 +95699,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#update-a-repository-webhook parameters: - - *484 - *485 + - *486 - *366 requestBody: required: true @@ -92746,9 +95746,9 @@ paths: description: Response content: application/json: - schema: *668 + schema: *669 examples: - default: *669 + default: *670 '422': *15 '404': *6 x-github: @@ -92769,8 +95769,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *484 - *485 + - *486 - *366 responses: '204': @@ -92795,8 +95795,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: - - *484 - *485 + - *486 - *366 responses: '200': @@ -92824,8 +95824,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: - - *484 - *485 + - *486 - *366 requestBody: required: false @@ -92870,8 +95870,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *484 - *485 + - *486 - *366 - *17 - *367 @@ -92904,8 +95904,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: - - *484 - *485 + - *486 - *366 - *16 responses: @@ -92934,8 +95934,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: - - *484 - *485 + - *486 - *366 - *16 responses: @@ -92959,8 +95959,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *484 - *485 + - *486 - *366 responses: '204': @@ -92986,8 +95986,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *484 - *485 + - *486 - *366 responses: '204': @@ -93011,8 +96011,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: - - *484 - *485 + - *486 responses: '200': description: Response if immutable releases are enabled @@ -93058,8 +96058,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-immutable-releases parameters: - - *484 - *485 + - *486 responses: '204': *130 '409': *121 @@ -93079,8 +96079,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-immutable-releases parameters: - - *484 - *485 + - *486 responses: '204': *130 '409': *121 @@ -93137,14 +96137,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-an-import-status parameters: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: &670 + schema: &671 title: Import description: A repository import from an external source. type: object @@ -93243,7 +96243,7 @@ paths: - html_url - authors_url examples: - default: &673 + default: &674 value: vcs: subversion use_lfs: true @@ -93259,7 +96259,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': &671 + '503': &672 description: Unavailable due to service under maintenance. content: application/json: @@ -93288,8 +96288,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#start-an-import parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -93337,7 +96337,7 @@ paths: description: Response content: application/json: - schema: *670 + schema: *671 examples: default: value: @@ -93362,7 +96362,7 @@ paths: type: string '422': *15 '404': *6 - '503': *671 + '503': *672 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93390,8 +96390,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-an-import parameters: - - *484 - *485 + - *486 requestBody: required: false content: @@ -93440,7 +96440,7 @@ paths: description: Response content: application/json: - schema: *670 + schema: *671 examples: example-1: summary: Example 1 @@ -93488,7 +96488,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': *671 + '503': *672 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93511,12 +96511,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#cancel-an-import parameters: - - *484 - *485 + - *486 responses: '204': description: Response - '503': *671 + '503': *672 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93542,9 +96542,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-commit-authors parameters: - - *484 - *485 - - &855 + - *486 + - &856 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -93558,7 +96558,7 @@ paths: application/json: schema: type: array - items: &672 + items: &673 title: Porter Author description: Porter Author type: object @@ -93612,7 +96612,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': *671 + '503': *672 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93637,8 +96637,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#map-a-commit-author parameters: - - *484 - *485 + - *486 - name: author_id in: path required: true @@ -93668,7 +96668,7 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: default: value: @@ -93681,7 +96681,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *671 + '503': *672 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93705,8 +96705,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#get-large-files parameters: - - *484 - *485 + - *486 responses: '200': description: Response @@ -93747,7 +96747,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *671 + '503': *672 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93775,8 +96775,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -93803,11 +96803,11 @@ paths: description: Response content: application/json: - schema: *670 + schema: *671 examples: - default: *673 + default: *674 '422': *15 - '503': *671 + '503': *672 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93830,8 +96830,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -93840,7 +96840,7 @@ paths: schema: *22 examples: default: *384 - '301': *490 + '301': *491 '404': *6 x-github: githubCloudOnly: false @@ -93860,8 +96860,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *484 - *485 + - *486 responses: '200': description: Response @@ -93874,7 +96874,7 @@ paths: properties: {} additionalProperties: false examples: - default: &675 + default: &676 value: limit: collaborators_only origin: repository @@ -93899,13 +96899,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *484 - *485 + - *486 requestBody: required: true content: application/json: - schema: *674 + schema: *675 examples: default: summary: Example request body @@ -93919,7 +96919,7 @@ paths: application/json: schema: *386 examples: - default: *675 + default: *676 '409': description: Response x-github: @@ -93941,8 +96941,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *484 - *485 + - *486 responses: '204': description: Response @@ -93965,8 +96965,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#list-repository-invitations parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -93976,9 +96976,9 @@ paths: application/json: schema: type: array - items: *676 + items: *677 examples: - default: &847 + default: &848 value: - id: 1 repository: @@ -94109,8 +97109,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *484 - *485 + - *486 - *390 requestBody: required: false @@ -94140,7 +97140,7 @@ paths: description: Response content: application/json: - schema: *676 + schema: *677 examples: default: value: @@ -94271,8 +97271,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *484 - *485 + - *486 - *390 responses: '204': @@ -94304,8 +97304,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#list-repository-issues parameters: - - *484 - *485 + - *486 - 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 @@ -94378,7 +97378,7 @@ paths: type: array items: *229 examples: - default: &688 + default: &689 value: - id: 1 node_id: MDU6SXNzdWUx @@ -94527,7 +97527,7 @@ paths: state_reason: completed headers: Link: *47 - '301': *490 + '301': *491 '422': *15 '404': *6 x-github: @@ -94556,8 +97556,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#create-an-issue parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -94634,7 +97634,7 @@ paths: application/json: schema: *229 examples: - default: &685 + default: &686 value: id: 1 node_id: MDU6SXNzdWUx @@ -94772,7 +97772,7 @@ paths: '422': *15 '503': *200 '404': *6 - '410': *677 + '410': *678 x-github: triggersNotification: true githubCloudOnly: false @@ -94800,8 +97800,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *484 - *485 + - *486 - *253 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -94822,9 +97822,9 @@ paths: application/json: schema: type: array - items: *678 + items: *679 examples: - default: &687 + default: &688 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -94882,17 +97882,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment parameters: - - *484 - *485 + - *486 - *245 responses: '200': description: Response content: application/json: - schema: *678 + schema: *679 examples: - default: &679 + default: &680 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -94947,8 +97947,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#update-an-issue-comment parameters: - - *484 - *485 + - *486 - *245 requestBody: required: true @@ -94971,9 +97971,9 @@ paths: description: Response content: application/json: - schema: *678 + schema: *679 examples: - default: *679 + default: *680 '422': *15 x-github: githubCloudOnly: false @@ -94991,8 +97991,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#delete-an-issue-comment parameters: - - *484 - *485 + - *486 - *245 responses: '204': @@ -95021,15 +98021,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#pin-an-issue-comment parameters: - - *484 - *485 + - *486 - *245 responses: '200': description: Response content: application/json: - schema: *678 + schema: *679 examples: default: value: @@ -95085,7 +98085,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *677 + '410': *678 '422': *15 x-github: githubCloudOnly: false @@ -95102,8 +98102,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#unpin-an-issue-comment parameters: - - *484 - *485 + - *486 - *245 responses: '204': @@ -95111,7 +98111,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *677 + '410': *678 '503': *200 x-github: githubCloudOnly: false @@ -95129,8 +98129,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *484 - *485 + - *486 - *245 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). @@ -95157,9 +98157,9 @@ paths: application/json: schema: type: array - items: *599 + items: *600 examples: - default: *680 + default: *681 headers: Link: *47 '404': *6 @@ -95180,8 +98180,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *484 - *485 + - *486 - *245 requestBody: required: true @@ -95214,16 +98214,16 @@ paths: description: Reaction exists content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 '201': description: Reaction created content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 '422': *15 x-github: githubCloudOnly: false @@ -95245,10 +98245,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *484 - *485 + - *486 - *245 - - *681 + - *682 responses: '204': description: Response @@ -95268,8 +98268,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events-for-a-repository parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -95279,7 +98279,7 @@ paths: application/json: schema: type: array - items: &684 + items: &685 title: Issue Event description: Issue Event type: object @@ -95322,8 +98322,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *682 - required: *683 + properties: *683 + required: *684 nullable: true label: title: Issue Event Label @@ -95631,8 +98631,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#get-an-issue-event parameters: - - *484 - *485 + - *486 - name: event_id in: path required: true @@ -95643,7 +98643,7 @@ paths: description: Response content: application/json: - schema: *684 + schema: *685 examples: default: value: @@ -95836,7 +98836,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *677 + '410': *678 '403': *29 x-github: githubCloudOnly: false @@ -95870,9 +98870,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue parameters: - - *484 - *485 - - &686 + - *486 + - &687 name: issue_number description: The number that identifies the issue. in: path @@ -95888,7 +98888,7 @@ paths: examples: default: summary: Issue - value: *685 + value: *686 pinned_comment: summary: Issue with pinned comment value: @@ -96068,9 +99068,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *490 + '301': *491 '404': *6 - '410': *677 + '410': *678 '304': *37 x-github: githubCloudOnly: false @@ -96095,9 +99095,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#update-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: false content: @@ -96218,13 +99218,13 @@ paths: application/json: schema: *229 examples: - default: *685 + default: *686 '422': *15 '503': *200 '403': *29 - '301': *490 + '301': *491 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96242,9 +99242,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: false content: @@ -96272,7 +99272,7 @@ paths: application/json: schema: *229 examples: - default: *685 + default: *686 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96288,9 +99288,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: content: application/json: @@ -96317,7 +99317,7 @@ paths: application/json: schema: *229 examples: - default: *685 + default: *686 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96339,9 +99339,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: - - *484 - *485 - - *686 + - *486 + - *687 - name: assignee in: path required: true @@ -96381,9 +99381,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#list-issue-comments parameters: - - *484 - *485 - - *686 + - *486 + - *687 - *236 - *17 - *19 @@ -96394,13 +99394,13 @@ paths: application/json: schema: type: array - items: *678 + items: *679 examples: - default: *687 + default: *688 headers: Link: *47 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96429,9 +99429,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#create-an-issue-comment parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: true content: @@ -96453,16 +99453,16 @@ paths: description: Response content: application/json: - schema: *678 + schema: *679 examples: - default: *679 + default: *680 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *677 + '410': *678 '422': *15 '404': *6 x-github: @@ -96490,9 +99490,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: - - *484 - *485 - - *686 + - *486 + - *687 - *17 - *19 responses: @@ -96504,12 +99504,12 @@ paths: type: array items: *229 examples: - default: *688 + default: *689 headers: Link: *47 - '301': *490 + '301': *491 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96537,9 +99537,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: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: true content: @@ -96563,15 +99563,15 @@ paths: application/json: schema: *229 examples: - default: *685 + default: *686 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *490 + '301': *491 '403': *29 - '410': *677 + '410': *678 '422': *15 '404': *6 x-github: @@ -96602,9 +99602,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: - - *484 - *485 - - *686 + - *486 + - *687 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -96618,13 +99618,13 @@ paths: application/json: schema: *229 examples: - default: *685 - '301': *490 + default: *686 + '301': *491 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *677 + '410': *678 x-github: triggersNotification: true githubCloudOnly: false @@ -96650,9 +99650,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: - - *484 - *485 - - *686 + - *486 + - *687 - *17 - *19 responses: @@ -96664,12 +99664,12 @@ paths: type: array items: *229 examples: - default: *688 + default: *689 headers: Link: *47 - '301': *490 + '301': *491 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96686,9 +99686,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/events#list-issue-events parameters: - - *484 - *485 - - *686 + - *486 + - *687 - *17 - *19 responses: @@ -96702,7 +99702,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &692 + - &693 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -96756,7 +99756,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &693 + - &694 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -96892,7 +99892,7 @@ paths: - performed_via_github_app - assignee - assigner - - &694 + - &695 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -96943,7 +99943,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &695 + - &696 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -96994,7 +99994,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &696 + - &697 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -97048,7 +100048,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &697 + - &698 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -97095,7 +100095,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &698 + - &699 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -97142,7 +100142,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &699 + - &700 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -97202,7 +100202,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &700 + - &701 title: Locked Issue Event description: Locked Issue Event type: object @@ -97250,7 +100250,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &701 + - &702 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -97316,7 +100316,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &702 + - &703 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -97382,7 +100382,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &703 + - &704 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -97448,7 +100448,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &704 + - &705 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -97539,7 +100539,7 @@ paths: color: red headers: Link: *47 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97556,9 +100556,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: - - *484 - *485 - - *686 + - *486 + - *687 - *17 - *19 responses: @@ -97568,9 +100568,9 @@ paths: application/json: schema: type: array - items: *689 + items: *690 examples: - default: &690 + default: &691 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -97594,9 +100594,9 @@ paths: value: '2025-12-25' headers: Link: *47 - '301': *490 + '301': *491 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97625,9 +100625,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: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: true content: @@ -97691,9 +100691,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *689 + items: *690 examples: - default: *690 + default: *691 '400': *14 '403': *29 '404': *6 @@ -97729,9 +100729,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: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: true content: @@ -97796,9 +100796,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *689 + items: *690 examples: - default: *690 + default: *691 '400': *14 '403': *29 '404': *6 @@ -97829,9 +100829,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: - - *484 - *485 - - *686 + - *486 + - *687 - *393 responses: '204': @@ -97857,9 +100857,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 - *17 - *19 responses: @@ -97871,7 +100871,7 @@ paths: type: array items: *228 examples: - default: &691 + default: &692 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -97889,9 +100889,9 @@ paths: default: false headers: Link: *47 - '301': *490 + '301': *491 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97907,9 +100907,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#add-labels-to-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: false content: @@ -97954,10 +100954,10 @@ paths: type: array items: *228 examples: - default: *691 - '301': *490 + default: *692 + '301': *491 '404': *6 - '410': *677 + '410': *678 '422': *15 x-github: githubCloudOnly: false @@ -97974,9 +100974,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#set-labels-for-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: false content: @@ -98038,10 +101038,10 @@ paths: type: array items: *228 examples: - default: *691 - '301': *490 + default: *692 + '301': *491 '404': *6 - '410': *677 + '410': *678 '422': *15 x-github: githubCloudOnly: false @@ -98058,15 +101058,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 responses: '204': description: Response - '301': *490 + '301': *491 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98085,9 +101085,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 - name: name in: path required: true @@ -98111,9 +101111,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *490 + '301': *491 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98133,9 +101133,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#lock-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: false content: @@ -98163,7 +101163,7 @@ paths: '204': description: Response '403': *29 - '410': *677 + '410': *678 '404': *6 '422': *15 x-github: @@ -98181,9 +101181,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#unlock-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 responses: '204': description: Response @@ -98213,9 +101213,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#get-parent-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 responses: '200': description: Response @@ -98223,10 +101223,10 @@ paths: application/json: schema: *229 examples: - default: *685 - '301': *490 + default: *686 + '301': *491 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98243,9 +101243,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 - 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. @@ -98271,13 +101271,13 @@ paths: application/json: schema: type: array - items: *599 + items: *600 examples: - default: *680 + default: *681 headers: Link: *47 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98295,9 +101295,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: true content: @@ -98329,16 +101329,16 @@ paths: description: Response content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 '201': description: Response content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 '422': *15 x-github: githubCloudOnly: false @@ -98360,10 +101360,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *484 - *485 - - *686 - - *681 + - *486 + - *687 + - *682 responses: '204': description: Response @@ -98392,9 +101392,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#remove-sub-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: true content: @@ -98418,7 +101418,7 @@ paths: application/json: schema: *229 examples: - default: *685 + default: *686 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -98451,9 +101451,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#list-sub-issues parameters: - - *484 - *485 - - *686 + - *486 + - *687 - *17 - *19 responses: @@ -98465,11 +101465,11 @@ paths: type: array items: *229 examples: - default: *688 + default: *689 headers: Link: *47 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98497,9 +101497,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#add-sub-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: true content: @@ -98528,14 +101528,14 @@ paths: application/json: schema: *229 examples: - default: *685 + default: *686 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *677 + '410': *678 '422': *15 '404': *6 x-github: @@ -98555,9 +101555,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 requestBody: required: true content: @@ -98590,7 +101590,7 @@ paths: application/json: schema: *229 examples: - default: *685 + default: *686 '403': *29 '404': *6 '422': *7 @@ -98612,9 +101612,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *484 - *485 - - *686 + - *486 + - *687 - *17 - *19 responses: @@ -98629,7 +101629,6 @@ paths: description: Timeline Event type: object anyOf: - - *692 - *693 - *694 - *695 @@ -98642,6 +101641,7 @@ paths: - *702 - *703 - *704 + - *705 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -98702,8 +101702,8 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *705 - required: *706 + properties: *706 + required: *707 nullable: true required: - event @@ -98958,7 +101958,7 @@ paths: type: string comments: type: array - items: &728 + items: &729 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -99173,7 +102173,7 @@ paths: type: string comments: type: array - items: *598 + items: *599 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -99462,7 +102462,7 @@ paths: headers: Link: *47 '404': *6 - '410': *677 + '410': *678 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99479,8 +102479,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -99490,7 +102490,7 @@ paths: application/json: schema: type: array - items: &707 + items: &708 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -99556,8 +102556,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -99593,9 +102593,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *708 examples: - default: &708 + default: &709 value: id: 1 key: ssh-rsa AAA... @@ -99629,9 +102629,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *484 - *485 - - &709 + - *486 + - &710 name: key_id description: The unique identifier of the key. in: path @@ -99643,9 +102643,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *708 examples: - default: *708 + default: *709 '404': *6 x-github: githubCloudOnly: false @@ -99663,9 +102663,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *484 - *485 - - *709 + - *486 + - *710 responses: '204': description: Response @@ -99685,8 +102685,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#list-labels-for-a-repository parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -99698,7 +102698,7 @@ paths: type: array items: *228 examples: - default: *691 + default: *692 headers: Link: *47 '404': *6 @@ -99719,8 +102719,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#create-a-label parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -99758,7 +102758,7 @@ paths: application/json: schema: *228 examples: - default: &710 + default: &711 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -99790,8 +102790,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#get-a-label parameters: - - *484 - *485 + - *486 - name: name in: path required: true @@ -99804,7 +102804,7 @@ paths: application/json: schema: *228 examples: - default: *710 + default: *711 '404': *6 x-github: githubCloudOnly: false @@ -99821,8 +102821,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#update-a-label parameters: - - *484 - *485 + - *486 - name: name in: path required: true @@ -99887,8 +102887,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/labels#delete-a-label parameters: - - *484 - *485 + - *486 - name: name in: path required: true @@ -99914,8 +102914,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-languages parameters: - - *484 - *485 + - *486 responses: '200': description: Response @@ -99951,8 +102951,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *484 - *485 + - *486 responses: '202': *39 '403': @@ -99980,8 +102980,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *484 - *485 + - *486 responses: '204': description: Response @@ -100007,9 +103007,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *484 - *485 - - *571 + - *486 + - *572 responses: '200': description: Response @@ -100154,8 +103154,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -100220,8 +103220,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/branches/branches#merge-a-branch parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -100255,9 +103255,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *601 + schema: *602 examples: - default: *711 + default: *712 '204': description: Response when already merged '404': @@ -100282,8 +103282,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#list-milestones parameters: - - *484 - *485 + - *486 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -100324,7 +103324,7 @@ paths: application/json: schema: type: array - items: &712 + items: &713 title: Milestone description: A collection of related issues and pull requests. type: object @@ -100385,8 +103385,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#create-a-milestone parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -100426,9 +103426,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: &713 + default: &714 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -100487,9 +103487,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#get-a-milestone parameters: - - *484 - *485 - - &714 + - *486 + - &715 name: milestone_number description: The number that identifies the milestone. in: path @@ -100501,9 +103501,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: *713 + default: *714 '404': *6 x-github: githubCloudOnly: false @@ -100520,9 +103520,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#update-a-milestone parameters: - - *484 - *485 - - *714 + - *486 + - *715 requestBody: required: false content: @@ -100560,9 +103560,9 @@ paths: description: Response content: application/json: - schema: *712 + schema: *713 examples: - default: *713 + default: *714 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100578,9 +103578,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones#delete-a-milestone parameters: - - *484 - *485 - - *714 + - *486 + - *715 responses: '204': description: Response @@ -100601,9 +103601,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: - - *484 - *485 - - *714 + - *486 + - *715 - *17 - *19 responses: @@ -100615,7 +103615,7 @@ paths: type: array items: *228 examples: - default: *691 + default: *692 headers: Link: *47 x-github: @@ -100634,12 +103634,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: - - *484 - *485 - - *715 + - *486 - *716 - - *236 - *717 + - *236 + - *718 - *17 - *19 responses: @@ -100651,7 +103651,7 @@ paths: type: array items: *256 examples: - default: *718 + default: *719 headers: Link: *47 x-github: @@ -100675,8 +103675,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *484 - *485 + - *486 requestBody: required: false content: @@ -100734,14 +103734,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-a-apiname-pages-site parameters: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: &719 + schema: &720 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -100866,7 +103866,7 @@ paths: - custom_404 - public examples: - default: &720 + default: &721 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -100907,8 +103907,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-apiname-pages-site parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -100962,9 +103962,9 @@ paths: description: Response content: application/json: - schema: *719 + schema: *720 examples: - default: *720 + default: *721 '422': *15 '409': *121 x-github: @@ -100987,8 +103987,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -101095,8 +104095,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *484 - *485 + - *486 responses: '204': description: Response @@ -101122,8 +104122,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#list-apiname-pages-builds parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -101133,7 +104133,7 @@ paths: application/json: schema: type: array - items: &721 + items: &722 title: Page Build description: Page Build type: object @@ -101227,8 +104227,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#request-a-apiname-pages-build parameters: - - *484 - *485 + - *486 responses: '201': description: Response @@ -101273,16 +104273,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-latest-pages-build parameters: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: *721 + schema: *722 examples: - default: &722 + default: &723 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -101330,8 +104330,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#get-apiname-pages-build parameters: - - *484 - *485 + - *486 - name: build_id in: path required: true @@ -101342,9 +104342,9 @@ paths: description: Response content: application/json: - schema: *721 + schema: *722 examples: - default: *722 + default: *723 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101364,8 +104364,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#create-a-github-pages-deployment parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -101470,9 +104470,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: - - *484 - *485 - - &723 + - *486 + - &724 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -101530,9 +104530,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *484 - *485 - - *723 + - *486 + - *724 responses: '204': *130 '404': *6 @@ -101559,8 +104559,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -101818,8 +104818,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: - - *484 - *485 + - *486 responses: '200': description: Private vulnerability reporting status @@ -101856,8 +104856,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: - - *484 - *485 + - *486 responses: '204': *130 '422': *14 @@ -101878,8 +104878,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: - - *484 - *485 + - *486 responses: '204': *130 '422': *14 @@ -101901,8 +104901,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -101912,7 +104912,7 @@ paths: type: array items: *160 examples: - default: *724 + default: *725 '403': *29 '404': *6 x-github: @@ -101934,8 +104934,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -101951,7 +104951,7 @@ paths: required: - properties examples: - default: *725 + default: *726 responses: '204': description: No Content when custom property values are successfully created @@ -101989,8 +104989,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests parameters: - - *484 - *485 + - *486 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -102050,9 +105050,9 @@ paths: application/json: schema: type: array - items: *605 + items: *606 examples: - default: *726 + default: *727 headers: Link: *47 '304': *37 @@ -102084,8 +105084,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#create-a-pull-request parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -102150,7 +105150,7 @@ paths: description: Response content: application/json: - schema: &730 + schema: &731 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -102294,7 +105294,7 @@ paths: items: *4 requested_teams: type: array - items: *468 + items: *469 head: type: object properties: @@ -102350,7 +105350,7 @@ paths: - review_comment - self author_association: *226 - auto_merge: *727 + auto_merge: *728 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -102440,7 +105440,7 @@ paths: - merged_by - review_comments examples: - default: &731 + default: &732 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -102947,8 +105947,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *484 - *485 + - *486 - name: sort in: query required: false @@ -102977,9 +105977,9 @@ paths: application/json: schema: type: array - items: *728 + items: *729 examples: - default: &733 + default: &734 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -103056,17 +106056,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: - - *484 - *485 + - *486 - *245 responses: '200': description: Response content: application/json: - schema: *728 + schema: *729 examples: - default: &729 + default: &730 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -103141,8 +106141,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: - - *484 - *485 + - *486 - *245 requestBody: required: true @@ -103165,9 +106165,9 @@ paths: description: Response content: application/json: - schema: *728 + schema: *729 examples: - default: *729 + default: *730 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103183,8 +106183,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: - - *484 - *485 + - *486 - *245 responses: '204': @@ -103206,8 +106206,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: - - *484 - *485 + - *486 - *245 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#about-reactions). @@ -103234,9 +106234,9 @@ paths: application/json: schema: type: array - items: *599 + items: *600 examples: - default: *680 + default: *681 headers: Link: *47 '404': *6 @@ -103257,8 +106257,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: - - *484 - *485 + - *486 - *245 requestBody: required: true @@ -103291,16 +106291,16 @@ paths: description: Reaction exists content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 '201': description: Reaction created content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 '422': *15 x-github: githubCloudOnly: false @@ -103322,10 +106322,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *484 - *485 + - *486 - *245 - - *681 + - *682 responses: '204': description: Response @@ -103368,9 +106368,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#get-a-pull-request parameters: - - *484 - *485 - - &732 + - *486 + - &733 name: pull_number description: The number that identifies the pull request. in: path @@ -103383,9 +106383,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *730 + schema: *731 examples: - default: *731 + default: *732 '304': *37 '404': *6 '406': @@ -103420,9 +106420,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request parameters: - - *484 - *485 - - *732 + - *486 + - *733 requestBody: required: false content: @@ -103464,9 +106464,9 @@ paths: description: Response content: application/json: - schema: *730 + schema: *731 examples: - default: *731 + default: *732 '422': *15 '403': *29 x-github: @@ -103488,9 +106488,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#archive-a-pull-request parameters: - - *484 - *485 - - *732 + - *486 + - *733 responses: '204': description: Response @@ -103515,9 +106515,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#unarchive-a-pull-request parameters: - - *484 - *485 - - *732 + - *486 + - *733 responses: '204': description: Response @@ -103543,9 +106543,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: - - *484 - *485 - - *732 + - *486 + - *733 requestBody: required: true content: @@ -103607,7 +106607,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -103615,7 +106615,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '401': *25 '403': *29 '404': *6 @@ -103645,9 +106645,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: - - *484 - *485 - - *732 + - *486 + - *733 - *253 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -103668,9 +106668,9 @@ paths: application/json: schema: type: array - items: *728 + items: *729 examples: - default: *733 + default: *734 headers: Link: *47 x-github: @@ -103703,9 +106703,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: - - *484 - *485 - - *732 + - *486 + - *733 requestBody: required: true content: @@ -103810,7 +106810,7 @@ paths: description: Response content: application/json: - schema: *728 + schema: *729 examples: example-for-a-multi-line-comment: value: @@ -103898,9 +106898,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: - - *484 - *485 - - *732 + - *486 + - *733 - *245 requestBody: required: true @@ -103923,7 +106923,7 @@ paths: description: Response content: application/json: - schema: *728 + schema: *729 examples: default: value: @@ -104009,9 +107009,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *484 - *485 - - *732 + - *486 + - *733 - *17 - *19 responses: @@ -104021,9 +107021,9 @@ paths: application/json: schema: type: array - items: *601 + items: *602 examples: - default: *734 + default: *735 headers: Link: *47 x-github: @@ -104053,9 +107053,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#list-pull-requests-files parameters: - - *484 - *485 - - *732 + - *486 + - *733 - *17 - *19 responses: @@ -104065,7 +107065,7 @@ paths: application/json: schema: type: array - items: *614 + items: *615 examples: default: value: @@ -104103,9 +107103,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: - - *484 - *485 - - *732 + - *486 + - *733 responses: '204': description: Response if pull request has been merged @@ -104128,9 +107128,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#merge-a-pull-request parameters: - - *484 - *485 - - *732 + - *486 + - *733 requestBody: required: false content: @@ -104241,9 +107241,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: - - *484 - *485 - - *732 + - *486 + - *733 responses: '200': description: Response @@ -104318,9 +107318,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: - - *484 - *485 - - *732 + - *486 + - *733 requestBody: required: false content: @@ -104357,7 +107357,7 @@ paths: description: Response content: application/json: - schema: *605 + schema: *606 examples: default: value: @@ -104893,9 +107893,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: - - *484 - *485 - - *732 + - *486 + - *733 requestBody: required: true content: @@ -104929,7 +107929,7 @@ paths: description: Response content: application/json: - schema: *605 + schema: *606 examples: default: value: @@ -105414,9 +108414,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *484 - *485 - - *732 + - *486 + - *733 - *17 - *19 responses: @@ -105426,7 +108426,7 @@ paths: application/json: schema: type: array - items: &735 + items: &736 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -105577,9 +108577,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: - - *484 - *485 - - *732 + - *486 + - *733 requestBody: required: false content: @@ -105665,9 +108665,9 @@ paths: description: Response content: application/json: - schema: *735 + schema: *736 examples: - default: &737 + default: &738 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -105730,10 +108730,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: - - *484 - *485 - - *732 - - &736 + - *486 + - *733 + - &737 name: review_id description: The unique identifier of the review. in: path @@ -105745,9 +108745,9 @@ paths: description: Response content: application/json: - schema: *735 + schema: *736 examples: - default: &738 + default: &739 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -105806,10 +108806,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: - - *484 - *485 - - *732 - - *736 + - *486 + - *733 + - *737 requestBody: required: true content: @@ -105832,7 +108832,7 @@ paths: description: Response content: application/json: - schema: *735 + schema: *736 examples: default: value: @@ -105894,18 +108894,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: - - *484 - *485 - - *732 - - *736 + - *486 + - *733 + - *737 responses: '200': description: Response content: application/json: - schema: *735 + schema: *736 examples: - default: *737 + default: *738 '422': *7 '404': *6 x-github: @@ -105932,10 +108932,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: - - *484 - *485 - - *732 - - *736 + - *486 + - *733 + - *737 - *17 - *19 responses: @@ -106170,10 +109170,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: - - *484 - *485 - - *732 - - *736 + - *486 + - *733 + - *737 requestBody: required: true content: @@ -106201,7 +109201,7 @@ paths: description: Response content: application/json: - schema: *735 + schema: *736 examples: default: value: @@ -106264,10 +109264,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: - - *484 - *485 - - *732 - - *736 + - *486 + - *733 + - *737 requestBody: required: true content: @@ -106302,9 +109302,9 @@ paths: description: Response content: application/json: - schema: *735 + schema: *736 examples: - default: *738 + default: *739 '404': *6 '422': *7 '403': *29 @@ -106326,9 +109326,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *484 - *485 - - *732 + - *486 + - *733 requestBody: required: false content: @@ -106391,8 +109391,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#get-a-repository-readme parameters: - - *484 - *485 + - *486 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -106405,9 +109405,9 @@ paths: description: Response content: application/json: - schema: *739 + schema: *740 examples: - default: &740 + default: &741 value: type: file encoding: base64 @@ -106449,8 +109449,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: - - *484 - *485 + - *486 - name: dir description: The alternate path to look for a README file in: path @@ -106470,9 +109470,9 @@ paths: description: Response content: application/json: - schema: *739 + schema: *740 examples: - default: *740 + default: *741 '404': *6 '422': *15 x-github: @@ -106494,8 +109494,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#list-releases parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -106505,7 +109505,7 @@ paths: application/json: schema: type: array - items: *741 + items: *742 examples: default: value: @@ -106599,8 +109599,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#create-a-release parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -106676,9 +109676,9 @@ paths: description: Response content: application/json: - schema: *741 + schema: *742 examples: - default: &745 + default: &746 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -106783,9 +109783,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#get-a-release-asset parameters: - - *484 - *485 - - &743 + - *486 + - &744 name: asset_id description: The unique identifier of the asset. in: path @@ -106797,9 +109797,9 @@ paths: description: Response content: application/json: - schema: *742 + schema: *743 examples: - default: &744 + default: &745 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 @@ -106834,7 +109834,7 @@ paths: type: User site_admin: false '404': *6 - '302': *618 + '302': *619 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106850,9 +109850,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#update-a-release-asset parameters: - - *484 - *485 - - *743 + - *486 + - *744 requestBody: required: false content: @@ -106880,9 +109880,9 @@ paths: description: Response content: application/json: - schema: *742 + schema: *743 examples: - default: *744 + default: *745 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106898,9 +109898,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#delete-a-release-asset parameters: - - *484 - *485 - - *743 + - *486 + - *744 responses: '204': description: Response @@ -106925,8 +109925,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -107011,16 +110011,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-the-latest-release parameters: - - *484 - *485 + - *486 responses: '200': description: Response content: application/json: - schema: *741 + schema: *742 examples: - default: *745 + default: *746 '404': *6 x-github: githubCloudOnly: false @@ -107038,8 +110038,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release-by-tag-name parameters: - - *484 - *485 + - *486 - name: tag description: tag parameter in: path @@ -107052,9 +110052,9 @@ paths: description: Response content: application/json: - schema: *741 + schema: *742 examples: - default: *745 + default: *746 '404': *6 x-github: githubCloudOnly: false @@ -107076,9 +110076,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#get-a-release parameters: - - *484 - *485 - - &746 + - *486 + - &747 name: release_id description: The unique identifier of the release. in: path @@ -107092,9 +110092,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: *741 + schema: *742 examples: - default: *745 + default: *746 '401': description: Unauthorized x-github: @@ -107112,9 +110112,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#update-a-release parameters: - - *484 - *485 - - *746 + - *486 + - *747 requestBody: required: false content: @@ -107178,9 +110178,9 @@ paths: description: Response content: application/json: - schema: *741 + schema: *742 examples: - default: *745 + default: *746 '404': description: Not Found if the discussion category name is invalid content: @@ -107201,9 +110201,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/releases#delete-a-release parameters: - - *484 - *485 - - *746 + - *486 + - *747 responses: '204': description: Response @@ -107224,9 +110224,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/releases/assets#list-release-assets parameters: - - *484 - *485 - - *746 + - *486 + - *747 - *17 - *19 responses: @@ -107236,7 +110236,7 @@ paths: application/json: schema: type: array - items: *742 + items: *743 examples: default: value: @@ -107318,9 +110318,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: - - *484 - *485 - - *746 + - *486 + - *747 - name: name in: query required: true @@ -107346,7 +110346,7 @@ paths: description: Response for successful upload content: application/json: - schema: *742 + schema: *743 examples: response-for-successful-upload: value: @@ -107401,9 +110401,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *484 - *485 - - *746 + - *486 + - *747 - 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. @@ -107427,9 +110427,9 @@ paths: application/json: schema: type: array - items: *599 + items: *600 examples: - default: *680 + default: *681 headers: Link: *47 '404': *6 @@ -107450,9 +110450,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *484 - *485 - - *746 + - *486 + - *747 requestBody: required: true content: @@ -107482,16 +110482,16 @@ paths: description: Reaction exists content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 '201': description: Reaction created content: application/json: - schema: *599 + schema: *600 examples: - default: *600 + default: *601 '422': *15 x-github: githubCloudOnly: false @@ -107513,10 +110513,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/reactions/reactions#delete-a-release-reaction parameters: - - *484 - *485 - - *746 - - *681 + - *486 + - *747 + - *682 responses: '204': description: Response @@ -107540,9 +110540,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-rules-for-a-branch parameters: - - *484 - *485 - - *537 + - *486 + - *538 - *17 - *19 responses: @@ -107559,7 +110559,7 @@ paths: oneOf: - allOf: - *174 - - &747 + - &748 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -107580,67 +110580,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *175 - - *747 + - *748 - allOf: - *176 - - *747 + - *748 - allOf: - *177 - - *747 + - *748 - allOf: + - *749 - *748 - - *747 - allOf: - *178 - - *747 + - *748 - allOf: - *179 - - *747 + - *748 - allOf: - *180 - - *747 + - *748 - allOf: - *181 - - *747 + - *748 - allOf: - *182 - - *747 + - *748 - allOf: - *183 - - *747 + - *748 - allOf: - *184 - - *747 + - *748 - allOf: - *185 - - *747 + - *748 - allOf: - *186 - - *747 + - *748 - allOf: - *187 - - *747 + - *748 - allOf: - *188 - - *747 + - *748 - allOf: - *189 - - *747 + - *748 - allOf: - *190 - - *747 + - *748 - allOf: - *191 - - *747 + - *748 - allOf: - *192 - - *747 + - *748 - allOf: - *193 - - *747 + - *748 - allOf: - *194 - - *747 + - *748 examples: default: value: @@ -107679,8 +110679,8 @@ paths: category: repos subcategory: rules parameters: - - *484 - *485 + - *486 - *17 - *19 - name: includes_parents @@ -107691,7 +110691,7 @@ paths: schema: type: boolean default: true - - *749 + - *750 responses: '200': description: Response @@ -107746,8 +110746,8 @@ paths: category: repos subcategory: rules parameters: - - *484 - *485 + - *486 requestBody: description: Request body required: true @@ -107776,7 +110776,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *750 + items: *751 required: - name - enforcement @@ -107809,7 +110809,7 @@ paths: application/json: schema: *195 examples: - default: &759 + default: &760 value: id: 42 name: super cool ruleset @@ -107857,12 +110857,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *484 - *485 - - *751 - - *107 + - *486 - *752 + - *107 - *753 + - *754 - *17 - *19 responses: @@ -107870,9 +110870,9 @@ paths: description: Response content: application/json: - schema: *754 + schema: *755 examples: - default: *755 + default: *756 '404': *6 '500': *40 x-github: @@ -107893,17 +110893,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *484 - *485 - - *756 + - *486 + - *757 responses: '200': description: Response content: application/json: - schema: *757 + schema: *758 examples: - default: *758 + default: *759 '404': *6 '500': *40 x-github: @@ -107931,8 +110931,8 @@ paths: category: repos subcategory: rules parameters: - - *484 - *485 + - *486 - name: ruleset_id description: The ID of the ruleset. in: path @@ -107954,7 +110954,7 @@ paths: application/json: schema: *195 examples: - default: *759 + default: *760 '404': *6 '500': *40 put: @@ -107972,8 +110972,8 @@ paths: category: repos subcategory: rules parameters: - - *484 - *485 + - *486 - name: ruleset_id description: The ID of the ruleset. in: path @@ -108007,7 +111007,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *750 + items: *751 examples: default: value: @@ -108037,7 +111037,7 @@ paths: application/json: schema: *195 examples: - default: *759 + default: *760 '404': *6 '422': *15 '500': *40 @@ -108056,8 +111056,8 @@ paths: category: repos subcategory: rules parameters: - - *484 - *485 + - *486 - name: ruleset_id description: The ID of the ruleset. in: path @@ -108080,8 +111080,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-history parameters: - - *484 - *485 + - *486 - *17 - *19 - name: ruleset_id @@ -108118,8 +111118,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/rules#get-repository-ruleset-version parameters: - - *484 - *485 + - *486 - name: ruleset_id description: The ID of the ruleset. in: path @@ -108192,8 +111192,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: - - *484 - *485 + - *486 - *451 - *452 - *453 @@ -108205,12 +111205,13 @@ paths: - *112 - *19 - *17 - - *760 - *761 + - *762 - *459 - *460 - *461 - *462 + - *463 responses: '200': description: Response @@ -108218,7 +111219,7 @@ paths: application/json: schema: type: array - items: &765 + items: &766 type: object properties: number: *131 @@ -108237,8 +111238,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *762 - resolution: *763 + state: *763 + resolution: *764 resolved_at: type: string format: date-time @@ -108344,7 +111345,7 @@ paths: pull request. ' - oneOf: *764 + oneOf: *765 nullable: true has_more_locations: type: boolean @@ -108508,16 +111509,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: - - *484 - *485 - - *565 + - *486 + - *566 - *462 responses: '200': description: Response content: application/json: - schema: *765 + schema: *766 examples: default: value: @@ -108571,9 +111572,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: - - *484 - *485 - - *565 + - *486 + - *566 requestBody: required: true content: @@ -108581,8 +111582,8 @@ paths: schema: type: object properties: - state: *762 - resolution: *763 + state: *763 + resolution: *764 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -108626,7 +111627,7 @@ paths: description: Response content: application/json: - schema: *765 + schema: *766 examples: default: value: @@ -108693,6 +111694,9 @@ paths: '400': description: Bad request, resolution comment is invalid or the resolution was not changed. + '403': + description: Delegated alert dismissal is enabled and the authenticated + user is not a valid reviewer. '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found @@ -108722,9 +111726,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: - - *484 - *485 - - *565 + - *486 + - *566 - *19 - *17 responses: @@ -108735,7 +111739,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &952 + items: &953 type: object properties: type: @@ -108761,7 +111765,6 @@ paths: example: commit details: oneOf: - - *766 - *767 - *768 - *769 @@ -108774,6 +111777,7 @@ paths: - *776 - *777 - *778 + - *779 examples: default: value: @@ -108859,8 +111863,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -108868,14 +111872,14 @@ paths: schema: type: object properties: - reason: &780 + reason: &781 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *779 + placeholder_id: *780 required: - reason - placeholder_id @@ -108892,7 +111896,7 @@ paths: schema: type: object properties: - reason: *780 + reason: *781 expire_at: type: string format: date-time @@ -108938,8 +111942,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: - - *484 - *485 + - *486 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -108954,7 +111958,7 @@ paths: properties: incremental_scans: type: array - items: &781 + items: &782 description: Information on a single scan performed by secret scanning on the repository type: object @@ -108980,15 +111984,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *781 + items: *782 backfill_scans: type: array - items: *781 + items: *782 custom_pattern_backfill_scans: type: array items: allOf: - - *781 + - *782 - type: object properties: pattern_name: @@ -109001,7 +112005,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *781 + items: *782 examples: default: value: @@ -109066,8 +112070,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *484 - *485 + - *486 - *112 - name: sort description: The property to sort the results by. @@ -109111,9 +112115,9 @@ paths: application/json: schema: type: array - items: *782 + items: *783 examples: - default: *783 + default: *784 '400': *14 '404': *6 x-github: @@ -109136,8 +112140,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -109210,7 +112214,7 @@ paths: login: type: string description: The username of the user credited. - type: *467 + type: *468 required: - login - type @@ -109297,9 +112301,9 @@ paths: description: Response content: application/json: - schema: *782 + schema: *783 examples: - default: &785 + default: &786 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -109529,8 +112533,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: - - *484 - *485 + - *486 requestBody: required: true content: @@ -109634,7 +112638,7 @@ paths: description: Response content: application/json: - schema: *782 + schema: *783 examples: default: value: @@ -109780,17 +112784,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: - - *484 - *485 - - *784 + - *486 + - *785 responses: '200': description: Response content: application/json: - schema: *782 + schema: *783 examples: - default: *785 + default: *786 '403': *29 '404': *6 x-github: @@ -109814,9 +112818,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: - - *484 - *485 - - *784 + - *486 + - *785 requestBody: required: true content: @@ -109889,7 +112893,7 @@ paths: login: type: string description: The username of the user credited. - type: *467 + type: *468 required: - login - type @@ -109975,10 +112979,10 @@ paths: description: Response content: application/json: - schema: *782 + schema: *783 examples: - default: *785 - add_credit: *785 + default: *786 + add_credit: *786 '403': *29 '404': *6 '422': @@ -110016,9 +113020,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: - - *484 - *485 - - *784 + - *486 + - *785 responses: '202': *39 '400': *14 @@ -110045,17 +113049,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: - - *484 - *485 - - *784 + - *486 + - *785 responses: '202': description: Response content: application/json: - schema: *489 + schema: *490 examples: - default: *491 + default: *492 '400': *14 '422': *15 '403': *29 @@ -110081,8 +113085,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-stargazers parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -110181,8 +113185,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *484 - *485 + - *486 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -110191,7 +113195,7 @@ paths: application/json: schema: type: array - items: &786 + items: &787 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -110224,8 +113228,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: - - *484 - *485 + - *486 responses: '200': description: Response @@ -110301,8 +113305,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *484 - *485 + - *486 responses: '200': description: Response @@ -110398,8 +113402,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *484 - *485 + - *486 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -110553,8 +113557,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: - - *484 - *485 + - *486 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -110564,7 +113568,7 @@ paths: application/json: schema: type: array - items: *786 + items: *787 examples: default: value: @@ -110597,8 +113601,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses#create-a-commit-status parameters: - - *484 - *485 + - *486 - name: sha in: path required: true @@ -110652,7 +113656,7 @@ paths: description: Response content: application/json: - schema: *787 + schema: *788 examples: default: value: @@ -110706,8 +113710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#list-watchers parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -110739,14 +113743,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#get-a-repository-subscription parameters: - - *484 - *485 + - *486 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &788 + schema: &789 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -110814,8 +113818,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#set-a-repository-subscription parameters: - - *484 - *485 + - *486 requestBody: required: false content: @@ -110841,7 +113845,7 @@ paths: description: Response content: application/json: - schema: *788 + schema: *789 examples: default: value: @@ -110868,8 +113872,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/activity/watching#delete-a-repository-subscription parameters: - - *484 - *485 + - *486 responses: '204': description: Response @@ -110889,8 +113893,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-tags parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -110969,8 +113973,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *484 - *485 + - *486 - name: ref in: path required: true @@ -111006,8 +114010,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#list-repository-teams parameters: - - *484 - *485 + - *486 - *17 - *19 responses: @@ -111039,8 +114043,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-all-repository-topics parameters: - - *484 - *485 + - *486 - *19 - *17 responses: @@ -111048,7 +114052,7 @@ paths: description: Response content: application/json: - schema: &789 + schema: &790 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -111060,7 +114064,7 @@ paths: required: - names examples: - default: &790 + default: &791 value: names: - octocat @@ -111083,8 +114087,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#replace-all-repository-topics parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -111115,9 +114119,9 @@ paths: description: Response content: application/json: - schema: *789 + schema: *790 examples: - default: *790 + default: *791 '404': *6 '422': *7 x-github: @@ -111138,9 +114142,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-repository-clones parameters: - - *484 - *485 - - &791 + - *486 + - &792 name: per description: The time frame to display results for. in: query @@ -111169,7 +114173,7 @@ paths: example: 128 clones: type: array - items: &792 + items: &793 title: Traffic type: object properties: @@ -111256,8 +114260,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-paths parameters: - - *484 - *485 + - *486 responses: '200': description: Response @@ -111347,8 +114351,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-top-referral-sources parameters: - - *484 - *485 + - *486 responses: '200': description: Response @@ -111408,9 +114412,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/metrics/traffic#get-page-views parameters: - - *484 - *485 - - *791 + - *486 + - *792 responses: '200': description: Response @@ -111429,7 +114433,7 @@ paths: example: 3782 views: type: array - items: *792 + items: *793 required: - uniques - count @@ -111506,8 +114510,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#transfer-a-repository parameters: - - *484 - *485 + - *486 requestBody: required: true content: @@ -111780,8 +114784,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: - - *484 - *485 + - *486 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -111804,8 +114808,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#enable-vulnerability-alerts parameters: - - *484 - *485 + - *486 responses: '204': description: Response @@ -111827,8 +114831,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#disable-vulnerability-alerts parameters: - - *484 - *485 + - *486 responses: '204': description: Response @@ -111854,8 +114858,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *484 - *485 + - *486 - name: ref in: path required: true @@ -111947,9 +114951,9 @@ paths: description: Response content: application/json: - schema: *489 + schema: *490 examples: - default: *491 + default: *492 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -112100,7 +115104,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &800 + - &801 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -112109,7 +115113,7 @@ paths: schema: type: string example: members - - &805 + - &806 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -112120,7 +115124,7 @@ paths: default: 1 format: int32 example: 1 - - &806 + - &807 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -112162,7 +115166,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &795 + items: &796 allOf: - type: object required: @@ -112237,7 +115241,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: &807 + meta: &808 type: object description: The metadata associated with the creation/updates to the user. @@ -112297,30 +115301,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &796 + '400': &797 description: Bad request content: application/json: - schema: *793 + schema: *794 application/scim+json: - schema: *793 - '401': *794 - '403': &797 + schema: *794 + '401': *795 + '403': &798 description: Permission denied - '429': &798 + '429': &799 description: Too many requests content: application/json: - schema: *793 + schema: *794 application/scim+json: - schema: *793 - '500': &799 + schema: *794 + '500': &800 description: Internal server error content: application/json: - schema: *793 + schema: *794 application/scim+json: - schema: *793 + schema: *794 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -112344,7 +115348,7 @@ paths: required: true content: application/json: - schema: &803 + schema: &804 type: object required: - schemas @@ -112404,9 +115408,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *795 + schema: *796 examples: - group: &801 + group: &802 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -112425,13 +115429,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': *796 - '401': *794 - '403': *797 - '409': &804 + '400': *797 + '401': *795 + '403': *798 + '409': &805 description: Duplicate record detected - '429': *798 - '500': *799 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -112448,7 +115452,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: - - &802 + - &803 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -112456,22 +115460,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *800 + - *801 - *41 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *795 + schema: *796 examples: - default: *801 - '400': *796 - '401': *794 - '403': *797 + default: *802 + '400': *797 + '401': *795 + '403': *798 '404': *6 - '429': *798 - '500': *799 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -112490,13 +115494,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: - - *802 + - *803 - *41 requestBody: required: true content: application/json: - schema: *803 + schema: *804 examples: group: summary: Group @@ -112522,17 +115526,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *795 + schema: *796 examples: - group: *801 - groupWithMembers: *801 - '400': *796 - '401': *794 - '403': *797 + group: *802 + groupWithMembers: *802 + '400': *797 + '401': *795 + '403': *798 '404': *6 - '409': *804 - '429': *798 - '500': *799 + '409': *805 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -112556,13 +115560,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: - - *802 + - *803 - *41 requestBody: required: true content: application/json: - schema: &814 + schema: &815 type: object required: - Operations @@ -112622,17 +115626,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *795 + schema: *796 examples: - updateGroup: *801 - addMembers: *801 - '400': *796 - '401': *794 - '403': *797 + updateGroup: *802 + addMembers: *802 + '400': *797 + '401': *795 + '403': *798 '404': *6 - '409': *804 - '429': *798 - '500': *799 + '409': *805 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -112648,17 +115652,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: - - *802 + - *803 - *41 responses: '204': description: Group was deleted, no content - '400': *796 - '401': *794 - '403': *797 + '400': *797 + '401': *795 + '403': *798 '404': *6 - '429': *798 - '500': *799 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -112692,8 +115696,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *805 - *806 + - *807 - *41 responses: '200': @@ -112726,7 +115730,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &809 + items: &810 allOf: - type: object required: @@ -112805,7 +115809,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &808 + roles: &809 type: array description: The roles assigned to the user. items: @@ -112861,7 +115865,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *807 + meta: *808 startIndex: type: integer description: A starting index for the returned page @@ -112898,11 +115902,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *796 - '401': *794 - '403': *797 - '429': *798 - '500': *799 + '400': *797 + '401': *795 + '403': *798 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -112926,7 +115930,7 @@ paths: required: true content: application/json: - schema: &812 + schema: &813 type: object required: - schemas @@ -113008,9 +116012,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *808 + roles: *809 examples: - user: &813 + user: &814 summary: User value: schemas: @@ -113057,9 +116061,9 @@ paths: description: User has been created content: application/scim+json: - schema: *809 + schema: *810 examples: - user: &810 + user: &811 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -113085,13 +116089,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: *810 - '400': *796 - '401': *794 - '403': *797 - '409': *804 - '429': *798 - '500': *799 + enterpriseOwner: *811 + '400': *797 + '401': *795 + '403': *798 + '409': *805 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113108,7 +116112,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: - - &811 + - &812 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -113121,15 +116125,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *809 + schema: *810 examples: - default: *810 - '400': *796 - '401': *794 - '403': *797 + default: *811 + '400': *797 + '401': *795 + '403': *798 '404': *6 - '429': *798 - '500': *799 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113180,30 +116184,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: - - *811 + - *812 - *41 requestBody: required: true content: application/json: - schema: *812 + schema: *813 examples: - user: *813 + user: *814 responses: '200': description: User was updated content: application/scim+json: - schema: *809 + schema: *810 examples: - user: *810 - '400': *796 - '401': *794 - '403': *797 + user: *811 + '400': *797 + '401': *795 + '403': *798 '404': *6 - '409': *804 - '429': *798 - '500': *799 + '409': *805 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113244,13 +116248,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: - - *811 + - *812 - *41 requestBody: required: true content: application/json: - schema: *814 + schema: *815 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -113290,18 +116294,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *809 + schema: *810 examples: - userMultiValuedProperties: *810 - userSingleValuedProperties: *810 - disableUser: *810 - '400': *796 - '401': *794 - '403': *797 + userMultiValuedProperties: *811 + userSingleValuedProperties: *811 + disableUser: *811 + '400': *797 + '401': *795 + '403': *798 '404': *6 - '409': *804 - '429': *798 - '500': *799 + '409': *805 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113321,17 +116325,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: - - *811 + - *812 - *41 responses: '204': description: User was deleted, no content - '400': *796 - '401': *794 - '403': *797 + '400': *797 + '401': *795 + '403': *798 '404': *6 - '429': *798 - '500': *799 + '429': *799 + '500': *800 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -113418,7 +116422,7 @@ paths: example: 1 Resources: type: array - items: &815 + items: &816 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -113649,22 +116653,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': *37 - '404': &816 + '404': &817 description: Resource not found content: application/json: - schema: *793 + schema: *794 application/scim+json: - schema: *793 - '403': &817 + schema: *794 + '403': &818 description: Forbidden content: application/json: - schema: *793 + schema: *794 application/scim+json: - schema: *793 - '400': *796 - '429': *798 + schema: *794 + '400': *797 + '429': *799 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -113690,9 +116694,9 @@ paths: description: Response content: application/scim+json: - schema: *815 + schema: *816 examples: - default: &818 + default: &819 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -113715,17 +116719,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': *37 - '404': *816 - '403': *817 - '500': *799 + '404': *817 + '403': *818 + '500': *800 '409': description: Conflict content: application/json: - schema: *793 + schema: *794 application/scim+json: - schema: *793 - '400': *796 + schema: *794 + '400': *797 requestBody: required: true content: @@ -113823,17 +116827,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *89 - - *811 + - *812 responses: '200': description: Response content: application/scim+json: - schema: *815 + schema: *816 examples: - default: *818 - '404': *816 - '403': *817 + default: *819 + '404': *817 + '403': *818 '304': *37 x-github: githubCloudOnly: true @@ -113857,18 +116861,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-a-provisioned-organization-membership parameters: - *89 - - *811 + - *812 responses: '200': description: Response content: application/scim+json: - schema: *815 + schema: *816 examples: - default: *818 + default: *819 '304': *37 - '404': *816 - '403': *817 + '404': *817 + '403': *818 requestBody: required: true content: @@ -113981,19 +116985,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *89 - - *811 + - *812 responses: '200': description: Response content: application/scim+json: - schema: *815 + schema: *816 examples: - default: *818 + default: *819 '304': *37 - '404': *816 - '403': *817 - '400': *796 + '404': *817 + '403': *818 + '400': *797 '429': description: Response content: @@ -114084,12 +117088,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *89 - - *811 + - *812 responses: '204': description: Response - '404': *816 - '403': *817 + '404': *817 + '403': *818 '304': *37 x-github: githubCloudOnly: true @@ -114225,7 +117229,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &819 + text_matches: &820 title: Search Result Text Matches type: array items: @@ -114388,7 +117392,7 @@ paths: enum: - author-date - committer-date - - &820 + - &821 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 @@ -114459,7 +117463,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *535 + properties: *536 nullable: true comment_count: type: integer @@ -114479,7 +117483,7 @@ paths: url: type: string format: uri - verification: *664 + verification: *665 required: - author - committer @@ -114498,7 +117502,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *535 + properties: *536 nullable: true parents: type: array @@ -114516,7 +117520,7 @@ paths: type: number node_id: type: string - text_matches: *819 + text_matches: *820 required: - sha - node_id @@ -114709,7 +117713,7 @@ paths: - interactions - created - updated - - *820 + - *821 - *17 - *19 - name: advanced_search @@ -114823,11 +117827,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: type: string state_reason: @@ -114852,7 +117856,7 @@ paths: type: string format: date-time nullable: true - text_matches: *819 + text_matches: *820 pull_request: type: object properties: @@ -115122,7 +118126,7 @@ paths: enum: - created - updated - - *820 + - *821 - *17 - *19 responses: @@ -115166,7 +118170,7 @@ paths: nullable: true score: type: number - text_matches: *819 + text_matches: *820 required: - id - node_id @@ -115252,7 +118256,7 @@ paths: - forks - help-wanted-issues - updated - - *820 + - *821 - *17 - *19 responses: @@ -115500,7 +118504,7 @@ paths: - admin - pull - push - text_matches: *819 + text_matches: *820 temp_clone_token: type: string allow_merge_commit: @@ -115801,7 +118805,7 @@ paths: type: string format: uri nullable: true - text_matches: *819 + text_matches: *820 related: type: array nullable: true @@ -115994,7 +118998,7 @@ paths: - followers - repositories - joined - - *820 + - *821 - *17 - *19 responses: @@ -116098,7 +119102,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *819 + text_matches: *820 blog: type: string nullable: true @@ -116177,7 +119181,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#get-a-team-legacy parameters: - - &823 + - &824 name: team_id description: The unique identifier of the team. in: path @@ -116189,9 +119193,9 @@ paths: description: Response content: application/json: - schema: *476 + schema: *477 examples: - default: *477 + default: *478 '404': *6 x-github: githubCloudOnly: false @@ -116218,7 +119222,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#update-a-team-legacy parameters: - - *823 + - *824 requestBody: required: true content: @@ -116281,16 +119285,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *476 + schema: *477 examples: - default: *477 + default: *478 '201': description: Response content: application/json: - schema: *476 + schema: *477 examples: - default: *477 + default: *478 '404': *6 '422': *15 '403': *29 @@ -116318,7 +119322,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#delete-a-team-legacy parameters: - - *823 + - *824 responses: '204': description: Response @@ -116347,7 +119351,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *823 + - *824 - *17 - *19 responses: @@ -116385,7 +119389,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#list-team-members-legacy parameters: - - *823 + - *824 - name: role description: Filters members returned by their role in the team. in: query @@ -116436,7 +119440,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#get-team-member-legacy parameters: - - *823 + - *824 - *148 responses: '204': @@ -116473,7 +119477,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#add-team-member-legacy parameters: - - *823 + - *824 - *148 responses: '204': @@ -116513,7 +119517,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/members#remove-team-member-legacy parameters: - - *823 + - *824 - *148 responses: '204': @@ -116550,16 +119554,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: - - *823 + - *824 - *148 responses: '200': description: Response content: application/json: - schema: *483 + schema: *484 examples: - response-if-user-is-a-team-maintainer: *824 + response-if-user-is-a-team-maintainer: *825 '404': *6 x-github: githubCloudOnly: false @@ -116592,7 +119596,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: - - *823 + - *824 - *148 requestBody: required: false @@ -116618,9 +119622,9 @@ paths: description: Response content: application/json: - schema: *483 + schema: *484 examples: - response-if-users-membership-with-team-is-now-pending: *825 + response-if-users-membership-with-team-is-now-pending: *826 '403': description: Forbidden if team synchronization is set up '422': @@ -116654,7 +119658,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: - - *823 + - *824 - *148 responses: '204': @@ -116682,7 +119686,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-team-repositories-legacy parameters: - - *823 + - *824 - *17 - *19 responses: @@ -116724,15 +119728,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: - - *823 - - *484 + - *824 - *485 + - *486 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *826 + schema: *827 examples: alternative-response-with-extra-repository-information: value: @@ -116882,9 +119886,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: - - *823 - - *484 + - *824 - *485 + - *486 requestBody: required: false content: @@ -116934,9 +119938,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: - - *823 - - *484 + - *824 - *485 + - *486 responses: '204': description: Response @@ -116965,15 +119969,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: - - *823 + - *824 responses: '200': description: Response content: application/json: - schema: *486 + schema: *487 examples: - default: *487 + default: *488 '403': *29 '404': *6 x-github: @@ -117000,7 +120004,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: - - *823 + - *824 requestBody: required: true content: @@ -117057,7 +120061,7 @@ paths: description: Response content: application/json: - schema: *486 + schema: *487 examples: default: value: @@ -117088,7 +120092,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/teams/teams#list-child-teams-legacy parameters: - - *823 + - *824 - *17 - *19 responses: @@ -117100,7 +120104,7 @@ paths: type: array items: *319 examples: - response-if-child-teams-exist: *827 + response-if-child-teams-exist: *828 headers: Link: *47 '404': *6 @@ -117133,7 +120137,7 @@ paths: application/json: schema: oneOf: - - &828 + - &829 title: Private User description: Private User type: object @@ -117336,7 +120340,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - &854 + - &855 title: Public User description: Public User type: object @@ -117648,7 +120652,7 @@ paths: description: Response content: application/json: - schema: *828 + schema: *829 examples: default: value: @@ -117994,7 +120998,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -118002,7 +121006,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '401': *25 '403': *29 '404': *6 @@ -118046,7 +121050,7 @@ paths: type: integer secrets: type: array - items: &829 + items: &830 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -118086,7 +121090,7 @@ paths: - visibility - selected_repositories_url examples: - default: *591 + default: *592 headers: Link: *47 x-github: @@ -118162,7 +121166,7 @@ paths: description: Response content: application/json: - schema: *829 + schema: *830 examples: default: value: @@ -118460,7 +121464,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '304': *37 '500': *40 '401': *25 @@ -118518,7 +121522,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '401': *25 '403': *29 '404': *6 @@ -118575,7 +121579,7 @@ paths: description: Response content: application/json: - schema: &830 + schema: &831 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -118616,7 +121620,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &831 + default: &832 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -118661,9 +121665,9 @@ paths: description: Response content: application/json: - schema: *830 + schema: *831 examples: - default: *831 + default: *832 '404': *6 x-github: githubCloudOnly: false @@ -118700,9 +121704,9 @@ paths: type: integer machines: type: array - items: *832 + items: *833 examples: - default: *833 + default: *834 '304': *37 '500': *40 '401': *25 @@ -118781,13 +121785,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *489 + repository: *490 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *589 - required: *590 + properties: *590 + required: *591 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -119569,7 +122573,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '304': *37 '500': *40 '400': *14 @@ -119609,7 +122613,7 @@ paths: application/json: schema: *399 examples: - default: *588 + default: *589 '500': *40 '401': *25 '403': *29 @@ -119641,7 +122645,7 @@ paths: type: array items: *410 examples: - default: &844 + default: &845 value: - id: 197 name: hello_docker @@ -119742,7 +122746,7 @@ paths: application/json: schema: type: array - items: &834 + items: &835 title: Email description: Email type: object @@ -119807,9 +122811,9 @@ paths: application/json: schema: type: array - items: *834 + items: *835 examples: - default: &846 + default: &847 value: - email: octocat@github.com verified: true @@ -119884,7 +122888,7 @@ paths: application/json: schema: type: array - items: *834 + items: *835 examples: default: value: @@ -120140,7 +123144,7 @@ paths: application/json: schema: type: array - items: &835 + items: &836 title: GPG Key description: A unique encryption key type: object @@ -120271,7 +123275,7 @@ paths: - subkeys - revoked examples: - default: &864 + default: &865 value: - id: 3 name: Octocat's GPG Key @@ -120356,9 +123360,9 @@ paths: description: Response content: application/json: - schema: *835 + schema: *836 examples: - default: &836 + default: &837 value: id: 3 name: Octocat's GPG Key @@ -120415,7 +123419,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: - - &837 + - &838 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -120427,9 +123431,9 @@ paths: description: Response content: application/json: - schema: *835 + schema: *836 examples: - default: *836 + default: *837 '404': *6 '304': *37 '403': *29 @@ -120452,7 +123456,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: - - *837 + - *838 responses: '204': description: Response @@ -120760,7 +123764,7 @@ paths: required: true content: application/json: - schema: *674 + schema: *675 examples: default: value: @@ -120910,7 +123914,7 @@ paths: application/json: schema: type: array - items: &838 + items: &839 title: Key description: Key type: object @@ -121011,9 +124015,9 @@ paths: description: Response content: application/json: - schema: *838 + schema: *839 examples: - default: &839 + default: &840 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -121046,15 +124050,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: - - *709 + - *710 responses: '200': description: Response content: application/json: - schema: *838 + schema: *839 examples: - default: *839 + default: *840 '404': *6 '304': *37 '403': *29 @@ -121077,7 +124081,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: - - *709 + - *710 responses: '204': description: Response @@ -121110,7 +124114,7 @@ paths: application/json: schema: type: array - items: &840 + items: &841 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -121178,7 +124182,7 @@ paths: - account - plan examples: - default: &841 + default: &842 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -121240,9 +124244,9 @@ paths: application/json: schema: type: array - items: *840 + items: *841 examples: - default: *841 + default: *842 headers: Link: *47 '304': *37 @@ -122251,7 +125255,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/migrations/users#unlock-a-user-repository parameters: - *405 - - *842 + - *843 responses: '204': description: Response @@ -122364,7 +125368,7 @@ paths: - docker - nuget - container - - *843 + - *844 - *19 - *17 responses: @@ -122376,8 +125380,8 @@ paths: type: array items: *410 examples: - default: *844 - '400': *845 + default: *845 + '400': *846 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122406,7 +125410,7 @@ paths: application/json: schema: *410 examples: - default: &865 + default: &866 value: id: 40201 name: octo-name @@ -122768,9 +125772,9 @@ paths: application/json: schema: type: array - items: *834 + items: *835 examples: - default: *846 + default: *847 headers: Link: *47 '304': *37 @@ -122883,7 +125887,7 @@ paths: type: array items: *80 examples: - default: &853 + default: &854 summary: Default response value: - id: 1296269 @@ -123187,9 +126191,9 @@ paths: description: Response content: application/json: - schema: *489 + schema: *490 examples: - default: *491 + default: *492 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -123228,9 +126232,9 @@ paths: application/json: schema: type: array - items: *676 + items: *677 examples: - default: *847 + default: *848 headers: Link: *47 '304': *37 @@ -123310,7 +126314,7 @@ paths: application/json: schema: type: array - items: &848 + items: &849 title: Social account description: Social media account type: object @@ -123325,7 +126329,7 @@ paths: - provider - url examples: - default: &849 + default: &850 value: - provider: twitter url: https://twitter.com/github @@ -123387,9 +126391,9 @@ paths: application/json: schema: type: array - items: *848 + items: *849 examples: - default: *849 + default: *850 '422': *15 '304': *37 '404': *6 @@ -123476,7 +126480,7 @@ paths: application/json: schema: type: array - items: &850 + items: &851 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -123496,7 +126500,7 @@ paths: - title - created_at examples: - default: &879 + default: &880 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -123560,9 +126564,9 @@ paths: description: Response content: application/json: - schema: *850 + schema: *851 examples: - default: &851 + default: &852 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -123592,7 +126596,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: - - &852 + - &853 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -123604,9 +126608,9 @@ paths: description: Response content: application/json: - schema: *850 + schema: *851 examples: - default: *851 + default: *852 '404': *6 '304': *37 '403': *29 @@ -123629,7 +126633,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: - - *852 + - *853 responses: '204': description: Response @@ -123658,7 +126662,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: - - &880 + - &881 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 @@ -123683,11 +126687,11 @@ paths: type: array items: *80 examples: - default-response: *853 + default-response: *854 application/vnd.github.v3.star+json: schema: type: array - items: &881 + items: &882 title: Starred Repository description: Starred Repository type: object @@ -123843,8 +126847,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: - - *484 - *485 + - *486 responses: '204': description: Response if this repository is starred by you @@ -123872,8 +126876,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: - - *484 - *485 + - *486 responses: '204': description: Response @@ -123897,8 +126901,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: - - *484 - *485 + - *486 responses: '204': description: Response @@ -123970,7 +126974,7 @@ paths: application/json: schema: type: array - items: *476 + items: *477 examples: default: value: @@ -124056,10 +127060,10 @@ paths: application/json: schema: oneOf: - - *828 - - *854 + - *829 + - *855 examples: - default-response: &858 + default-response: &859 summary: Default response value: login: octocat @@ -124094,7 +127098,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &859 + response-with-git-hub-plan-information: &860 summary: Response with GitHub plan information value: login: octocat @@ -124151,7 +127155,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: - - &856 + - &857 name: user_id description: The unique identifier of the user. in: path @@ -124217,7 +127221,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest/rest/users/users#list-users parameters: - - *855 + - *856 - *17 responses: '200': @@ -124252,7 +127256,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: - - *856 + - *857 - *428 requestBody: required: true @@ -124324,7 +127328,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *857 + schema: *858 examples: table_view: summary: Response for creating a table view @@ -124376,11 +127380,11 @@ paths: application/json: schema: oneOf: - - *828 - - *854 + - *829 + - *855 examples: - default-response: *858 - response-with-git-hub-plan-information: *859 + default-response: *859 + response-with-git-hub-plan-information: *860 '404': *6 x-github: githubCloudOnly: false @@ -124430,8 +127434,8 @@ paths: required: - subject_digests examples: - default: *860 - withPredicateType: *861 + default: *861 + withPredicateType: *862 responses: '200': description: Response @@ -124470,7 +127474,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *862 + default: *863 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -124659,7 +127663,7 @@ paths: initiator: type: string examples: - default: *531 + default: *532 '201': description: Response content: @@ -124940,7 +127944,7 @@ paths: application/json: schema: *334 examples: - default: &863 + default: &864 summary: Example response for a user copilot space value: id: 42 @@ -125041,7 +128045,7 @@ paths: application/json: schema: *334 examples: - default: *863 + default: *864 '403': *29 '404': *6 x-github: @@ -125164,7 +128168,7 @@ paths: application/json: schema: *334 examples: - default: *863 + default: *864 '403': *29 '404': *6 '422': *15 @@ -125932,7 +128936,7 @@ paths: type: array items: *410 examples: - default: *844 + default: *845 '403': *29 '401': *25 x-github: @@ -126316,9 +129320,9 @@ paths: application/json: schema: type: array - items: *835 + items: *836 examples: - default: *864 + default: *865 headers: Link: *47 x-github: @@ -126546,7 +129550,7 @@ paths: - docker - nuget - container - - *843 + - *844 - *148 - *19 - *17 @@ -126559,10 +129563,10 @@ paths: type: array items: *410 examples: - default: *844 + default: *845 '403': *29 '401': *25 - '400': *845 + '400': *846 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -126592,7 +129596,7 @@ paths: application/json: schema: *410 examples: - default: *865 + default: *866 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -126941,7 +129945,7 @@ paths: type: array items: *432 examples: - default: *866 + default: *867 headers: Link: *47 '304': *37 @@ -127001,7 +130005,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *867 + items: *868 required: - name - data_type @@ -127017,7 +130021,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *868 + iteration_configuration: *869 required: - name - data_type @@ -127039,8 +130043,8 @@ paths: value: name: Due date data_type: date - single_select_field: *869 - iteration_field: *870 + single_select_field: *870 + iteration_field: *871 responses: '201': description: Response @@ -127048,11 +130052,11 @@ paths: application/json: schema: *432 examples: - text_field: *871 - number_field: *872 - date_field: *873 - single_select_field: *874 - iteration_field: *875 + text_field: *872 + number_field: *873 + date_field: *874 + single_select_field: *875 + iteration_field: *876 '304': *37 '403': *29 '401': *25 @@ -127074,7 +130078,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/projects/fields#get-project-field-for-user parameters: - *428 - - *876 + - *877 - *148 responses: '200': @@ -127083,7 +130087,7 @@ paths: application/json: schema: *432 examples: - default: *877 + default: *878 headers: Link: *47 '304': *37 @@ -127437,7 +130441,7 @@ paths: parameters: - *428 - *148 - - *878 + - *879 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -127716,9 +130720,9 @@ paths: application/json: schema: type: array - items: *848 + items: *849 examples: - default: *849 + default: *850 headers: Link: *47 x-github: @@ -127748,9 +130752,9 @@ paths: application/json: schema: type: array - items: *850 + items: *851 examples: - default: *879 + default: *880 headers: Link: *47 x-github: @@ -127775,7 +130779,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *148 - - *880 + - *881 - *112 - *17 - *19 @@ -127787,11 +130791,11 @@ paths: schema: anyOf: - type: array - items: *881 + items: *882 - type: array items: *80 examples: - default-response: *853 + default-response: *854 headers: Link: *47 x-github: @@ -127950,7 +130954,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &882 + enterprise: &883 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -128008,7 +131012,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &883 + installation: &884 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -128027,7 +131031,7 @@ x-webhooks: required: - id - node_id - organization: &884 + organization: &885 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -128087,13 +131091,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &885 + repository: &886 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &924 + properties: &925 id: description: Unique identifier of the repository example: 42 @@ -128777,7 +131781,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &925 + required: &926 - archive_url - assignees_url - blobs_url @@ -128928,10 +131932,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -129007,11 +132011,11 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - rule: &886 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + rule: &887 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) @@ -129234,11 +132238,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - rule: *886 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + rule: *887 sender: *4 required: - action @@ -129421,11 +132425,11 @@ x-webhooks: - everyone required: - from - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - rule: *886 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + rule: *887 sender: *4 required: - action @@ -129498,7 +132502,7 @@ x-webhooks: required: true content: application/json: - schema: &908 + schema: &909 title: Exemption request cancellation event type: object properties: @@ -129506,11 +132510,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - exemption_request: &887 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + exemption_request: &888 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -129814,7 +132818,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &888 + items: &889 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -129924,7 +132928,7 @@ x-webhooks: required: true content: application/json: - schema: &909 + schema: &910 title: Exemption request completed event type: object properties: @@ -129932,11 +132936,11 @@ x-webhooks: type: string enum: - completed - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - exemption_request: *887 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + exemption_request: *888 sender: *4 required: - action @@ -130008,7 +133012,7 @@ x-webhooks: required: true content: application/json: - schema: &906 + schema: &907 title: Exemption request created event type: object properties: @@ -130016,11 +133020,11 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - exemption_request: *887 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + exemption_request: *888 sender: *4 required: - action @@ -130092,7 +133096,7 @@ x-webhooks: required: true content: application/json: - schema: &910 + schema: &911 title: Exemption response dismissed event type: object properties: @@ -130100,12 +133104,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - exemption_request: *887 - exemption_response: *888 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + exemption_request: *888 + exemption_response: *889 sender: *4 required: - action @@ -130179,7 +133183,7 @@ x-webhooks: required: true content: application/json: - schema: &907 + schema: &908 title: Exemption response submitted event type: object properties: @@ -130187,12 +133191,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - exemption_request: *887 - exemption_response: *888 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + exemption_request: *888 + exemption_response: *889 sender: *4 required: - action @@ -130276,7 +133280,7 @@ x-webhooks: type: string enum: - completed - check_run: &890 + check_run: &891 title: CheckRun description: A check performed on the code of a given code change type: object @@ -130367,7 +133371,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *889 + deployment: *890 details_url: example: https://example.com type: string @@ -130452,10 +133456,10 @@ x-webhooks: - output - app - pull_requests - installation: *883 - enterprise: *882 - organization: *884 - repository: *885 + installation: *884 + enterprise: *883 + organization: *885 + repository: *886 sender: *4 required: - check_run @@ -130846,11 +133850,11 @@ x-webhooks: type: string enum: - created - check_run: *890 - installation: *883 - enterprise: *882 - organization: *884 - repository: *885 + check_run: *891 + installation: *884 + enterprise: *883 + organization: *885 + repository: *886 sender: *4 required: - check_run @@ -131244,11 +134248,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *890 - installation: *883 - enterprise: *882 - organization: *884 - repository: *885 + check_run: *891 + installation: *884 + enterprise: *883 + organization: *885 + repository: *886 requested_action: description: The action requested by the user. type: object @@ -131651,11 +134655,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *890 - installation: *883 - enterprise: *882 - organization: *884 - repository: *885 + check_run: *891 + installation: *884 + enterprise: *883 + organization: *885 + repository: *886 sender: *4 required: - check_run @@ -132625,10 +135629,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -133317,10 +136321,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -134003,10 +137007,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -134172,7 +137176,7 @@ x-webhooks: required: - login - id - dismissed_comment: *560 + dismissed_comment: *561 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -134317,20 +137321,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &891 + commit_oid: &892 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: *882 - installation: *883 - organization: *884 - ref: &892 + enterprise: *883 + installation: *884 + organization: *885 + ref: &893 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: *885 + repository: *886 sender: *4 required: - action @@ -134495,7 +137499,7 @@ x-webhooks: required: - login - id - dismissed_comment: *560 + dismissed_comment: *561 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -134725,12 +137729,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *891 - enterprise: *882 - installation: *883 - organization: *884 - ref: *892 - repository: *885 + commit_oid: *892 + enterprise: *883 + installation: *884 + organization: *885 + ref: *893 + repository: *886 sender: *4 required: - action @@ -134825,7 +137829,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *560 + dismissed_comment: *561 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -134996,12 +138000,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *891 - enterprise: *882 - installation: *883 - organization: *884 - ref: *892 - repository: *885 + commit_oid: *892 + enterprise: *883 + installation: *884 + organization: *885 + ref: *893 + repository: *886 sender: *4 required: - action @@ -135167,7 +138171,7 @@ x-webhooks: required: - login - id - dismissed_comment: *560 + dismissed_comment: *561 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -135333,12 +138337,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *891 - enterprise: *882 - installation: *883 - organization: *884 - ref: *892 - repository: *885 + commit_oid: *892 + enterprise: *883 + installation: *884 + organization: *885 + ref: *893 + repository: *886 sender: *4 required: - action @@ -135437,7 +138441,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *560 + dismissed_comment: *561 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -135612,16 +138616,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 ref: 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 nullable: true - repository: *885 + repository: *886 sender: *4 required: - action @@ -135718,7 +138722,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *560 + dismissed_comment: *561 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -135858,12 +138862,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *891 - enterprise: *882 - installation: *883 - organization: *884 - ref: *892 - repository: *885 + commit_oid: *892 + enterprise: *883 + installation: *884 + organization: *885 + ref: *893 + repository: *886 sender: *4 required: - action @@ -136029,7 +139033,7 @@ x-webhooks: required: - login - id - dismissed_comment: *560 + dismissed_comment: *561 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -136174,10 +139178,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -136432,10 +139436,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -136515,18 +139519,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *884 - pusher_type: &893 + organization: *885 + pusher_type: &894 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &894 + ref: &895 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference) resource. type: string @@ -136536,7 +139540,7 @@ x-webhooks: enum: - tag - branch - repository: *885 + repository: *886 sender: *4 required: - ref @@ -136619,9 +139623,9 @@ x-webhooks: enum: - created definition: *161 - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 sender: *4 required: - action @@ -136706,9 +139710,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 sender: *4 required: - action @@ -136786,9 +139790,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *161 - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 sender: *4 required: - action @@ -136866,9 +139870,9 @@ x-webhooks: enum: - updated definition: *161 - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 sender: *4 required: - action @@ -136945,10 +139949,10 @@ x-webhooks: type: string enum: - updated - enterprise: *882 - installation: *883 - repository: *885 - organization: *884 + enterprise: *883 + installation: *884 + repository: *886 + organization: *885 sender: *4 new_property_values: type: array @@ -137033,18 +140037,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *882 - installation: *883 - organization: *884 - pusher_type: *893 - ref: *894 + enterprise: *883 + installation: *884 + organization: *885 + pusher_type: *894 + ref: *895 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *885 + repository: *886 sender: *4 required: - ref @@ -137124,11 +140128,11 @@ x-webhooks: type: string enum: - assignees_changed - alert: *624 - installation: *883 - organization: *884 - enterprise: *882 - repository: *885 + alert: *625 + installation: *884 + organization: *885 + enterprise: *883 + repository: *886 sender: *4 required: - action @@ -137208,11 +140212,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *624 - installation: *883 - organization: *884 - enterprise: *882 - repository: *885 + alert: *625 + installation: *884 + organization: *885 + enterprise: *883 + repository: *886 sender: *4 required: - action @@ -137293,11 +140297,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *624 - installation: *883 - organization: *884 - enterprise: *882 - repository: *885 + alert: *625 + installation: *884 + organization: *885 + enterprise: *883 + repository: *886 sender: *4 required: - action @@ -137378,11 +140382,11 @@ x-webhooks: type: string enum: - created - alert: *624 - installation: *883 - organization: *884 - enterprise: *882 - repository: *885 + alert: *625 + installation: *884 + organization: *885 + enterprise: *883 + repository: *886 sender: *4 required: - action @@ -137461,11 +140465,11 @@ x-webhooks: type: string enum: - dismissed - alert: *624 - installation: *883 - organization: *884 - enterprise: *882 - repository: *885 + alert: *625 + installation: *884 + organization: *885 + enterprise: *883 + repository: *886 sender: *4 required: - action @@ -137544,11 +140548,11 @@ x-webhooks: type: string enum: - fixed - alert: *624 - installation: *883 - organization: *884 - enterprise: *882 - repository: *885 + alert: *625 + installation: *884 + organization: *885 + enterprise: *883 + repository: *886 sender: *4 required: - action @@ -137628,11 +140632,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *624 - installation: *883 - organization: *884 - enterprise: *882 - repository: *885 + alert: *625 + installation: *884 + organization: *885 + enterprise: *883 + repository: *886 sender: *4 required: - action @@ -137711,11 +140715,11 @@ x-webhooks: type: string enum: - reopened - alert: *624 - installation: *883 - organization: *884 - enterprise: *882 - repository: *885 + alert: *625 + installation: *884 + organization: *885 + enterprise: *883 + repository: *886 sender: *4 required: - action @@ -137792,9 +140796,9 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - key: &895 + enterprise: *883 + installation: *884 + key: &896 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -137830,8 +140834,8 @@ x-webhooks: - verified - created_at - read_only - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -137908,11 +140912,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - key: *895 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + key: *896 + organization: *885 + repository: *886 sender: *4 required: - action @@ -138468,12 +141472,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - workflow: &901 + workflow: &902 title: Workflow type: object nullable: true @@ -139214,15 +142218,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *896 - required: *897 + properties: *897 + required: *898 nullable: true pull_requests: type: array - items: *730 - repository: *885 - organization: *884 - installation: *883 + items: *731 + repository: *886 + organization: *885 + installation: *884 sender: *4 responses: '200': @@ -139293,7 +142297,7 @@ x-webhooks: type: string enum: - approved - approver: &898 + approver: &899 type: object properties: avatar_url: @@ -139336,11 +142340,11 @@ x-webhooks: type: string comment: type: string - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - reviewers: &899 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + reviewers: &900 type: array items: type: object @@ -139419,7 +142423,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &900 + workflow_job_run: &901 type: object properties: conclusion: @@ -140150,18 +143154,18 @@ x-webhooks: type: string enum: - rejected - approver: *898 + approver: *899 comment: type: string - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - reviewers: *899 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + reviewers: *900 sender: *4 since: type: string - workflow_job_run: *900 + workflow_job_run: *901 workflow_job_runs: type: array items: @@ -140865,13 +143869,13 @@ x-webhooks: type: string enum: - requested - enterprise: *882 + enterprise: *883 environment: type: string - installation: *883 - organization: *884 - repository: *885 - requestor: &911 + installation: *884 + organization: *885 + repository: *886 + requestor: &912 title: User type: object nullable: true @@ -142760,12 +145764,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - workflow: *901 + workflow: *902 workflow_run: title: Deployment Workflow Run type: object @@ -143445,7 +146449,7 @@ x-webhooks: type: string enum: - answered - answer: &904 + answer: &905 type: object properties: author_association: @@ -143602,11 +146606,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -143733,11 +146737,11 @@ x-webhooks: - from required: - category - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -143820,11 +146824,11 @@ x-webhooks: type: string enum: - closed - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -143906,7 +146910,7 @@ x-webhooks: type: string enum: - created - comment: &903 + comment: &904 type: object properties: author_association: @@ -144063,11 +147067,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -144150,12 +147154,12 @@ x-webhooks: type: string enum: - deleted - comment: *903 - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + comment: *904 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -144250,12 +147254,12 @@ x-webhooks: - from required: - body - comment: *903 - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + comment: *904 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -144339,11 +147343,11 @@ x-webhooks: type: string enum: - created - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -144425,11 +147429,11 @@ x-webhooks: type: string enum: - deleted - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -144529,11 +147533,11 @@ x-webhooks: type: string required: - from - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -144615,10 +147619,10 @@ x-webhooks: type: string enum: - labeled - discussion: *902 - enterprise: *882 - installation: *883 - label: &905 + discussion: *903 + enterprise: *883 + installation: *884 + label: &906 title: Label type: object properties: @@ -144650,8 +147654,8 @@ x-webhooks: - color - default - description - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -144734,11 +147738,11 @@ x-webhooks: type: string enum: - locked - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -144820,11 +147824,11 @@ x-webhooks: type: string enum: - pinned - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -144906,11 +147910,11 @@ x-webhooks: type: string enum: - reopened - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -144995,16 +147999,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *902 - new_repository: *885 + new_discussion: *903 + new_repository: *886 required: - new_discussion - new_repository - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -145087,10 +148091,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *902 - old_answer: *904 - organization: *884 - repository: *885 + discussion: *903 + old_answer: *905 + organization: *885 + repository: *886 sender: *4 required: - action @@ -145172,12 +148176,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *902 - enterprise: *882 - installation: *883 - label: *905 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + label: *906 + organization: *885 + repository: *886 sender: *4 required: - action @@ -145260,11 +148264,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -145346,11 +148350,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *902 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + discussion: *903 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -145419,7 +148423,7 @@ x-webhooks: required: true content: application/json: - schema: *906 + schema: *907 responses: '200': description: Return a 200 status to indicate that the data was received @@ -145482,7 +148486,7 @@ x-webhooks: required: true content: application/json: - schema: *907 + schema: *908 responses: '200': description: Return a 200 status to indicate that the data was received @@ -145545,7 +148549,7 @@ x-webhooks: required: true content: application/json: - schema: *908 + schema: *909 responses: '200': description: Return a 200 status to indicate that the data was received @@ -145608,7 +148612,7 @@ x-webhooks: required: true content: application/json: - schema: *906 + schema: *907 responses: '200': description: Return a 200 status to indicate that the data was received @@ -145671,7 +148675,7 @@ x-webhooks: required: true content: application/json: - schema: *907 + schema: *908 responses: '200': description: Return a 200 status to indicate that the data was received @@ -145737,7 +148741,7 @@ x-webhooks: required: true content: application/json: - schema: *908 + schema: *909 responses: '200': description: Return a 200 status to indicate that the data was received @@ -145803,7 +148807,7 @@ x-webhooks: required: true content: application/json: - schema: *909 + schema: *910 responses: '200': description: Return a 200 status to indicate that the data was received @@ -145869,7 +148873,7 @@ x-webhooks: required: true content: application/json: - schema: *906 + schema: *907 responses: '200': description: Return a 200 status to indicate that the data was received @@ -145935,7 +148939,7 @@ x-webhooks: required: true content: application/json: - schema: *910 + schema: *911 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146001,7 +149005,7 @@ x-webhooks: required: true content: application/json: - schema: *907 + schema: *908 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146066,7 +149070,7 @@ x-webhooks: required: true content: application/json: - schema: *908 + schema: *909 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146131,7 +149135,7 @@ x-webhooks: required: true content: application/json: - schema: *909 + schema: *910 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146196,7 +149200,7 @@ x-webhooks: required: true content: application/json: - schema: *906 + schema: *907 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146261,7 +149265,7 @@ x-webhooks: required: true content: application/json: - schema: *910 + schema: *911 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146327,7 +149331,7 @@ x-webhooks: required: true content: application/json: - schema: *907 + schema: *908 responses: '200': description: Return a 200 status to indicate that the data was received @@ -146394,7 +149398,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *882 + enterprise: *883 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) resource. @@ -147054,9 +150058,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - forkee @@ -147202,9 +150206,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 pages: description: The pages that were updated. type: array @@ -147241,7 +150245,7 @@ x-webhooks: - action - sha - html_url - repository: *885 + repository: *886 sender: *4 required: - pages @@ -147317,10 +150321,10 @@ x-webhooks: type: string enum: - created - enterprise: *882 + enterprise: *883 installation: *22 - organization: *884 - repositories: &912 + organization: *885 + repositories: &913 description: An array of repository objects that the installation can access. type: array @@ -147346,8 +150350,8 @@ x-webhooks: - name - full_name - private - repository: *885 - requester: *911 + repository: *886 + requester: *912 sender: *4 required: - action @@ -147422,11 +150426,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 + enterprise: *883 installation: *22 - organization: *884 - repositories: *912 - repository: *885 + organization: *885 + repositories: *913 + repository: *886 requester: nullable: true sender: *4 @@ -147502,11 +150506,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *882 + enterprise: *883 installation: *22 - organization: *884 - repositories: *912 - repository: *885 + organization: *885 + repositories: *913 + repository: *886 requester: nullable: true sender: *4 @@ -147582,10 +150586,10 @@ x-webhooks: type: string enum: - added - enterprise: *882 + enterprise: *883 installation: *22 - organization: *884 - repositories_added: &913 + organization: *885 + repositories_added: &914 description: An array of repository objects, which were added to the installation. type: array @@ -147631,15 +150635,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *885 - repository_selection: &914 + repository: *886 + repository_selection: &915 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *911 + requester: *912 sender: *4 required: - action @@ -147718,10 +150722,10 @@ x-webhooks: type: string enum: - removed - enterprise: *882 + enterprise: *883 installation: *22 - organization: *884 - repositories_added: *913 + organization: *885 + repositories_added: *914 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -147748,9 +150752,9 @@ x-webhooks: - name - full_name - private - repository: *885 - repository_selection: *914 - requester: *911 + repository: *886 + repository_selection: *915 + requester: *912 sender: *4 required: - action @@ -147829,11 +150833,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *882 + enterprise: *883 installation: *22 - organization: *884 - repositories: *912 - repository: *885 + organization: *885 + repositories: *913 + repository: *886 requester: nullable: true sender: *4 @@ -148012,10 +151016,10 @@ x-webhooks: type: string required: - from - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 target_type: type: string @@ -148094,11 +151098,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *882 + enterprise: *883 installation: *22 - organization: *884 - repositories: *912 - repository: *885 + organization: *885 + repositories: *913 + repository: *886 requester: nullable: true sender: *4 @@ -148272,8 +151276,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *705 - required: *706 + properties: *706 + required: *707 nullable: true user: title: User @@ -148358,8 +151362,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -149148,8 +152152,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149498,8 +152502,8 @@ x-webhooks: - state - locked - assignee - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -149579,7 +152583,7 @@ x-webhooks: type: string enum: - deleted - comment: &915 + comment: &916 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments#get-an-issue-comment) itself. @@ -149736,8 +152740,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *705 - required: *706 + properties: *706 + required: *707 nullable: true required: - url @@ -149752,8 +152756,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -150538,8 +153542,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150890,8 +153894,8 @@ x-webhooks: - state - locked - assignee - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -150971,7 +153975,7 @@ x-webhooks: type: string enum: - edited - changes: &944 + changes: &945 description: The changes to the comment. type: object properties: @@ -150983,9 +153987,9 @@ x-webhooks: type: string required: - from - comment: *915 - enterprise: *882 - installation: *883 + comment: *916 + enterprise: *883 + installation: *884 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -151773,8 +154777,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152123,8 +155127,8 @@ x-webhooks: - state - locked - assignee - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -152205,9 +155209,9 @@ x-webhooks: type: string enum: - pinned - comment: *915 - enterprise: *882 - installation: *883 + comment: *916 + enterprise: *883 + installation: *884 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -152997,8 +156001,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153349,8 +156353,8 @@ x-webhooks: - state - locked - assignee - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -153430,9 +156434,9 @@ x-webhooks: type: string enum: - unpinned - comment: *915 - enterprise: *882 - installation: *883 + comment: *916 + enterprise: *883 + installation: *884 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to. @@ -154222,8 +157226,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154574,8 +157578,8 @@ x-webhooks: - state - locked - assignee - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -154664,9 +157668,9 @@ x-webhooks: type: number blocking_issue: *229 blocking_issue_repo: *80 - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -154755,9 +157759,9 @@ x-webhooks: type: number blocking_issue: *229 blocking_issue_repo: *80 - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -154845,9 +157849,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *229 - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -154936,9 +157940,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *229 - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -155018,10 +158022,10 @@ x-webhooks: type: string enum: - assigned - assignee: *911 - enterprise: *882 - installation: *883 - issue: &916 + assignee: *912 + enterprise: *883 + installation: *884 + issue: &917 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. @@ -155813,11 +158817,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155934,8 +158938,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -156015,8 +159019,8 @@ x-webhooks: type: string enum: - closed - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. @@ -156813,11 +159817,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157069,8 +160073,8 @@ x-webhooks: required: - state - closed_at - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -157149,8 +160153,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -157938,11 +160942,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -158058,8 +161062,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -158138,8 +161142,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -158949,11 +161953,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159048,7 +162052,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &917 + milestone: &918 title: Milestone description: A collection of related issues and pull requests. type: object @@ -159186,8 +162190,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -159286,8 +162290,8 @@ x-webhooks: type: string required: - from - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -160079,11 +163083,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160200,9 +163204,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *905 - organization: *884 - repository: *885 + label: *906 + organization: *885 + repository: *886 sender: *4 required: - action @@ -160282,9 +163286,9 @@ x-webhooks: type: string enum: - field_added - enterprise: *882 - installation: *883 - issue: *916 + enterprise: *883 + installation: *884 + issue: *917 issue_field: type: object description: The issue field whose value was set or updated on the @@ -160393,8 +163397,8 @@ x-webhooks: - id required: - from - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -160474,9 +163478,9 @@ x-webhooks: type: string enum: - field_removed - enterprise: *882 - installation: *883 - issue: *916 + enterprise: *883 + installation: *884 + issue: *917 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -160534,8 +163538,8 @@ x-webhooks: nullable: true required: - id - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -160615,8 +163619,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -161407,11 +164411,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -161528,9 +164532,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *905 - organization: *884 - repository: *885 + label: *906 + organization: *885 + repository: *886 sender: *4 required: - action @@ -161610,8 +164614,8 @@ x-webhooks: type: string enum: - locked - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -162426,11 +165430,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -162524,8 +165528,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -162604,8 +165608,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -163414,11 +166418,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -163512,9 +166516,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *917 - organization: *884 - repository: *885 + milestone: *918 + organization: *885 + repository: *886 sender: *4 required: - action @@ -164377,11 +167381,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -164962,8 +167966,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -165747,11 +168751,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -165875,8 +168879,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -165956,9 +168960,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *882 - installation: *883 - issue: &918 + enterprise: *883 + installation: *884 + issue: &919 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself. @@ -166744,11 +169748,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -166864,8 +169868,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -166944,8 +169948,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -167758,11 +170762,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -167857,8 +170861,8 @@ x-webhooks: user_view_type: type: string type: *394 - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -168727,11 +171731,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -169326,11 +172330,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *882 - installation: *883 - issue: *918 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + issue: *919 + organization: *885 + repository: *886 sender: *4 required: - action @@ -169410,12 +172414,12 @@ x-webhooks: type: string enum: - typed - enterprise: *882 - installation: *883 - issue: *916 + enterprise: *883 + installation: *884 + issue: *917 type: *394 - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -169496,7 +172500,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &947 + assignee: &948 title: User type: object nullable: true @@ -169566,11 +172570,11 @@ x-webhooks: required: - login - id - enterprise: *882 - installation: *883 - issue: *916 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + issue: *917 + organization: *885 + repository: *886 sender: *4 required: - action @@ -169649,12 +172653,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *882 - installation: *883 - issue: *916 - label: *905 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + issue: *917 + label: *906 + organization: *885 + repository: *886 sender: *4 required: - action @@ -169734,8 +172738,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) @@ -170548,11 +173552,11 @@ x-webhooks: properties: *230 required: *231 nullable: true - sub_issues_summary: *821 - issue_dependencies_summary: *822 + sub_issues_summary: *822 + issue_dependencies_summary: *823 issue_field_values: type: array - items: *689 + items: *690 state: description: State of the issue; either 'open' or 'closed' type: string @@ -170646,8 +173650,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -170727,11 +173731,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *882 - installation: *883 - issue: *918 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + issue: *919 + organization: *885 + repository: *886 sender: *4 required: - action @@ -170810,12 +173814,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *882 - installation: *883 - issue: *916 + enterprise: *883 + installation: *884 + issue: *917 type: *394 - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -170895,11 +173899,11 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - label: *905 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + label: *906 + organization: *885 + repository: *886 sender: *4 required: - action @@ -170977,11 +173981,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - label: *905 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + label: *906 + organization: *885 + repository: *886 sender: *4 required: - action @@ -171091,11 +174095,11 @@ x-webhooks: type: string required: - from - enterprise: *882 - installation: *883 - label: *905 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + label: *906 + organization: *885 + repository: *886 sender: *4 required: - action @@ -171177,9 +174181,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *882 - installation: *883 - marketplace_purchase: &919 + enterprise: *883 + installation: *884 + marketplace_purchase: &920 title: Marketplace Purchase type: object required: @@ -171262,8 +174266,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *884 - previous_marketplace_purchase: &920 + organization: *885 + previous_marketplace_purchase: &921 title: Marketplace Purchase type: object properties: @@ -171343,7 +174347,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *885 + repository: *886 sender: *4 required: - action @@ -171423,10 +174427,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *882 - installation: *883 - marketplace_purchase: *919 - organization: *884 + enterprise: *883 + installation: *884 + marketplace_purchase: *920 + organization: *885 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -171509,7 +174513,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *885 + repository: *886 sender: *4 required: - action @@ -171591,10 +174595,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *882 - installation: *883 - marketplace_purchase: *919 - organization: *884 + enterprise: *883 + installation: *884 + marketplace_purchase: *920 + organization: *885 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -171676,7 +174680,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *885 + repository: *886 sender: *4 required: - action @@ -171757,8 +174761,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 marketplace_purchase: title: Marketplace Purchase type: object @@ -171840,9 +174844,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *884 - previous_marketplace_purchase: *920 - repository: *885 + organization: *885 + previous_marketplace_purchase: *921 + repository: *886 sender: *4 required: - action @@ -171922,12 +174926,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *882 - installation: *883 - marketplace_purchase: *919 - organization: *884 - previous_marketplace_purchase: *920 - repository: *885 + enterprise: *883 + installation: *884 + marketplace_purchase: *920 + organization: *885 + previous_marketplace_purchase: *921 + repository: *886 sender: *4 required: - action @@ -172029,11 +175033,11 @@ x-webhooks: type: string required: - to - enterprise: *882 - installation: *883 - member: *911 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + member: *912 + organization: *885 + repository: *886 sender: *4 required: - action @@ -172133,11 +175137,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *882 - installation: *883 - member: *911 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + member: *912 + organization: *885 + repository: *886 sender: *4 required: - action @@ -172216,11 +175220,11 @@ x-webhooks: type: string enum: - removed - enterprise: *882 - installation: *883 - member: *911 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + member: *912 + organization: *885 + repository: *886 sender: *4 required: - action @@ -172298,11 +175302,11 @@ x-webhooks: type: string enum: - added - enterprise: *882 - installation: *883 - member: *911 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + member: *912 + organization: *885 + repository: *886 scope: description: The scope of the membership. Currently, can only be `team`. @@ -172378,7 +175382,7 @@ x-webhooks: required: - login - id - team: &921 + team: &922 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -172601,11 +175605,11 @@ x-webhooks: type: string enum: - removed - enterprise: *882 - installation: *883 - member: *911 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + member: *912 + organization: *885 + repository: *886 scope: description: The scope of the membership. Currently, can only be `team`. @@ -172682,7 +175686,7 @@ x-webhooks: required: - login - id - team: *921 + team: *922 required: - action - scope @@ -172764,8 +175768,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *883 - merge_group: &923 + installation: *884 + merge_group: &924 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -172784,15 +175788,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *922 + head_commit: *923 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -172878,10 +175882,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *883 - merge_group: *923 - organization: *884 - repository: *885 + installation: *884 + merge_group: *924 + organization: *885 + repository: *886 sender: *4 required: - action @@ -172954,7 +175958,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 + enterprise: *883 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -173063,16 +176067,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *883 - organization: *884 + installation: *884 + organization: *885 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *924 - required: *925 + properties: *925 + required: *926 nullable: true sender: *4 required: @@ -173153,11 +176157,11 @@ x-webhooks: type: string enum: - closed - enterprise: *882 - installation: *883 - milestone: *917 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + milestone: *918 + organization: *885 + repository: *886 sender: *4 required: - action @@ -173236,9 +176240,9 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - milestone: &926 + enterprise: *883 + installation: *884 + milestone: &927 title: Milestone description: A collection of related issues and pull requests. type: object @@ -173375,8 +176379,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -173455,11 +176459,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - milestone: *917 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + milestone: *918 + organization: *885 + repository: *886 sender: *4 required: - action @@ -173569,11 +176573,11 @@ x-webhooks: type: string required: - from - enterprise: *882 - installation: *883 - milestone: *917 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + milestone: *918 + organization: *885 + repository: *886 sender: *4 required: - action @@ -173653,11 +176657,11 @@ x-webhooks: type: string enum: - opened - enterprise: *882 - installation: *883 - milestone: *926 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + milestone: *927 + organization: *885 + repository: *886 sender: *4 required: - action @@ -173736,11 +176740,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *911 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + blocked_user: *912 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -173819,11 +176823,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *911 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + blocked_user: *912 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -173899,7 +176903,7 @@ x-webhooks: enum: - created definition: *156 - enterprise: *882 + enterprise: *883 sender: *4 required: - action @@ -173979,8 +176983,8 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 sender: *4 required: - action @@ -174053,8 +177057,8 @@ x-webhooks: enum: - updated definition: *156 - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 sender: *4 required: - action @@ -174126,9 +177130,9 @@ x-webhooks: type: string enum: - updated - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 sender: *4 new_property_values: type: array @@ -174216,9 +177220,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - membership: &927 + enterprise: *883 + installation: *884 + membership: &928 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -174325,8 +177329,8 @@ x-webhooks: - role - organization_url - user - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 required: - action @@ -174404,11 +177408,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *882 - installation: *883 - membership: *927 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + membership: *928 + organization: *885 + repository: *886 sender: *4 required: - action @@ -174487,8 +177491,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -174604,10 +177608,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 - user: *911 + user: *912 required: - action - invitation @@ -174685,11 +177689,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *882 - installation: *883 - membership: *927 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + membership: *928 + organization: *885 + repository: *886 sender: *4 required: - action @@ -174776,11 +177780,11 @@ x-webhooks: properties: from: type: string - enterprise: *882 - installation: *883 - membership: *927 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + membership: *928 + organization: *885 + repository: *886 sender: *4 required: - action @@ -174858,9 +177862,9 @@ x-webhooks: type: string enum: - published - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 package: description: Information about the package. type: object @@ -175359,7 +178363,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &928 + items: &929 title: Ruby Gems metadata type: object properties: @@ -175454,7 +178458,7 @@ x-webhooks: - owner - package_version - registry - repository: *885 + repository: *886 sender: *4 required: - action @@ -175531,9 +178535,9 @@ x-webhooks: type: string enum: - updated - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 package: description: Information about the package. type: object @@ -175886,7 +178890,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *928 + items: *929 source_url: type: string format: uri @@ -175956,7 +178960,7 @@ x-webhooks: - owner - package_version - registry - repository: *885 + repository: *886 sender: *4 required: - action @@ -176132,12 +179136,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *882 + enterprise: *883 id: type: integer - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - id @@ -176214,7 +179218,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &929 + personal_access_token_request: &930 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -176360,10 +179364,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *882 - organization: *884 + enterprise: *883 + organization: *885 sender: *4 - installation: *883 + installation: *884 required: - action - personal_access_token_request @@ -176440,11 +179444,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *929 - enterprise: *882 - organization: *884 + personal_access_token_request: *930 + enterprise: *883 + organization: *885 sender: *4 - installation: *883 + installation: *884 required: - action - personal_access_token_request @@ -176520,11 +179524,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *929 - enterprise: *882 - organization: *884 + personal_access_token_request: *930 + enterprise: *883 + organization: *885 sender: *4 - installation: *883 + installation: *884 required: - action - personal_access_token_request @@ -176599,11 +179603,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *929 - organization: *884 - enterprise: *882 + personal_access_token_request: *930 + organization: *885 + enterprise: *883 sender: *4 - installation: *883 + installation: *884 required: - action - personal_access_token_request @@ -176708,7 +179712,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *930 + last_response: *931 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -176740,8 +179744,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 zen: description: Random string of GitHub zen. @@ -176986,10 +179990,10 @@ x-webhooks: - from required: - note - enterprise: *882 - installation: *883 - organization: *884 - project_card: &931 + enterprise: *883 + installation: *884 + organization: *885 + project_card: &932 title: Project Card type: object properties: @@ -177108,7 +180112,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *885 + repository: *886 sender: *4 required: - action @@ -177189,11 +180193,11 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - project_card: *931 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + project_card: *932 + repository: *886 sender: *4 required: - action @@ -177273,9 +180277,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 project_card: title: Project Card type: object @@ -177403,8 +180407,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *924 - required: *925 + properties: *925 + required: *926 nullable: true sender: *4 required: @@ -177498,11 +180502,11 @@ x-webhooks: - from required: - note - enterprise: *882 - installation: *883 - organization: *884 - project_card: *931 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + project_card: *932 + repository: *886 sender: *4 required: - action @@ -177596,9 +180600,9 @@ x-webhooks: - from required: - column_id - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 project_card: allOf: - title: Project Card @@ -177788,7 +180792,7 @@ x-webhooks: type: string required: - after_id - repository: *885 + repository: *886 sender: *4 required: - action @@ -177868,10 +180872,10 @@ x-webhooks: type: string enum: - closed - enterprise: *882 - installation: *883 - organization: *884 - project: &933 + enterprise: *883 + installation: *884 + organization: *885 + project: &934 title: Project type: object properties: @@ -177995,7 +180999,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *885 + repository: *886 sender: *4 required: - action @@ -178075,10 +181079,10 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - project_column: &932 + enterprise: *883 + installation: *884 + organization: *885 + project_column: &933 title: Project Column type: object properties: @@ -178117,7 +181121,7 @@ x-webhooks: - name - created_at - updated_at - repository: *885 + repository: *886 sender: *4 required: - action @@ -178196,18 +181200,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - organization: *884 - project_column: *932 + enterprise: *883 + installation: *884 + organization: *885 + project_column: *933 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *924 - required: *925 + properties: *925 + required: *926 nullable: true sender: *4 required: @@ -178297,11 +181301,11 @@ x-webhooks: type: string required: - from - enterprise: *882 - installation: *883 - organization: *884 - project_column: *932 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + project_column: *933 + repository: *886 sender: *4 required: - action @@ -178381,11 +181385,11 @@ x-webhooks: type: string enum: - moved - enterprise: *882 - installation: *883 - organization: *884 - project_column: *932 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + project_column: *933 + repository: *886 sender: *4 required: - action @@ -178465,11 +181469,11 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - project: *933 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + project: *934 + repository: *886 sender: *4 required: - action @@ -178549,18 +181553,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - organization: *884 - project: *933 + enterprise: *883 + installation: *884 + organization: *885 + project: *934 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *924 - required: *925 + properties: *925 + required: *926 nullable: true sender: *4 required: @@ -178662,11 +181666,11 @@ x-webhooks: type: string required: - from - enterprise: *882 - installation: *883 - organization: *884 - project: *933 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + project: *934 + repository: *886 sender: *4 required: - action @@ -178745,11 +181749,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *882 - installation: *883 - organization: *884 - project: *933 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + project: *934 + repository: *886 sender: *4 required: - action @@ -178830,8 +181834,8 @@ x-webhooks: type: string enum: - closed - installation: *883 - organization: *884 + installation: *884 + organization: *885 projects_v2: *426 sender: *4 required: @@ -178913,8 +181917,8 @@ x-webhooks: type: string enum: - created - installation: *883 - organization: *884 + installation: *884 + organization: *885 projects_v2: *426 sender: *4 required: @@ -178996,8 +182000,8 @@ x-webhooks: type: string enum: - deleted - installation: *883 - organization: *884 + installation: *884 + organization: *885 projects_v2: *426 sender: *4 required: @@ -179115,8 +182119,8 @@ x-webhooks: type: string to: type: string - installation: *883 - organization: *884 + installation: *884 + organization: *885 projects_v2: *426 sender: *4 required: @@ -179200,7 +182204,7 @@ x-webhooks: type: string enum: - archived - changes: &937 + changes: &938 type: object properties: archived_at: @@ -179214,9 +182218,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *883 - organization: *884 - projects_v2_item: &934 + installation: *884 + organization: *885 + projects_v2_item: &935 title: Projects v2 Item description: An item belonging to a project type: object @@ -179351,9 +182355,9 @@ x-webhooks: nullable: true to: type: string - installation: *883 - organization: *884 - projects_v2_item: *934 + installation: *884 + organization: *885 + projects_v2_item: *935 sender: *4 required: - action @@ -179435,9 +182439,9 @@ x-webhooks: type: string enum: - created - installation: *883 - organization: *884 - projects_v2_item: *934 + installation: *884 + organization: *885 + projects_v2_item: *935 sender: *4 required: - action @@ -179518,9 +182522,9 @@ x-webhooks: type: string enum: - deleted - installation: *883 - organization: *884 - projects_v2_item: *934 + installation: *884 + organization: *885 + projects_v2_item: *935 sender: *4 required: - action @@ -179626,7 +182630,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &935 + - &936 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -179648,7 +182652,7 @@ x-webhooks: required: - id - name - - &936 + - &937 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -179682,8 +182686,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *935 - *936 + - *937 required: - field_value - type: object @@ -179699,9 +182703,9 @@ x-webhooks: nullable: true required: - body - installation: *883 - organization: *884 - projects_v2_item: *934 + installation: *884 + organization: *885 + projects_v2_item: *935 sender: *4 required: - action @@ -179796,9 +182800,9 @@ x-webhooks: to: type: string nullable: true - installation: *883 - organization: *884 - projects_v2_item: *934 + installation: *884 + organization: *885 + projects_v2_item: *935 sender: *4 required: - action @@ -179881,10 +182885,10 @@ x-webhooks: type: string enum: - restored - changes: *937 - installation: *883 - organization: *884 - projects_v2_item: *934 + changes: *938 + installation: *884 + organization: *885 + projects_v2_item: *935 sender: *4 required: - action @@ -179966,8 +182970,8 @@ x-webhooks: type: string enum: - reopened - installation: *883 - organization: *884 + installation: *884 + organization: *885 projects_v2: *426 sender: *4 required: @@ -180049,14 +183053,14 @@ x-webhooks: type: string enum: - created - installation: *883 - organization: *884 - projects_v2_status_update: &940 + installation: *884 + organization: *885 + projects_v2_status_update: &941 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *938 - required: *939 + properties: *939 + required: *940 sender: *4 required: - action @@ -180137,9 +183141,9 @@ x-webhooks: type: string enum: - deleted - installation: *883 - organization: *884 - projects_v2_status_update: *940 + installation: *884 + organization: *885 + projects_v2_status_update: *941 sender: *4 required: - action @@ -180275,9 +183279,9 @@ x-webhooks: type: string format: date nullable: true - installation: *883 - organization: *884 - projects_v2_status_update: *940 + installation: *884 + organization: *885 + projects_v2_status_update: *941 sender: *4 required: - action @@ -180348,10 +183352,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - repository @@ -180428,13 +183432,13 @@ x-webhooks: type: string enum: - assigned - assignee: *911 - enterprise: *882 - installation: *883 - number: &941 + assignee: *912 + enterprise: *883 + installation: *884 + number: &942 description: The pull request number. type: integer - organization: *884 + organization: *885 pull_request: title: Pull Request type: object @@ -182721,7 +185725,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 sender: *4 required: - action @@ -182803,11 +185807,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 number: type: integer - organization: *884 + organization: *885 pull_request: title: Pull Request type: object @@ -185089,7 +188093,7 @@ x-webhooks: - draft reason: type: string - repository: *885 + repository: *886 sender: *4 required: - action @@ -185171,11 +188175,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 number: type: integer - organization: *884 + organization: *885 pull_request: title: Pull Request type: object @@ -187457,7 +190461,7 @@ x-webhooks: - draft reason: type: string - repository: *885 + repository: *886 sender: *4 required: - action @@ -187539,13 +190543,13 @@ x-webhooks: type: string enum: - closed - enterprise: *882 - installation: *883 - number: *941 - organization: *884 - pull_request: &942 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 + pull_request: &943 allOf: - - *730 + - *731 - type: object properties: allow_auto_merge: @@ -187607,7 +190611,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *885 + repository: *886 sender: *4 required: - action @@ -187688,12 +190692,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *882 - installation: *883 - number: *941 - organization: *884 - pull_request: *942 - repository: *885 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 + pull_request: *943 + repository: *886 sender: *4 required: - action @@ -187773,11 +190777,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *882 - milestone: *712 - number: *941 - organization: *884 - pull_request: &943 + enterprise: *883 + milestone: *713 + number: *942 + organization: *885 + pull_request: &944 title: Pull Request type: object properties: @@ -190058,7 +193062,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 sender: *4 required: - action @@ -190137,11 +193141,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 number: type: integer - organization: *884 + organization: *885 pull_request: title: Pull Request type: object @@ -192441,7 +195445,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *885 + repository: *886 sender: *4 required: - action @@ -192565,12 +195569,12 @@ x-webhooks: type: string required: - from - enterprise: *882 - installation: *883 - number: *941 - organization: *884 - pull_request: *942 - repository: *885 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 + pull_request: *943 + repository: *886 sender: *4 required: - action @@ -192650,11 +195654,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 number: type: integer - organization: *884 + organization: *885 pull_request: title: Pull Request type: object @@ -194939,7 +197943,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 sender: *4 required: - action @@ -195019,11 +198023,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *882 - installation: *883 - label: *905 - number: *941 - organization: *884 + enterprise: *883 + installation: *884 + label: *906 + number: *942 + organization: *885 pull_request: title: Pull Request type: object @@ -197309,7 +200313,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 sender: *4 required: - action @@ -197390,10 +200394,10 @@ x-webhooks: type: string enum: - locked - enterprise: *882 - installation: *883 - number: *941 - organization: *884 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 pull_request: title: Pull Request type: object @@ -199677,7 +202681,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 sender: *4 required: - action @@ -199757,12 +202761,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *882 - milestone: *712 - number: *941 - organization: *884 - pull_request: *943 - repository: *885 + enterprise: *883 + milestone: *713 + number: *942 + organization: *885 + pull_request: *944 + repository: *886 sender: *4 required: - action @@ -199841,12 +202845,12 @@ x-webhooks: type: string enum: - opened - enterprise: *882 - installation: *883 - number: *941 - organization: *884 - pull_request: *942 - repository: *885 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 + pull_request: *943 + repository: *886 sender: *4 required: - action @@ -199927,12 +202931,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *882 - installation: *883 - number: *941 - organization: *884 - pull_request: *942 - repository: *885 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 + pull_request: *943 + repository: *886 sender: *4 required: - action @@ -200012,12 +203016,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *882 - installation: *883 - number: *941 - organization: *884 - pull_request: *942 - repository: *885 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 + pull_request: *943 + repository: *886 sender: *4 required: - action @@ -200383,9 +203387,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 pull_request: type: object properties: @@ -202559,7 +205563,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *885 + repository: *886 sender: *4 required: - action @@ -202639,7 +205643,7 @@ x-webhooks: type: string enum: - deleted - comment: &945 + comment: &946 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. @@ -202924,9 +205928,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 pull_request: type: object properties: @@ -205088,7 +208092,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *885 + repository: *886 sender: *4 required: - action @@ -205168,11 +208172,11 @@ x-webhooks: type: string enum: - edited - changes: *944 - comment: *945 - enterprise: *882 - installation: *883 - organization: *884 + changes: *945 + comment: *946 + enterprise: *883 + installation: *884 + organization: *885 pull_request: type: object properties: @@ -207337,7 +210341,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *885 + repository: *886 sender: *4 required: - action @@ -207418,9 +210422,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 pull_request: title: Simple Pull Request type: object @@ -209597,7 +212601,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *885 + repository: *886 review: description: The review that was affected. type: object @@ -209844,9 +212848,9 @@ x-webhooks: type: string required: - from - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 pull_request: title: Simple Pull Request type: object @@ -211896,8 +214900,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *885 - review: &946 + repository: *886 + review: &947 description: The review that was affected. type: object properties: @@ -212130,12 +215134,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 number: description: The pull request number. type: integer - organization: *884 + organization: *885 pull_request: title: Pull Request type: object @@ -214422,7 +217426,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 requested_reviewer: title: User type: object @@ -214506,12 +217510,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 number: description: The pull request number. type: integer - organization: *884 + organization: *885 pull_request: title: Pull Request type: object @@ -216805,7 +219809,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 requested_team: title: Team description: Groups of organization members that gives permissions @@ -216997,12 +220001,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 number: description: The pull request number. type: integer - organization: *884 + organization: *885 pull_request: title: Pull Request type: object @@ -219291,7 +222295,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 requested_reviewer: title: User type: object @@ -219376,12 +222380,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *882 - installation: *883 + enterprise: *883 + installation: *884 number: description: The pull request number. type: integer - organization: *884 + organization: *885 pull_request: title: Pull Request type: object @@ -221661,7 +224665,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 requested_team: title: Team description: Groups of organization members that gives permissions @@ -221842,9 +224846,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 pull_request: title: Simple Pull Request type: object @@ -224023,8 +227027,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *885 - review: *946 + repository: *886 + review: *947 sender: *4 required: - action @@ -224104,9 +227108,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 pull_request: title: Simple Pull Request type: object @@ -226194,7 +229198,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *885 + repository: *886 sender: *4 thread: type: object @@ -226581,9 +229585,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 pull_request: title: Simple Pull Request type: object @@ -228657,7 +231661,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *885 + repository: *886 sender: *4 thread: type: object @@ -229047,10 +232051,10 @@ x-webhooks: type: string before: type: string - enterprise: *882 - installation: *883 - number: *941 - organization: *884 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 pull_request: title: Pull Request type: object @@ -231325,7 +234329,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 sender: *4 required: - action @@ -231407,11 +234411,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *947 - enterprise: *882 - installation: *883 - number: *941 - organization: *884 + assignee: *948 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 pull_request: title: Pull Request type: object @@ -233698,7 +236702,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 sender: *4 required: - action @@ -233777,11 +236781,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *882 - installation: *883 - label: *905 - number: *941 - organization: *884 + enterprise: *883 + installation: *884 + label: *906 + number: *942 + organization: *885 pull_request: title: Pull Request type: object @@ -236058,7 +239062,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 sender: *4 required: - action @@ -236139,10 +239143,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *882 - installation: *883 - number: *941 - organization: *884 + enterprise: *883 + installation: *884 + number: *942 + organization: *885 pull_request: title: Pull Request type: object @@ -238411,7 +241415,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *885 + repository: *886 sender: *4 required: - action @@ -238611,7 +241615,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *882 + enterprise: *883 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -238703,8 +241707,8 @@ x-webhooks: - url - author - committer - installation: *883 - organization: *884 + installation: *884 + organization: *885 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -239290,9 +242294,9 @@ x-webhooks: type: string enum: - published - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 registry_package: type: object properties: @@ -239738,7 +242742,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *928 + items: *929 summary: type: string tag_name: @@ -239792,7 +242796,7 @@ x-webhooks: - owner - package_version - registry - repository: *885 + repository: *886 sender: *4 required: - action @@ -239870,9 +242874,9 @@ x-webhooks: type: string enum: - updated - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 registry_package: type: object properties: @@ -240180,7 +243184,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *928 + items: *929 summary: type: string tag_name: @@ -240229,7 +243233,7 @@ x-webhooks: - owner - package_version - registry - repository: *885 + repository: *886 sender: *4 required: - action @@ -240306,10 +243310,10 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - release: &948 + enterprise: *883 + installation: *884 + organization: *885 + release: &949 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object. @@ -240627,7 +243631,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *885 + repository: *886 sender: *4 required: - action @@ -240704,11 +243708,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - organization: *884 - release: *948 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + release: *949 + repository: *886 sender: *4 required: - action @@ -240825,11 +243829,11 @@ x-webhooks: type: boolean required: - to - enterprise: *882 - installation: *883 - organization: *884 - release: *948 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + release: *949 + repository: *886 sender: *4 required: - action @@ -240907,9 +243911,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) @@ -241231,7 +244235,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *885 + repository: *886 sender: *4 required: - action @@ -241307,10 +244311,10 @@ x-webhooks: type: string enum: - published - enterprise: *882 - installation: *883 - organization: *884 - release: &949 + enterprise: *883 + installation: *884 + organization: *885 + release: &950 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object. @@ -241629,7 +244633,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *885 + repository: *886 sender: *4 required: - action @@ -241705,11 +244709,11 @@ x-webhooks: type: string enum: - released - enterprise: *882 - installation: *883 - organization: *884 - release: *948 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + release: *949 + repository: *886 sender: *4 required: - action @@ -241785,11 +244789,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *882 - installation: *883 - organization: *884 - release: *949 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + release: *950 + repository: *886 sender: *4 required: - action @@ -241865,11 +244869,11 @@ x-webhooks: type: string enum: - published - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - repository_advisory: *782 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + repository_advisory: *783 sender: *4 required: - action @@ -241945,11 +244949,11 @@ x-webhooks: type: string enum: - reported - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - repository_advisory: *782 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + repository_advisory: *783 sender: *4 required: - action @@ -242025,10 +245029,10 @@ x-webhooks: type: string enum: - archived - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -242105,10 +245109,10 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -242186,10 +245190,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -242273,10 +245277,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -242388,10 +245392,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -242463,10 +245467,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 status: type: string @@ -242547,10 +245551,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -242627,10 +245631,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -242724,10 +245728,10 @@ x-webhooks: - name required: - repository - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -242807,10 +245811,10 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 repository_ruleset: *195 sender: *4 required: @@ -242889,10 +245893,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 repository_ruleset: *195 sender: *4 required: @@ -242971,10 +245975,10 @@ x-webhooks: type: string enum: - edited - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 repository_ruleset: *195 changes: type: object @@ -243036,16 +246040,16 @@ x-webhooks: properties: added: type: array - items: *750 + items: *751 deleted: type: array - items: *750 + items: *751 updated: type: array items: type: object properties: - rule: *750 + rule: *751 changes: type: object properties: @@ -243279,10 +246283,10 @@ x-webhooks: - from required: - owner - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -243360,10 +246364,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -243441,7 +246445,7 @@ x-webhooks: type: string enum: - create - alert: &950 + alert: &951 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -243563,10 +246567,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -243772,10 +246776,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -243853,11 +246857,11 @@ x-webhooks: type: string enum: - reopen - alert: *950 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + alert: *951 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -244056,10 +247060,10 @@ x-webhooks: enum: - fixed - open - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -244137,7 +247141,7 @@ x-webhooks: type: string enum: - assigned - alert: &951 + alert: &952 type: object properties: number: *131 @@ -244280,10 +247284,10 @@ x-webhooks: required: *21 nullable: true assignee: *4 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -244361,11 +247365,11 @@ x-webhooks: type: string enum: - created - alert: *951 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + alert: *952 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -244446,11 +247450,11 @@ x-webhooks: type: string enum: - created - alert: *951 - installation: *883 - location: *952 - organization: *884 - repository: *885 + alert: *952 + installation: *884 + location: *953 + organization: *885 + repository: *886 sender: *4 required: - location @@ -244688,11 +247692,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *951 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + alert: *952 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -244770,11 +247774,11 @@ x-webhooks: type: string enum: - reopened - alert: *951 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + alert: *952 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -244852,11 +247856,11 @@ x-webhooks: type: string enum: - resolved - alert: *951 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + alert: *952 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -244934,12 +247938,12 @@ x-webhooks: type: string enum: - unassigned - alert: *951 + alert: *952 assignee: *4 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -245017,11 +248021,11 @@ x-webhooks: type: string enum: - validated - alert: *951 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + alert: *952 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -245147,10 +248151,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *885 - enterprise: *882 - installation: *883 - organization: *884 + repository: *886 + enterprise: *883 + installation: *884 + organization: *885 sender: *4 required: - action @@ -245228,11 +248232,11 @@ x-webhooks: type: string enum: - published - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - security_advisory: &953 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + security_advisory: &954 description: The details of the security advisory, including summary, description, and severity. type: object @@ -245403,11 +248407,11 @@ x-webhooks: type: string enum: - updated - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 - security_advisory: *953 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 + security_advisory: *954 sender: *4 required: - action @@ -245480,10 +248484,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -245656,10 +248660,10 @@ x-webhooks: type: object properties: security_and_analysis: *443 - enterprise: *882 - installation: *883 - organization: *884 - repository: *489 + enterprise: *883 + installation: *884 + organization: *885 + repository: *490 sender: *4 required: - changes @@ -245737,12 +248741,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - sponsorship: &954 + sponsorship: &955 type: object properties: created_at: @@ -246043,12 +249047,12 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - sponsorship: *954 + sponsorship: *955 required: - action - sponsorship @@ -246136,12 +249140,12 @@ x-webhooks: type: string required: - from - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - sponsorship: *954 + sponsorship: *955 required: - action - changes @@ -246218,17 +249222,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &955 + effective_date: &956 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: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - sponsorship: *954 + sponsorship: *955 required: - action - sponsorship @@ -246302,7 +249306,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &956 + changes: &957 type: object properties: tier: @@ -246346,13 +249350,13 @@ x-webhooks: - from required: - tier - effective_date: *955 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + effective_date: *956 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - sponsorship: *954 + sponsorship: *955 required: - action - changes @@ -246429,13 +249433,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *956 - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + changes: *957 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - sponsorship: *954 + sponsorship: *955 required: - action - changes @@ -246509,10 +249513,10 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -246595,10 +249599,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -247018,15 +250022,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *882 + enterprise: *883 id: description: The unique identifier of the status. type: integer - installation: *883 + installation: *884 name: type: string - organization: *884 - repository: *885 + organization: *885 + repository: *886 sender: *4 sha: description: The Commit SHA. @@ -247141,9 +250145,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *229 - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -247233,9 +250237,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *229 - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -247325,9 +250329,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *229 - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -247417,9 +250421,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *229 - installation: *883 - organization: *884 - repository: *885 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -247496,12 +250500,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 - team: &957 + team: &958 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -247724,9 +250728,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 repository: title: Repository description: A git repository @@ -248184,7 +251188,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *957 + team: *958 required: - action - team @@ -248260,9 +251264,9 @@ x-webhooks: type: string enum: - created - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 repository: title: Repository description: A git repository @@ -248720,7 +251724,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *957 + team: *958 required: - action - team @@ -248797,9 +251801,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 repository: title: Repository description: A git repository @@ -249257,7 +252261,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *957 + team: *958 required: - action - team @@ -249401,9 +252405,9 @@ x-webhooks: - from required: - permissions - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 repository: title: Repository description: A git repository @@ -249861,7 +252865,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *957 + team: *958 required: - action - changes @@ -249939,9 +252943,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *882 - installation: *883 - organization: *884 + enterprise: *883 + installation: *884 + organization: *885 repository: title: Repository description: A git repository @@ -250399,7 +253403,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *957 + team: *958 required: - action - team @@ -250475,10 +253479,10 @@ x-webhooks: type: string enum: - started - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 required: - action @@ -250551,16 +253555,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *882 + enterprise: *883 inputs: type: object nullable: true additionalProperties: true - installation: *883 - organization: *884 + installation: *884 + organization: *885 ref: type: string - repository: *885 + repository: *886 sender: *4 workflow: type: string @@ -250642,10 +253646,10 @@ x-webhooks: type: string enum: - completed - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 workflow_job: allOf: @@ -250882,7 +253886,7 @@ x-webhooks: type: string required: - conclusion - deployment: *631 + deployment: *632 required: - action - repository @@ -250961,10 +253965,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *882 - installation: *883 - organization: *884 - repository: *885 + enterprise: *883 + installation: *884 + organization: *885 + repository: *886 sender: *4 workflow_job: allOf: @@ -251224,7 +254228,7 @@ x-webhooks: required: - status {"code":"deadline_exceeded","msg":"operation timed out"}