diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 9d1f815fbf..9e5c976204 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -195,6 +195,10 @@ { "name": "projects", "description": "Endpoints to manage Projects using the REST API." + }, + { + "name": "agent-tasks", + "description": "Endpoints to manage and interact with agent tasks." } ], "servers": [ @@ -325,196 +329,3491 @@ "type": "string" } } - ] - } - }, - { - "name": "is_withdrawn", - "in": "query", - "description": "Whether to only return advisories that have been withdrawn.", - "schema": { - "type": "boolean" + ] + } + }, + { + "name": "is_withdrawn", + "in": "query", + "description": "Whether to only return advisories that have been withdrawn.", + "schema": { + "type": "boolean" + } + }, + { + "name": "affects", + "in": "query", + "description": "If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified.\nIf the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.\n\nExample: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 1000, + "items": { + "type": "string" + } + } + ] + } + }, + { + "name": "published", + "in": "query", + "description": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "schema": { + "type": "string" + } + }, + { + "name": "updated", + "in": "query", + "description": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "schema": { + "type": "string" + } + }, + { + "name": "modified", + "description": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentage", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being exploited.", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentile", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "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", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "updated", + "published", + "epss_percentage", + "epss_percentile" + ], + "default": "published" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/global-advisory" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/global-advisory-items" + } + } + } + } + }, + "429": { + "description": "Too many requests", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "global-advisories" + } + } + }, + "/advisories/{ghsa_id}": { + "get": { + "summary": "Get a global security advisory", + "description": "Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.", + "tags": [ + "security-advisories" + ], + "operationId": "security-advisories/get-global-advisory", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory" + }, + "parameters": [ + { + "$ref": "#/components/parameters/ghsa_id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/global-advisory" + }, + "examples": { + "default": { + "$ref": "#/components/examples/global-advisory" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "global-advisories" + } + } + }, + "/agents/repos/{owner}/{repo}/tasks": { + "get": { + "summary": "List tasks for repository", + "description": "Returns a list of tasks for a specific repository", + "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" + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false`, returns only non-archived tasks." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID" + } + ], + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "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": "Create a task", + "description": "Creates a new task for a repository", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/create-task", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#create-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, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "event_content" + ], + "properties": { + "agent_id": { + "type": "integer", + "format": "int64", + "description": "Agent ID (optional, defaults to coding agent)" + }, + "problem_statement": { + "type": "string", + "description": "Additional prompting for the agent" + }, + "event_content": { + "type": "string", + "description": "User's written prompt" + }, + "model": { + "type": "string", + "description": "Model identifier" + }, + "custom_agent": { + "type": "string", + "description": "Custom agent identifier" + }, + "create_pull_request": { + "type": "boolean", + "description": "Whether to create a PR" + }, + "base_ref": { + "type": "string", + "description": "Base ref for new branch/PR" + }, + "event_type": { + "type": "string", + "description": "Type of event" + }, + "event_url": { + "type": "string", + "description": "URL of the triggering event" + }, + "event_identifiers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Identifiers for tracking" + } + } + }, + "examples": { + "default": { + "value": { + "event_content": "Fix the login button on the homepage", + "create_pull_request": true, + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + "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": "Returns a task by ID scoped to an owner/repo path", + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "agent_id": { + "type": "integer", + "format": "int64", + "description": "Agent ID" + }, + "agent_task_id": { + "type": "string", + "description": "Agent internal task ID" + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "event_type": { + "type": "string", + "description": "Type of event that triggered this session" + }, + "event_url": { + "type": "string", + "description": "URL of the triggering event" + }, + "event_content": { + "type": "string", + "description": "Content of the triggering event" + }, + "event_identifiers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Identifiers for tracking" + }, + "resource_type": { + "type": "string", + "description": "Type of resource associated with this session" + }, + "resource_id": { + "type": "integer", + "format": "int64", + "description": "Resource ID" + }, + "resource_number": { + "type": "integer", + "format": "int32", + "description": "Resource number (e.g., PR number)" + }, + "resource_global_id": { + "type": "string", + "description": "GraphQL global ID of the resource" + }, + "resource_state": { + "type": "string", + "description": "State of the associated resource" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "workflow_run_id": { + "type": "integer", + "format": "int64", + "description": "GitHub Actions workflow run ID" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "premium_requests": { + "type": "number", + "format": "double", + "description": "Premium request count" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether this session supports remote steering via Mission Control" + }, + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "event_content": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main" + } + ] + } + } + } + } + } + }, + "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" + } + } + } + } } }, - { - "name": "affects", - "in": "query", - "description": "If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified.\nIf the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.\n\nExample: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "maxItems": 1000, - "items": { - "type": "string" + "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": "Returns a list of tasks for the authenticated user", + "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": "published", + "name": "per_page", "in": "query", - "description": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "schema": { - "type": "string" - } + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." }, { - "name": "updated", + "name": "page", "in": "query", - "description": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "schema": { - "type": "string" - } + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." }, { - "name": "modified", - "description": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "name": "sort", "in": "query", "schema": { - "type": "string" - } + "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": "epss_percentage", + "name": "direction", "in": "query", - "description": "If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being exploited.", "schema": { - "type": "string" - } + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." }, { - "name": "epss_percentile", + "name": "state", "in": "query", - "description": "If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.", "schema": { "type": "string" - } - }, - { - "$ref": "#/components/parameters/pagination-before" - }, - { - "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/direction" + }, + "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": "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).\"", + "name": "is_archived", "in": "query", "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } + "type": "boolean" + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false`, returns only non-archived tasks." }, { - "name": "sort", - "description": "The property to sort the results by.", + "name": "since", "in": "query", - "required": false, "schema": { "type": "string", - "enum": [ - "updated", - "published", - "epss_percentage", - "epss_percentile" - ], - "default": "published" - } + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" } ], "responses": { "200": { - "description": "Response", + "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": "array", - "items": { - "$ref": "#/components/schemas/global-advisory" + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + "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": { - "$ref": "#/components/examples/global-advisory-items" + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } } } } } }, - "429": { - "description": "Too many requests", + "400": { + "description": "Bad request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/basic-error" + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated 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": { - "$ref": "#/components/responses/validation_failed_simple" + "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" + } + } + } + } + } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "security-advisories", - "subcategory": "global-advisories" } } }, - "/advisories/{ghsa_id}": { + "/agents/tasks/{task_id}": { "get": { - "summary": "Get a global security advisory", - "description": "Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.", + "summary": "Get a task by ID", + "description": "Returns a task by ID with its associated sessions", "tags": [ - "security-advisories" + "agent-tasks" ], - "operationId": "security-advisories/get-global-advisory", + "operationId": "agent-tasks/get-task-by-id", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory" + "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": [ { - "$ref": "#/components/parameters/ghsa_id" + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." } ], "responses": { "200": { - "description": "Response", + "description": "Task retrieved successfully", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/global-advisory" + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "agent_id": { + "type": "integer", + "format": "int64", + "description": "Agent ID" + }, + "agent_task_id": { + "type": "string", + "description": "Agent internal task ID" + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "event_type": { + "type": "string", + "description": "Type of event that triggered this session" + }, + "event_url": { + "type": "string", + "description": "URL of the triggering event" + }, + "event_content": { + "type": "string", + "description": "Content of the triggering event" + }, + "event_identifiers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Identifiers for tracking" + }, + "resource_type": { + "type": "string", + "description": "Type of resource associated with this session" + }, + "resource_id": { + "type": "integer", + "format": "int64", + "description": "Resource ID" + }, + "resource_number": { + "type": "integer", + "format": "int32", + "description": "Resource number (e.g., PR number)" + }, + "resource_global_id": { + "type": "string", + "description": "GraphQL global ID of the resource" + }, + "resource_state": { + "type": "string", + "description": "State of the associated resource" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "workflow_run_id": { + "type": "integer", + "format": "int64", + "description": "GitHub Actions workflow run ID" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "premium_requests": { + "type": "number", + "format": "double", + "description": "Premium request count" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether this session supports remote steering via Mission Control" + }, + "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": { - "$ref": "#/components/examples/global-advisory" + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "event_content": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main" + } + ] + } + } + } + } + } + }, + "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": { - "$ref": "#/components/responses/not_found" + "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" + } + } + } + } + } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "security-advisories", - "subcategory": "global-advisories" } } }, @@ -10563,7 +13862,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/oidc-custom-sub" + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", + "type": "object", + "properties": { + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } + } + } }, "examples": { "default": { @@ -14402,210 +17712,230 @@ } }, "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "artifact-metadata" - } - } - }, - "/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.", - "tags": [ - "orgs" - ], - "operationId": "orgs/set-cluster-deployment-records", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "name": "cluster", - "in": "path", - "description": "The cluster name.", - "required": true, - "schema": { - "type": "string", - "minLength": 1, - "maxLength": 128, - "pattern": "^[a-zA-Z0-9._-]+$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "logical_environment": { - "type": "string", - "description": "The stage of the deployment.", - "minLength": 1, - "maxLength": 128 - }, - "physical_environment": { - "type": "string", - "description": "The physical region of the deployment.", - "maxLength": 128 - }, - "deployments": { - "type": "array", - "description": "The list of deployments to record.", - "maxItems": 1000, - "items": { - "type": "object", - "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", - "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", - "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", - "maxLength": 100, - "x-multi-segment": true, - "examples": [ - "1.2.3" - ] - }, - "status": { - "type": "string", - "description": "The deployment status of the artifact.", - "default": "deployed", - "enum": [ - "deployed", - "decommissioned" - ] - }, - "deployment_name": { - "type": "string", - "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", - "minLength": 1, - "maxLength": 256 - }, - "github_repository": { - "type": "string", - "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", - "maxLength": 100, - "pattern": "^[A-Za-z0-9.\\-_]+$", - "examples": [ - "my-github-repo" - ] - }, - "tags": { - "type": "object", - "description": "Key-value pairs to tag the deployment record.", - "additionalProperties": { - "type": "string" - } - }, - "runtime_risks": { - "type": "array", - "description": "A list of runtime risks associated with the deployment.", - "maxItems": 4, - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "critical-resource", - "internet-exposed", - "lateral-movement", - "sensitive-data" - ] - } - } - }, - "required": [ - "name", - "deployment_name", - "digest" - ] - } - } - }, - "required": [ - "logical_environment", - "deployments" - ] - }, - "examples": { - "default": { - "value": { - "logical_environment": "prod", - "physical_environment": "pacific-east", - "deployments": [ - { - "name": "awesome-image", - "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", - "version": "2.1.0", - "status": "deployed", - "deployment_name": "deployment-pod", - "tags": { - "runtime-risk": "sensitive-data" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Deployment records created or updated successfully.\n", + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "artifact-metadata" + } + } + }, + "/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.", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-cluster-deployment-records", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "cluster", + "in": "path", + "description": "The cluster name.", + "required": true, + "schema": { + "type": "string", + "minLength": 1, + "maxLength": 128, + "pattern": "^[a-zA-Z0-9._-]+$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "logical_environment": { + "type": "string", + "description": "The stage of the deployment.", + "minLength": 1, + "maxLength": 128 + }, + "physical_environment": { + "type": "string", + "description": "The physical region of the deployment.", + "maxLength": 128 + }, + "deployments": { + "type": "array", + "description": "The list of deployments to record.", + "maxItems": 1000, + "items": { + "type": "object", + "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", + "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", + "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", + "maxLength": 100, + "x-multi-segment": true, + "examples": [ + "1.2.3" + ] + }, + "status": { + "type": "string", + "description": "The deployment status of the artifact.", + "default": "deployed", + "enum": [ + "deployed", + "decommissioned" + ] + }, + "deployment_name": { + "type": "string", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", + "minLength": 1, + "maxLength": 256 + }, + "github_repository": { + "type": "string", + "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", + "maxLength": 100, + "pattern": "^[A-Za-z0-9.\\-_]+$", + "examples": [ + "my-github-repo" + ] + }, + "tags": { + "type": "object", + "description": "Key-value pairs to tag the deployment record.", + "additionalProperties": { + "type": "string" + } + }, + "runtime_risks": { + "type": "array", + "description": "A list of runtime risks associated with the deployment.", + "maxItems": 4, + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "critical-resource", + "internet-exposed", + "lateral-movement", + "sensitive-data" + ] + } + } + }, + "required": [ + "name", + "deployment_name", + "digest" + ] + } + } + }, + "required": [ + "logical_environment", + "deployments" + ] + }, + "examples": { + "default": { + "value": { + "logical_environment": "prod", + "physical_environment": "pacific-east", + "deployments": [ + { + "name": "awesome-image", + "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", + "version": "2.1.0", + "status": "deployed", + "deployment_name": "deployment-pod", + "tags": { + "runtime-risk": "sensitive-data" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Deployment records created or updated successfully.\n", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of deployment records created", + "type": "integer" + }, + "deployment_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/artifact-deployment-record" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/artifact-deployment-record-list" + } + } + } + } + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "total_count": { - "description": "The number of deployment records created", - "type": "integer" - }, - "deployment_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/artifact-deployment-record" - } - } - } + "$ref": "#/components/schemas/basic-error" }, "examples": { - "default": { - "$ref": "#/components/examples/artifact-deployment-record-list" + "insufficient_repo_permissions": { + "value": { + "message": { + "cause": "artifact metadata write permission required on one or more repositories", + "repositories": [ + 123, + 345 + ] + } + } } } } } }, - "403": { - "$ref": "#/components/responses/forbidden" - }, "404": { "$ref": "#/components/responses/not_found" } @@ -24055,7 +27385,7 @@ "/orgs/{org}/organization-roles": { "get": { "summary": "Get all organization roles for an organization", - "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -24334,7 +27664,7 @@ "/orgs/{org}/organization-roles/{role_id}": { "get": { "summary": "Get an organization role", - "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -30462,6 +33792,19 @@ "items": { "type": "string" } + }, + "failover_network_settings_ids": { + "type": "array", + "minItems": 0, + "maxItems": 1, + "description": "A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", + "items": { + "type": "string" + } + }, + "failover_network_enabled": { + "type": "boolean", + "description": "Indicates whether the failover network resource is enabled." } }, "required": [ @@ -30603,6 +33946,19 @@ "items": { "type": "string" } + }, + "failover_network_settings_ids": { + "type": "array", + "minItems": 0, + "maxItems": 1, + "description": "A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", + "items": { + "type": "string" + } + }, + "failover_network_enabled": { + "type": "boolean", + "description": "Indicates whether the failover network resource is enabled." } } }, @@ -108213,6 +111569,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -123305,6 +126662,14 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] } }, "required": [ @@ -123398,6 +126763,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -123415,6 +126788,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -123432,6 +126813,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] } }, "required": [ @@ -123500,6 +126889,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -123517,6 +126914,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -123534,6 +126939,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] } }, "required": [ @@ -123551,6 +126964,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] } }, "required": [ @@ -123568,6 +126989,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] } }, "required": [ @@ -132872,6 +136301,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -293405,12 +296835,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { @@ -296560,12 +299988,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -313283,12 +316709,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -313576,12 +317000,10 @@ "score": 8.5 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-532", diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index b0b057f861..433ea54a60 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -103,6 +103,8 @@ tags: description: Endpoints to manage campaigns via the REST API. - name: projects description: Endpoints to manage Projects using the REST API. +- name: agent-tasks + description: Endpoints to manage and interact with agent tasks. servers: - url: https://api.github.com externalDocs: @@ -336,6 +338,2539 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories + "/agents/repos/{owner}/{repo}/tasks": + get: + summary: List tasks for repository + description: Returns a list of tasks for a specific repository + 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 + description: Filter by archived status. When `true`, returns only archived + tasks. When `false`, returns only non-archived tasks. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + - name: creator_id + in: query + schema: + type: integer + description: Filter tasks by creator user ID + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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: Create a task + description: Creates a new task for a repository + tags: + - agent-tasks + operationId: agent-tasks/create-task + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#create-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 + content: + application/json: + schema: + type: object + required: + - event_content + properties: + agent_id: + type: integer + format: int64 + description: Agent ID (optional, defaults to coding agent) + problem_statement: + type: string + description: Additional prompting for the agent + event_content: + type: string + description: User's written prompt + model: + type: string + description: Model identifier + custom_agent: + type: string + description: Custom agent identifier + create_pull_request: + type: boolean + description: Whether to create a PR + base_ref: + type: string + description: Base ref for new branch/PR + event_type: + type: string + description: Type of event + event_url: + type: string + description: URL of the triggering event + event_identifiers: + type: array + items: + type: string + description: Identifiers for tracking + examples: + default: + value: + event_content: Fix the login button on the homepage + create_pull_request: true + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + 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: Returns a task by ID scoped to an owner/repo path + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + agent_id: + type: integer + format: int64 + description: Agent ID + agent_task_id: + type: string + description: Agent internal task ID + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + event_type: + type: string + description: Type of event that triggered this session + event_url: + type: string + description: URL of the triggering event + event_content: + type: string + description: Content of the triggering event + event_identifiers: + type: array + items: + type: string + description: Identifiers for tracking + resource_type: + type: string + description: Type of resource associated with this session + resource_id: + type: integer + format: int64 + description: Resource ID + resource_number: + type: integer + format: int32 + description: Resource number (e.g., PR number) + resource_global_id: + type: string + description: GraphQL global ID of the resource + resource_state: + type: string + description: State of the associated resource + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + workflow_run_id: + type: integer + format: int64 + description: GitHub Actions workflow run ID + model: + type: string + description: Model used for this session + premium_requests: + type: number + format: double + description: Premium request count + remote_steerable: + type: boolean + description: Whether this session supports remote steering + via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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' + event_content: Fix the login button on the homepage + head_ref: copilot/fix-1 + base_ref: main + '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: Returns a list of tasks for the authenticated user + 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 + description: Filter by archived status. When `true`, returns only archived + tasks. When `false`, returns only non-archived tasks. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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: Returns a task by ID with its associated sessions + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + agent_id: + type: integer + format: int64 + description: Agent ID + agent_task_id: + type: string + description: Agent internal task ID + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + event_type: + type: string + description: Type of event that triggered this session + event_url: + type: string + description: URL of the triggering event + event_content: + type: string + description: Content of the triggering event + event_identifiers: + type: array + items: + type: string + description: Identifiers for tracking + resource_type: + type: string + description: Type of resource associated with this session + resource_id: + type: integer + format: int64 + description: Resource ID + resource_number: + type: integer + format: int32 + description: Resource number (e.g., PR number) + resource_global_id: + type: string + description: GraphQL global ID of the resource + resource_state: + type: string + description: State of the associated resource + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + workflow_run_id: + type: integer + format: int64 + description: GitHub Actions workflow run ID + model: + type: string + description: Model used for this session + premium_requests: + type: number + format: double + description: Premium request count + remote_steerable: + type: boolean + description: Whether this session supports remote steering + via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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' + event_content: Fix the login button on the homepage + head_ref: copilot/fix-1 + base_ref: main + '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 @@ -7551,7 +10086,16 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/oidc-custom-sub" + title: Actions OIDC Subject customization + description: Actions OIDC Subject customization + type: object + properties: + include_claim_keys: + description: Array of unique strings. Each claim key can only contain + alphanumeric characters and underscores. + type: array + items: + type: string examples: default: "$ref": "#/components/examples/oidc-custom-sub" @@ -10559,7 +13103,20 @@ paths: default: "$ref": "#/components/examples/artifact-deployment-record-list" '403': - "$ref": "#/components/responses/forbidden" + description: Forbidden + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + insufficient_repo_permissions: + value: + message: + cause: artifact metadata write permission required on one or + more repositories + repositories: + - 123 + - 345 '404': "$ref": "#/components/responses/not_found" x-github: @@ -17482,7 +20039,7 @@ paths: To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -17700,7 +20257,7 @@ paths: To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -22068,6 +24625,19 @@ paths: must be specified in the list. items: type: string + failover_network_settings_ids: + type: array + minItems: 0 + maxItems: 1 + description: A list of identifiers of the failover network settings + resources to use for the network configuration. Exactly one resource + identifier must be specified in the list. + items: + type: string + failover_network_enabled: + type: boolean + description: Indicates whether the failover network resource is + enabled. required: - name - network_settings_ids @@ -22169,6 +24739,19 @@ paths: must be specified in the list. items: type: string + failover_network_settings_ids: + type: array + minItems: 0 + maxItems: 1 + description: A list of identifiers of the failover network settings + resources to use for the network configuration. Exactly one resource + identifier must be specified in the list. + items: + type: string + failover_network_enabled: + type: boolean + description: Indicates whether the failover network resource is + enabled. examples: default: value: @@ -78313,6 +80896,7 @@ components: - unknown - direct - transitive + - inconclusive - security_advisory: "$ref": "#/components/schemas/dependabot-alert-security-advisory" @@ -89499,6 +92083,12 @@ components: commit_url: type: string description: The API URL to get the associated commit resource + html_url: + type: string + format: uri + description: The GitHub URL to get the associated commit resource. + examples: + - https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1 required: - path - start_line @@ -89575,6 +92165,12 @@ components: description: The API URL to get the issue where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/1347 + html_url: + type: string + format: uri + description: The GitHub URL for the issue where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url secret-scanning-location-issue-body: @@ -89588,6 +92184,12 @@ components: description: The API URL to get the issue where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/1347 + html_url: + type: string + format: uri + description: The GitHub URL for the issue where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url secret-scanning-location-issue-comment: @@ -89601,6 +92203,12 @@ components: description: The API URL to get the issue comment where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + html_url: + type: string + format: uri + description: The GitHub URL for the issue comment where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url secret-scanning-location-discussion-title: @@ -89655,6 +92263,12 @@ components: description: The API URL to get the pull request where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url secret-scanning-location-pull-request-body: @@ -89669,6 +92283,12 @@ components: description: The API URL to get the pull request where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url secret-scanning-location-pull-request-comment: @@ -89684,6 +92304,13 @@ components: was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request comment where the secret + was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url secret-scanning-location-pull-request-review: @@ -89699,6 +92326,13 @@ components: was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request review where the secret + was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url secret-scanning-location-pull-request-review-comment: @@ -89714,6 +92348,13 @@ components: secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request review comment where the + secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846#discussion_r12 required: - pull_request_review_comment_url secret-scanning-first-detected-location: @@ -96437,6 +99078,7 @@ components: - unknown - direct - transitive + - inconclusive - security_advisory: "$ref": "#/components/schemas/dependabot-alert-security-advisory" @@ -215290,7 +217932,7 @@ components: - cwe_id: CWE-400 name: Uncontrolled Resource Consumption epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 credits: - user: @@ -218320,7 +220962,7 @@ components: vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N score: 8.7 epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 cwes: - cwe_id: CWE-200 @@ -232596,7 +235238,7 @@ components: vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N score: 8.7 epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 cwes: - cwe_id: CWE-200 @@ -232805,7 +235447,7 @@ components: vector_string: CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N score: 8.5 epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 cwes: - cwe_id: CWE-532 diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.json b/descriptions-next/api.github.com/api.github.com.2026-03-10.json index 2e68fa0fd1..bba083c9a9 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.json @@ -195,6 +195,10 @@ { "name": "projects", "description": "Endpoints to manage Projects using the REST API." + }, + { + "name": "agent-tasks", + "description": "Endpoints to manage and interact with agent tasks." } ], "servers": [ @@ -325,196 +329,3491 @@ "type": "string" } } - ] - } - }, - { - "name": "is_withdrawn", - "in": "query", - "description": "Whether to only return advisories that have been withdrawn.", - "schema": { - "type": "boolean" + ] + } + }, + { + "name": "is_withdrawn", + "in": "query", + "description": "Whether to only return advisories that have been withdrawn.", + "schema": { + "type": "boolean" + } + }, + { + "name": "affects", + "in": "query", + "description": "If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified.\nIf the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.\n\nExample: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 1000, + "items": { + "type": "string" + } + } + ] + } + }, + { + "name": "published", + "in": "query", + "description": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "schema": { + "type": "string" + } + }, + { + "name": "updated", + "in": "query", + "description": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "schema": { + "type": "string" + } + }, + { + "name": "modified", + "description": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentage", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being exploited.", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentile", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "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", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "updated", + "published", + "epss_percentage", + "epss_percentile" + ], + "default": "published" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/global-advisory" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/global-advisory-items" + } + } + } + } + }, + "429": { + "description": "Too many requests", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "global-advisories" + } + } + }, + "/advisories/{ghsa_id}": { + "get": { + "summary": "Get a global security advisory", + "description": "Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.", + "tags": [ + "security-advisories" + ], + "operationId": "security-advisories/get-global-advisory", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory" + }, + "parameters": [ + { + "$ref": "#/components/parameters/ghsa_id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/global-advisory" + }, + "examples": { + "default": { + "$ref": "#/components/examples/global-advisory" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "global-advisories" + } + } + }, + "/agents/repos/{owner}/{repo}/tasks": { + "get": { + "summary": "List tasks for repository", + "description": "Returns a list of tasks for a specific repository", + "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" + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false`, returns only non-archived tasks." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID" + } + ], + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "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": "Create a task", + "description": "Creates a new task for a repository", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/create-task", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#create-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, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "event_content" + ], + "properties": { + "agent_id": { + "type": "integer", + "format": "int64", + "description": "Agent ID (optional, defaults to coding agent)" + }, + "problem_statement": { + "type": "string", + "description": "Additional prompting for the agent" + }, + "event_content": { + "type": "string", + "description": "User's written prompt" + }, + "model": { + "type": "string", + "description": "Model identifier" + }, + "custom_agent": { + "type": "string", + "description": "Custom agent identifier" + }, + "create_pull_request": { + "type": "boolean", + "description": "Whether to create a PR" + }, + "base_ref": { + "type": "string", + "description": "Base ref for new branch/PR" + }, + "event_type": { + "type": "string", + "description": "Type of event" + }, + "event_url": { + "type": "string", + "description": "URL of the triggering event" + }, + "event_identifiers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Identifiers for tracking" + } + } + }, + "examples": { + "default": { + "value": { + "event_content": "Fix the login button on the homepage", + "create_pull_request": true, + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + "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": "Returns a task by ID scoped to an owner/repo path", + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "agent_id": { + "type": "integer", + "format": "int64", + "description": "Agent ID" + }, + "agent_task_id": { + "type": "string", + "description": "Agent internal task ID" + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "event_type": { + "type": "string", + "description": "Type of event that triggered this session" + }, + "event_url": { + "type": "string", + "description": "URL of the triggering event" + }, + "event_content": { + "type": "string", + "description": "Content of the triggering event" + }, + "event_identifiers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Identifiers for tracking" + }, + "resource_type": { + "type": "string", + "description": "Type of resource associated with this session" + }, + "resource_id": { + "type": "integer", + "format": "int64", + "description": "Resource ID" + }, + "resource_number": { + "type": "integer", + "format": "int32", + "description": "Resource number (e.g., PR number)" + }, + "resource_global_id": { + "type": "string", + "description": "GraphQL global ID of the resource" + }, + "resource_state": { + "type": "string", + "description": "State of the associated resource" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "workflow_run_id": { + "type": "integer", + "format": "int64", + "description": "GitHub Actions workflow run ID" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "premium_requests": { + "type": "number", + "format": "double", + "description": "Premium request count" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether this session supports remote steering via Mission Control" + }, + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "event_content": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main" + } + ] + } + } + } + } + } + }, + "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" + } + } + } + } } }, - { - "name": "affects", - "in": "query", - "description": "If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified.\nIf the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.\n\nExample: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "maxItems": 1000, - "items": { - "type": "string" + "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": "Returns a list of tasks for the authenticated user", + "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": "published", + "name": "per_page", "in": "query", - "description": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "schema": { - "type": "string" - } + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." }, { - "name": "updated", + "name": "page", "in": "query", - "description": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "schema": { - "type": "string" - } + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." }, { - "name": "modified", - "description": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "name": "sort", "in": "query", "schema": { - "type": "string" - } + "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": "epss_percentage", + "name": "direction", "in": "query", - "description": "If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being exploited.", "schema": { - "type": "string" - } + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." }, { - "name": "epss_percentile", + "name": "state", "in": "query", - "description": "If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.", "schema": { "type": "string" - } - }, - { - "$ref": "#/components/parameters/pagination-before" - }, - { - "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/direction" + }, + "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": "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).\"", + "name": "is_archived", "in": "query", "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } + "type": "boolean" + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false`, returns only non-archived tasks." }, { - "name": "sort", - "description": "The property to sort the results by.", + "name": "since", "in": "query", - "required": false, "schema": { "type": "string", - "enum": [ - "updated", - "published", - "epss_percentage", - "epss_percentile" - ], - "default": "published" - } + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" } ], "responses": { "200": { - "description": "Response", + "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": "array", - "items": { - "$ref": "#/components/schemas/global-advisory" + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + "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": { - "$ref": "#/components/examples/global-advisory-items" + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } } } } } }, - "429": { - "description": "Too many requests", + "400": { + "description": "Bad request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/basic-error" + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated 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": { - "$ref": "#/components/responses/validation_failed_simple" + "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" + } + } + } + } + } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "security-advisories", - "subcategory": "global-advisories" } } }, - "/advisories/{ghsa_id}": { + "/agents/tasks/{task_id}": { "get": { - "summary": "Get a global security advisory", - "description": "Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.", + "summary": "Get a task by ID", + "description": "Returns a task by ID with its associated sessions", "tags": [ - "security-advisories" + "agent-tasks" ], - "operationId": "security-advisories/get-global-advisory", + "operationId": "agent-tasks/get-task-by-id", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory" + "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": [ { - "$ref": "#/components/parameters/ghsa_id" + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." } ], "responses": { "200": { - "description": "Response", + "description": "Task retrieved successfully", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/global-advisory" + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "agent_id": { + "type": "integer", + "format": "int64", + "description": "Agent ID" + }, + "agent_task_id": { + "type": "string", + "description": "Agent internal task ID" + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "event_type": { + "type": "string", + "description": "Type of event that triggered this session" + }, + "event_url": { + "type": "string", + "description": "URL of the triggering event" + }, + "event_content": { + "type": "string", + "description": "Content of the triggering event" + }, + "event_identifiers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Identifiers for tracking" + }, + "resource_type": { + "type": "string", + "description": "Type of resource associated with this session" + }, + "resource_id": { + "type": "integer", + "format": "int64", + "description": "Resource ID" + }, + "resource_number": { + "type": "integer", + "format": "int32", + "description": "Resource number (e.g., PR number)" + }, + "resource_global_id": { + "type": "string", + "description": "GraphQL global ID of the resource" + }, + "resource_state": { + "type": "string", + "description": "State of the associated resource" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "workflow_run_id": { + "type": "integer", + "format": "int64", + "description": "GitHub Actions workflow run ID" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "premium_requests": { + "type": "number", + "format": "double", + "description": "Premium request count" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether this session supports remote steering via Mission Control" + }, + "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": { - "$ref": "#/components/examples/global-advisory" + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "event_content": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main" + } + ] + } + } + } + } + } + }, + "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": { - "$ref": "#/components/responses/not_found" + "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" + } + } + } + } + } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "security-advisories", - "subcategory": "global-advisories" } } }, @@ -10562,7 +13861,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/oidc-custom-sub" + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", + "type": "object", + "properties": { + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } + } + } }, "examples": { "default": { @@ -14401,210 +17711,230 @@ } }, "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "artifact-metadata" - } - } - }, - "/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.", - "tags": [ - "orgs" - ], - "operationId": "orgs/set-cluster-deployment-records", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "name": "cluster", - "in": "path", - "description": "The cluster name.", - "required": true, - "schema": { - "type": "string", - "minLength": 1, - "maxLength": 128, - "pattern": "^[a-zA-Z0-9._-]+$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "logical_environment": { - "type": "string", - "description": "The stage of the deployment.", - "minLength": 1, - "maxLength": 128 - }, - "physical_environment": { - "type": "string", - "description": "The physical region of the deployment.", - "maxLength": 128 - }, - "deployments": { - "type": "array", - "description": "The list of deployments to record.", - "maxItems": 1000, - "items": { - "type": "object", - "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", - "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", - "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", - "maxLength": 100, - "x-multi-segment": true, - "examples": [ - "1.2.3" - ] - }, - "status": { - "type": "string", - "description": "The deployment status of the artifact.", - "default": "deployed", - "enum": [ - "deployed", - "decommissioned" - ] - }, - "deployment_name": { - "type": "string", - "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", - "minLength": 1, - "maxLength": 256 - }, - "github_repository": { - "type": "string", - "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", - "maxLength": 100, - "pattern": "^[A-Za-z0-9.\\-_]+$", - "examples": [ - "my-github-repo" - ] - }, - "tags": { - "type": "object", - "description": "Key-value pairs to tag the deployment record.", - "additionalProperties": { - "type": "string" - } - }, - "runtime_risks": { - "type": "array", - "description": "A list of runtime risks associated with the deployment.", - "maxItems": 4, - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "critical-resource", - "internet-exposed", - "lateral-movement", - "sensitive-data" - ] - } - } - }, - "required": [ - "name", - "deployment_name", - "digest" - ] - } - } - }, - "required": [ - "logical_environment", - "deployments" - ] - }, - "examples": { - "default": { - "value": { - "logical_environment": "prod", - "physical_environment": "pacific-east", - "deployments": [ - { - "name": "awesome-image", - "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", - "version": "2.1.0", - "status": "deployed", - "deployment_name": "deployment-pod", - "tags": { - "runtime-risk": "sensitive-data" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Deployment records created or updated successfully.\n", + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "artifact-metadata" + } + } + }, + "/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.", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-cluster-deployment-records", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "cluster", + "in": "path", + "description": "The cluster name.", + "required": true, + "schema": { + "type": "string", + "minLength": 1, + "maxLength": 128, + "pattern": "^[a-zA-Z0-9._-]+$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "logical_environment": { + "type": "string", + "description": "The stage of the deployment.", + "minLength": 1, + "maxLength": 128 + }, + "physical_environment": { + "type": "string", + "description": "The physical region of the deployment.", + "maxLength": 128 + }, + "deployments": { + "type": "array", + "description": "The list of deployments to record.", + "maxItems": 1000, + "items": { + "type": "object", + "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", + "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", + "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", + "maxLength": 100, + "x-multi-segment": true, + "examples": [ + "1.2.3" + ] + }, + "status": { + "type": "string", + "description": "The deployment status of the artifact.", + "default": "deployed", + "enum": [ + "deployed", + "decommissioned" + ] + }, + "deployment_name": { + "type": "string", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", + "minLength": 1, + "maxLength": 256 + }, + "github_repository": { + "type": "string", + "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", + "maxLength": 100, + "pattern": "^[A-Za-z0-9.\\-_]+$", + "examples": [ + "my-github-repo" + ] + }, + "tags": { + "type": "object", + "description": "Key-value pairs to tag the deployment record.", + "additionalProperties": { + "type": "string" + } + }, + "runtime_risks": { + "type": "array", + "description": "A list of runtime risks associated with the deployment.", + "maxItems": 4, + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "critical-resource", + "internet-exposed", + "lateral-movement", + "sensitive-data" + ] + } + } + }, + "required": [ + "name", + "deployment_name", + "digest" + ] + } + } + }, + "required": [ + "logical_environment", + "deployments" + ] + }, + "examples": { + "default": { + "value": { + "logical_environment": "prod", + "physical_environment": "pacific-east", + "deployments": [ + { + "name": "awesome-image", + "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", + "version": "2.1.0", + "status": "deployed", + "deployment_name": "deployment-pod", + "tags": { + "runtime-risk": "sensitive-data" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Deployment records created or updated successfully.\n", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of deployment records created", + "type": "integer" + }, + "deployment_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/artifact-deployment-record" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/artifact-deployment-record-list" + } + } + } + } + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "total_count": { - "description": "The number of deployment records created", - "type": "integer" - }, - "deployment_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/artifact-deployment-record" - } - } - } + "$ref": "#/components/schemas/basic-error" }, "examples": { - "default": { - "$ref": "#/components/examples/artifact-deployment-record-list" + "insufficient_repo_permissions": { + "value": { + "message": { + "cause": "artifact metadata write permission required on one or more repositories", + "repositories": [ + 123, + 345 + ] + } + } } } } } }, - "403": { - "$ref": "#/components/responses/forbidden" - }, "404": { "$ref": "#/components/responses/not_found" } @@ -24007,7 +27337,7 @@ "/orgs/{org}/organization-roles": { "get": { "summary": "Get all organization roles for an organization", - "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -24286,7 +27616,7 @@ "/orgs/{org}/organization-roles/{role_id}": { "get": { "summary": "Get an organization role", - "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -30417,6 +33747,19 @@ "items": { "type": "string" } + }, + "failover_network_settings_ids": { + "type": "array", + "minItems": 0, + "maxItems": 1, + "description": "A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", + "items": { + "type": "string" + } + }, + "failover_network_enabled": { + "type": "boolean", + "description": "Indicates whether the failover network resource is enabled." } }, "required": [ @@ -30558,6 +33901,19 @@ "items": { "type": "string" } + }, + "failover_network_settings_ids": { + "type": "array", + "minItems": 0, + "maxItems": 1, + "description": "A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", + "items": { + "type": "string" + } + }, + "failover_network_enabled": { + "type": "boolean", + "description": "Indicates whether the failover network resource is enabled." } } }, @@ -107995,6 +111351,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -122698,6 +126055,14 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] } }, "required": [ @@ -122791,6 +126156,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -122808,6 +126181,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -122825,6 +126206,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] } }, "required": [ @@ -122893,6 +126282,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -122910,6 +126307,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -122927,6 +126332,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] } }, "required": [ @@ -122944,6 +126357,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] } }, "required": [ @@ -122961,6 +126382,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] } }, "required": [ @@ -132220,6 +135649,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -292560,12 +295990,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { @@ -295715,12 +299143,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -312437,12 +315863,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -312730,12 +316154,10 @@ "score": 8.5 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-532", diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml index a17c8a171d..394526d088 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml @@ -103,6 +103,8 @@ tags: description: Endpoints to manage campaigns via the REST API. - name: projects description: Endpoints to manage Projects using the REST API. +- name: agent-tasks + description: Endpoints to manage and interact with agent tasks. servers: - url: https://api.github.com externalDocs: @@ -336,6 +338,2539 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories + "/agents/repos/{owner}/{repo}/tasks": + get: + summary: List tasks for repository + description: Returns a list of tasks for a specific repository + 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 + description: Filter by archived status. When `true`, returns only archived + tasks. When `false`, returns only non-archived tasks. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + - name: creator_id + in: query + schema: + type: integer + description: Filter tasks by creator user ID + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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: Create a task + description: Creates a new task for a repository + tags: + - agent-tasks + operationId: agent-tasks/create-task + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#create-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 + content: + application/json: + schema: + type: object + required: + - event_content + properties: + agent_id: + type: integer + format: int64 + description: Agent ID (optional, defaults to coding agent) + problem_statement: + type: string + description: Additional prompting for the agent + event_content: + type: string + description: User's written prompt + model: + type: string + description: Model identifier + custom_agent: + type: string + description: Custom agent identifier + create_pull_request: + type: boolean + description: Whether to create a PR + base_ref: + type: string + description: Base ref for new branch/PR + event_type: + type: string + description: Type of event + event_url: + type: string + description: URL of the triggering event + event_identifiers: + type: array + items: + type: string + description: Identifiers for tracking + examples: + default: + value: + event_content: Fix the login button on the homepage + create_pull_request: true + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + 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: Returns a task by ID scoped to an owner/repo path + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + agent_id: + type: integer + format: int64 + description: Agent ID + agent_task_id: + type: string + description: Agent internal task ID + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + event_type: + type: string + description: Type of event that triggered this session + event_url: + type: string + description: URL of the triggering event + event_content: + type: string + description: Content of the triggering event + event_identifiers: + type: array + items: + type: string + description: Identifiers for tracking + resource_type: + type: string + description: Type of resource associated with this session + resource_id: + type: integer + format: int64 + description: Resource ID + resource_number: + type: integer + format: int32 + description: Resource number (e.g., PR number) + resource_global_id: + type: string + description: GraphQL global ID of the resource + resource_state: + type: string + description: State of the associated resource + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + workflow_run_id: + type: integer + format: int64 + description: GitHub Actions workflow run ID + model: + type: string + description: Model used for this session + premium_requests: + type: number + format: double + description: Premium request count + remote_steerable: + type: boolean + description: Whether this session supports remote steering + via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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' + event_content: Fix the login button on the homepage + head_ref: copilot/fix-1 + base_ref: main + '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: Returns a list of tasks for the authenticated user + 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 + description: Filter by archived status. When `true`, returns only archived + tasks. When `false`, returns only non-archived tasks. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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: Returns a task by ID with its associated sessions + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + agent_id: + type: integer + format: int64 + description: Agent ID + agent_task_id: + type: string + description: Agent internal task ID + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + event_type: + type: string + description: Type of event that triggered this session + event_url: + type: string + description: URL of the triggering event + event_content: + type: string + description: Content of the triggering event + event_identifiers: + type: array + items: + type: string + description: Identifiers for tracking + resource_type: + type: string + description: Type of resource associated with this session + resource_id: + type: integer + format: int64 + description: Resource ID + resource_number: + type: integer + format: int32 + description: Resource number (e.g., PR number) + resource_global_id: + type: string + description: GraphQL global ID of the resource + resource_state: + type: string + description: State of the associated resource + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + workflow_run_id: + type: integer + format: int64 + description: GitHub Actions workflow run ID + model: + type: string + description: Model used for this session + premium_requests: + type: number + format: double + description: Premium request count + remote_steerable: + type: boolean + description: Whether this session supports remote steering + via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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' + event_content: Fix the login button on the homepage + head_ref: copilot/fix-1 + base_ref: main + '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 @@ -7549,7 +10084,16 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/oidc-custom-sub" + title: Actions OIDC Subject customization + description: Actions OIDC Subject customization + type: object + properties: + include_claim_keys: + description: Array of unique strings. Each claim key can only contain + alphanumeric characters and underscores. + type: array + items: + type: string examples: default: "$ref": "#/components/examples/oidc-custom-sub" @@ -10557,7 +13101,20 @@ paths: default: "$ref": "#/components/examples/artifact-deployment-record-list" '403': - "$ref": "#/components/responses/forbidden" + description: Forbidden + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + insufficient_repo_permissions: + value: + message: + cause: artifact metadata write permission required on one or + more repositories + repositories: + - 123 + - 345 '404': "$ref": "#/components/responses/not_found" x-github: @@ -17447,7 +20004,7 @@ paths: To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -17665,7 +20222,7 @@ paths: To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -22035,6 +24592,19 @@ paths: must be specified in the list. items: type: string + failover_network_settings_ids: + type: array + minItems: 0 + maxItems: 1 + description: A list of identifiers of the failover network settings + resources to use for the network configuration. Exactly one resource + identifier must be specified in the list. + items: + type: string + failover_network_enabled: + type: boolean + description: Indicates whether the failover network resource is + enabled. required: - name - network_settings_ids @@ -22136,6 +24706,19 @@ paths: must be specified in the list. items: type: string + failover_network_settings_ids: + type: array + minItems: 0 + maxItems: 1 + description: A list of identifiers of the failover network settings + resources to use for the network configuration. Exactly one resource + identifier must be specified in the list. + items: + type: string + failover_network_enabled: + type: boolean + description: Indicates whether the failover network resource is + enabled. examples: default: value: @@ -78137,6 +80720,7 @@ components: - unknown - direct - transitive + - inconclusive - security_advisory: "$ref": "#/components/schemas/dependabot-alert-security-advisory" @@ -89055,6 +91639,12 @@ components: commit_url: type: string description: The API URL to get the associated commit resource + html_url: + type: string + format: uri + description: The GitHub URL to get the associated commit resource. + examples: + - https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1 required: - path - start_line @@ -89131,6 +91721,12 @@ components: description: The API URL to get the issue where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/1347 + html_url: + type: string + format: uri + description: The GitHub URL for the issue where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url secret-scanning-location-issue-body: @@ -89144,6 +91740,12 @@ components: description: The API URL to get the issue where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/1347 + html_url: + type: string + format: uri + description: The GitHub URL for the issue where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url secret-scanning-location-issue-comment: @@ -89157,6 +91759,12 @@ components: description: The API URL to get the issue comment where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + html_url: + type: string + format: uri + description: The GitHub URL for the issue comment where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url secret-scanning-location-discussion-title: @@ -89211,6 +91819,12 @@ components: description: The API URL to get the pull request where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url secret-scanning-location-pull-request-body: @@ -89225,6 +91839,12 @@ components: description: The API URL to get the pull request where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url secret-scanning-location-pull-request-comment: @@ -89240,6 +91860,13 @@ components: was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request comment where the secret + was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url secret-scanning-location-pull-request-review: @@ -89255,6 +91882,13 @@ components: was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request review where the secret + was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url secret-scanning-location-pull-request-review-comment: @@ -89270,6 +91904,13 @@ components: secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request review comment where the + secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846#discussion_r12 required: - pull_request_review_comment_url secret-scanning-first-detected-location: @@ -95959,6 +98600,7 @@ components: - unknown - direct - transitive + - inconclusive - security_advisory: "$ref": "#/components/schemas/dependabot-alert-security-advisory" @@ -214595,7 +217237,7 @@ components: - cwe_id: CWE-400 name: Uncontrolled Resource Consumption epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 credits: - user: @@ -217625,7 +220267,7 @@ components: vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N score: 8.7 epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 cwes: - cwe_id: CWE-200 @@ -231900,7 +234542,7 @@ components: vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N score: 8.7 epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 cwes: - cwe_id: CWE-200 @@ -232109,7 +234751,7 @@ components: vector_string: CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N score: 8.5 epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 cwes: - cwe_id: CWE-532 diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 163d1d8180..d874db04c2 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -195,6 +195,10 @@ { "name": "projects", "description": "Endpoints to manage Projects using the REST API." + }, + { + "name": "agent-tasks", + "description": "Endpoints to manage and interact with agent tasks." } ], "servers": [ @@ -325,196 +329,3491 @@ "type": "string" } } - ] - } - }, - { - "name": "is_withdrawn", - "in": "query", - "description": "Whether to only return advisories that have been withdrawn.", - "schema": { - "type": "boolean" + ] + } + }, + { + "name": "is_withdrawn", + "in": "query", + "description": "Whether to only return advisories that have been withdrawn.", + "schema": { + "type": "boolean" + } + }, + { + "name": "affects", + "in": "query", + "description": "If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified.\nIf the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.\n\nExample: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 1000, + "items": { + "type": "string" + } + } + ] + } + }, + { + "name": "published", + "in": "query", + "description": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "schema": { + "type": "string" + } + }, + { + "name": "updated", + "in": "query", + "description": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "schema": { + "type": "string" + } + }, + { + "name": "modified", + "description": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentage", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being exploited.", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentile", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "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", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "updated", + "published", + "epss_percentage", + "epss_percentile" + ], + "default": "published" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/global-advisory" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/global-advisory-items" + } + } + } + } + }, + "429": { + "description": "Too many requests", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "global-advisories" + } + } + }, + "/advisories/{ghsa_id}": { + "get": { + "summary": "Get a global security advisory", + "description": "Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.", + "tags": [ + "security-advisories" + ], + "operationId": "security-advisories/get-global-advisory", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory" + }, + "parameters": [ + { + "$ref": "#/components/parameters/ghsa_id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/global-advisory" + }, + "examples": { + "default": { + "$ref": "#/components/examples/global-advisory" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "global-advisories" + } + } + }, + "/agents/repos/{owner}/{repo}/tasks": { + "get": { + "summary": "List tasks for repository", + "description": "Returns a list of tasks for a specific repository", + "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" + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false`, returns only non-archived tasks." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID" + } + ], + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "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": "Create a task", + "description": "Creates a new task for a repository", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/create-task", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#create-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, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "event_content" + ], + "properties": { + "agent_id": { + "type": "integer", + "format": "int64", + "description": "Agent ID (optional, defaults to coding agent)" + }, + "problem_statement": { + "type": "string", + "description": "Additional prompting for the agent" + }, + "event_content": { + "type": "string", + "description": "User's written prompt" + }, + "model": { + "type": "string", + "description": "Model identifier" + }, + "custom_agent": { + "type": "string", + "description": "Custom agent identifier" + }, + "create_pull_request": { + "type": "boolean", + "description": "Whether to create a PR" + }, + "base_ref": { + "type": "string", + "description": "Base ref for new branch/PR" + }, + "event_type": { + "type": "string", + "description": "Type of event" + }, + "event_url": { + "type": "string", + "description": "URL of the triggering event" + }, + "event_identifiers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Identifiers for tracking" + } + } + }, + "examples": { + "default": { + "value": { + "event_content": "Fix the login button on the homepage", + "create_pull_request": true, + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + "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": "Returns a task by ID scoped to an owner/repo path", + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "agent_id": { + "type": "integer", + "format": "int64", + "description": "Agent ID" + }, + "agent_task_id": { + "type": "string", + "description": "Agent internal task ID" + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "event_type": { + "type": "string", + "description": "Type of event that triggered this session" + }, + "event_url": { + "type": "string", + "description": "URL of the triggering event" + }, + "event_content": { + "type": "string", + "description": "Content of the triggering event" + }, + "event_identifiers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Identifiers for tracking" + }, + "resource_type": { + "type": "string", + "description": "Type of resource associated with this session" + }, + "resource_id": { + "type": "integer", + "format": "int64", + "description": "Resource ID" + }, + "resource_number": { + "type": "integer", + "format": "int32", + "description": "Resource number (e.g., PR number)" + }, + "resource_global_id": { + "type": "string", + "description": "GraphQL global ID of the resource" + }, + "resource_state": { + "type": "string", + "description": "State of the associated resource" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "workflow_run_id": { + "type": "integer", + "format": "int64", + "description": "GitHub Actions workflow run ID" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "premium_requests": { + "type": "number", + "format": "double", + "description": "Premium request count" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether this session supports remote steering via Mission Control" + }, + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "event_content": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main" + } + ] + } + } + } + } + } + }, + "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" + } + } + } + } } }, - { - "name": "affects", - "in": "query", - "description": "If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified.\nIf the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.\n\nExample: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "maxItems": 1000, - "items": { - "type": "string" + "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": "Returns a list of tasks for the authenticated user", + "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": "published", + "name": "per_page", "in": "query", - "description": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "schema": { - "type": "string" - } + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." }, { - "name": "updated", + "name": "page", "in": "query", - "description": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "schema": { - "type": "string" - } + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." }, { - "name": "modified", - "description": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "name": "sort", "in": "query", "schema": { - "type": "string" - } + "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": "epss_percentage", + "name": "direction", "in": "query", - "description": "If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being exploited.", "schema": { - "type": "string" - } + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." }, { - "name": "epss_percentile", + "name": "state", "in": "query", - "description": "If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.", "schema": { "type": "string" - } - }, - { - "$ref": "#/components/parameters/pagination-before" - }, - { - "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/direction" + }, + "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": "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).\"", + "name": "is_archived", "in": "query", "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } + "type": "boolean" + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false`, returns only non-archived tasks." }, { - "name": "sort", - "description": "The property to sort the results by.", + "name": "since", "in": "query", - "required": false, "schema": { "type": "string", - "enum": [ - "updated", - "published", - "epss_percentage", - "epss_percentile" - ], - "default": "published" - } + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" } ], "responses": { "200": { - "description": "Response", + "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": "array", - "items": { - "$ref": "#/components/schemas/global-advisory" + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + "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": { - "$ref": "#/components/examples/global-advisory-items" + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } } } } } }, - "429": { - "description": "Too many requests", + "400": { + "description": "Bad request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/basic-error" + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated 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": { - "$ref": "#/components/responses/validation_failed_simple" + "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" + } + } + } + } + } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "security-advisories", - "subcategory": "global-advisories" } } }, - "/advisories/{ghsa_id}": { + "/agents/tasks/{task_id}": { "get": { - "summary": "Get a global security advisory", - "description": "Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.", + "summary": "Get a task by ID", + "description": "Returns a task by ID with its associated sessions", "tags": [ - "security-advisories" + "agent-tasks" ], - "operationId": "security-advisories/get-global-advisory", + "operationId": "agent-tasks/get-task-by-id", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory" + "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": [ { - "$ref": "#/components/parameters/ghsa_id" + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." } ], "responses": { "200": { - "description": "Response", + "description": "Task retrieved successfully", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/global-advisory" + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "agent_id": { + "type": "integer", + "format": "int64", + "description": "Agent ID" + }, + "agent_task_id": { + "type": "string", + "description": "Agent internal task ID" + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "event_type": { + "type": "string", + "description": "Type of event that triggered this session" + }, + "event_url": { + "type": "string", + "description": "URL of the triggering event" + }, + "event_content": { + "type": "string", + "description": "Content of the triggering event" + }, + "event_identifiers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Identifiers for tracking" + }, + "resource_type": { + "type": "string", + "description": "Type of resource associated with this session" + }, + "resource_id": { + "type": "integer", + "format": "int64", + "description": "Resource ID" + }, + "resource_number": { + "type": "integer", + "format": "int32", + "description": "Resource number (e.g., PR number)" + }, + "resource_global_id": { + "type": "string", + "description": "GraphQL global ID of the resource" + }, + "resource_state": { + "type": "string", + "description": "State of the associated resource" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "workflow_run_id": { + "type": "integer", + "format": "int64", + "description": "GitHub Actions workflow run ID" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "premium_requests": { + "type": "number", + "format": "double", + "description": "Premium request count" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether this session supports remote steering via Mission Control" + }, + "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": { - "$ref": "#/components/examples/global-advisory" + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "event_content": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main" + } + ] + } + } + } + } + } + }, + "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": { - "$ref": "#/components/responses/not_found" + "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" + } + } + } + } + } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "security-advisories", - "subcategory": "global-advisories" } } }, @@ -10609,7 +13908,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/oidc-custom-sub" + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", + "type": "object", + "properties": { + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } + } + } }, "examples": { "default": { @@ -14448,210 +17758,230 @@ } }, "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "artifact-metadata" - } - } - }, - "/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.", - "tags": [ - "orgs" - ], - "operationId": "orgs/set-cluster-deployment-records", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "name": "cluster", - "in": "path", - "description": "The cluster name.", - "required": true, - "schema": { - "type": "string", - "minLength": 1, - "maxLength": 128, - "pattern": "^[a-zA-Z0-9._-]+$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "logical_environment": { - "type": "string", - "description": "The stage of the deployment.", - "minLength": 1, - "maxLength": 128 - }, - "physical_environment": { - "type": "string", - "description": "The physical region of the deployment.", - "maxLength": 128 - }, - "deployments": { - "type": "array", - "description": "The list of deployments to record.", - "maxItems": 1000, - "items": { - "type": "object", - "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", - "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", - "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", - "maxLength": 100, - "x-multi-segment": true, - "examples": [ - "1.2.3" - ] - }, - "status": { - "type": "string", - "description": "The deployment status of the artifact.", - "default": "deployed", - "enum": [ - "deployed", - "decommissioned" - ] - }, - "deployment_name": { - "type": "string", - "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", - "minLength": 1, - "maxLength": 256 - }, - "github_repository": { - "type": "string", - "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", - "maxLength": 100, - "pattern": "^[A-Za-z0-9.\\-_]+$", - "examples": [ - "my-github-repo" - ] - }, - "tags": { - "type": "object", - "description": "Key-value pairs to tag the deployment record.", - "additionalProperties": { - "type": "string" - } - }, - "runtime_risks": { - "type": "array", - "description": "A list of runtime risks associated with the deployment.", - "maxItems": 4, - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "critical-resource", - "internet-exposed", - "lateral-movement", - "sensitive-data" - ] - } - } - }, - "required": [ - "name", - "deployment_name", - "digest" - ] - } - } - }, - "required": [ - "logical_environment", - "deployments" - ] - }, - "examples": { - "default": { - "value": { - "logical_environment": "prod", - "physical_environment": "pacific-east", - "deployments": [ - { - "name": "awesome-image", - "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", - "version": "2.1.0", - "status": "deployed", - "deployment_name": "deployment-pod", - "tags": { - "runtime-risk": "sensitive-data" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Deployment records created or updated successfully.\n", + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "artifact-metadata" + } + } + }, + "/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.", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-cluster-deployment-records", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "cluster", + "in": "path", + "description": "The cluster name.", + "required": true, + "schema": { + "type": "string", + "minLength": 1, + "maxLength": 128, + "pattern": "^[a-zA-Z0-9._-]+$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "logical_environment": { + "type": "string", + "description": "The stage of the deployment.", + "minLength": 1, + "maxLength": 128 + }, + "physical_environment": { + "type": "string", + "description": "The physical region of the deployment.", + "maxLength": 128 + }, + "deployments": { + "type": "array", + "description": "The list of deployments to record.", + "maxItems": 1000, + "items": { + "type": "object", + "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", + "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", + "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", + "maxLength": 100, + "x-multi-segment": true, + "examples": [ + "1.2.3" + ] + }, + "status": { + "type": "string", + "description": "The deployment status of the artifact.", + "default": "deployed", + "enum": [ + "deployed", + "decommissioned" + ] + }, + "deployment_name": { + "type": "string", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", + "minLength": 1, + "maxLength": 256 + }, + "github_repository": { + "type": "string", + "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", + "maxLength": 100, + "pattern": "^[A-Za-z0-9.\\-_]+$", + "examples": [ + "my-github-repo" + ] + }, + "tags": { + "type": "object", + "description": "Key-value pairs to tag the deployment record.", + "additionalProperties": { + "type": "string" + } + }, + "runtime_risks": { + "type": "array", + "description": "A list of runtime risks associated with the deployment.", + "maxItems": 4, + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "critical-resource", + "internet-exposed", + "lateral-movement", + "sensitive-data" + ] + } + } + }, + "required": [ + "name", + "deployment_name", + "digest" + ] + } + } + }, + "required": [ + "logical_environment", + "deployments" + ] + }, + "examples": { + "default": { + "value": { + "logical_environment": "prod", + "physical_environment": "pacific-east", + "deployments": [ + { + "name": "awesome-image", + "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", + "version": "2.1.0", + "status": "deployed", + "deployment_name": "deployment-pod", + "tags": { + "runtime-risk": "sensitive-data" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Deployment records created or updated successfully.\n", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of deployment records created", + "type": "integer" + }, + "deployment_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/artifact-deployment-record" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/artifact-deployment-record-list" + } + } + } + } + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "total_count": { - "description": "The number of deployment records created", - "type": "integer" - }, - "deployment_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/artifact-deployment-record" - } - } - } + "$ref": "#/components/schemas/basic-error" }, "examples": { - "default": { - "$ref": "#/components/examples/artifact-deployment-record-list" + "insufficient_repo_permissions": { + "value": { + "message": { + "cause": "artifact metadata write permission required on one or more repositories", + "repositories": [ + 123, + 345 + ] + } + } } } } } }, - "403": { - "$ref": "#/components/responses/forbidden" - }, "404": { "$ref": "#/components/responses/not_found" } @@ -24234,7 +27564,7 @@ "/orgs/{org}/organization-roles": { "get": { "summary": "Get all organization roles for an organization", - "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -24513,7 +27843,7 @@ "/orgs/{org}/organization-roles/{role_id}": { "get": { "summary": "Get an organization role", - "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -30654,6 +33984,19 @@ "items": { "type": "string" } + }, + "failover_network_settings_ids": { + "type": "array", + "minItems": 0, + "maxItems": 1, + "description": "A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", + "items": { + "type": "string" + } + }, + "failover_network_enabled": { + "type": "boolean", + "description": "Indicates whether the failover network resource is enabled." } }, "required": [ @@ -30795,6 +34138,19 @@ "items": { "type": "string" } + }, + "failover_network_settings_ids": { + "type": "array", + "minItems": 0, + "maxItems": 1, + "description": "A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", + "items": { + "type": "string" + } + }, + "failover_network_enabled": { + "type": "boolean", + "description": "Indicates whether the failover network resource is enabled." } } }, @@ -108819,6 +112175,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -124174,6 +127531,14 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] } }, "required": [ @@ -124267,6 +127632,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -124284,6 +127657,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -124301,6 +127682,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] } }, "required": [ @@ -124369,6 +127758,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -124386,6 +127783,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -124403,6 +127808,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] } }, "required": [ @@ -124420,6 +127833,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] } }, "required": [ @@ -124437,6 +127858,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] } }, "required": [ @@ -133903,6 +137332,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -295301,12 +298731,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { @@ -298456,12 +301884,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -315191,12 +318617,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -315484,12 +318908,10 @@ "score": 8.5 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-532", diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 911f57a147..d9e46c082c 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -103,6 +103,8 @@ tags: description: Endpoints to manage campaigns via the REST API. - name: projects description: Endpoints to manage Projects using the REST API. +- name: agent-tasks + description: Endpoints to manage and interact with agent tasks. servers: - url: https://api.github.com externalDocs: @@ -336,6 +338,2539 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories + "/agents/repos/{owner}/{repo}/tasks": + get: + summary: List tasks for repository + description: Returns a list of tasks for a specific repository + 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 + description: Filter by archived status. When `true`, returns only archived + tasks. When `false`, returns only non-archived tasks. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + - name: creator_id + in: query + schema: + type: integer + description: Filter tasks by creator user ID + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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: Create a task + description: Creates a new task for a repository + tags: + - agent-tasks + operationId: agent-tasks/create-task + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#create-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 + content: + application/json: + schema: + type: object + required: + - event_content + properties: + agent_id: + type: integer + format: int64 + description: Agent ID (optional, defaults to coding agent) + problem_statement: + type: string + description: Additional prompting for the agent + event_content: + type: string + description: User's written prompt + model: + type: string + description: Model identifier + custom_agent: + type: string + description: Custom agent identifier + create_pull_request: + type: boolean + description: Whether to create a PR + base_ref: + type: string + description: Base ref for new branch/PR + event_type: + type: string + description: Type of event + event_url: + type: string + description: URL of the triggering event + event_identifiers: + type: array + items: + type: string + description: Identifiers for tracking + examples: + default: + value: + event_content: Fix the login button on the homepage + create_pull_request: true + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + 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: Returns a task by ID scoped to an owner/repo path + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + agent_id: + type: integer + format: int64 + description: Agent ID + agent_task_id: + type: string + description: Agent internal task ID + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + event_type: + type: string + description: Type of event that triggered this session + event_url: + type: string + description: URL of the triggering event + event_content: + type: string + description: Content of the triggering event + event_identifiers: + type: array + items: + type: string + description: Identifiers for tracking + resource_type: + type: string + description: Type of resource associated with this session + resource_id: + type: integer + format: int64 + description: Resource ID + resource_number: + type: integer + format: int32 + description: Resource number (e.g., PR number) + resource_global_id: + type: string + description: GraphQL global ID of the resource + resource_state: + type: string + description: State of the associated resource + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + workflow_run_id: + type: integer + format: int64 + description: GitHub Actions workflow run ID + model: + type: string + description: Model used for this session + premium_requests: + type: number + format: double + description: Premium request count + remote_steerable: + type: boolean + description: Whether this session supports remote steering + via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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' + event_content: Fix the login button on the homepage + head_ref: copilot/fix-1 + base_ref: main + '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: Returns a list of tasks for the authenticated user + 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 + description: Filter by archived status. When `true`, returns only archived + tasks. When `false`, returns only non-archived tasks. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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: Returns a task by ID with its associated sessions + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + agent_id: + type: integer + format: int64 + description: Agent ID + agent_task_id: + type: string + description: Agent internal task ID + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + event_type: + type: string + description: Type of event that triggered this session + event_url: + type: string + description: URL of the triggering event + event_content: + type: string + description: Content of the triggering event + event_identifiers: + type: array + items: + type: string + description: Identifiers for tracking + resource_type: + type: string + description: Type of resource associated with this session + resource_id: + type: integer + format: int64 + description: Resource ID + resource_number: + type: integer + format: int32 + description: Resource number (e.g., PR number) + resource_global_id: + type: string + description: GraphQL global ID of the resource + resource_state: + type: string + description: State of the associated resource + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + workflow_run_id: + type: integer + format: int64 + description: GitHub Actions workflow run ID + model: + type: string + description: Model used for this session + premium_requests: + type: number + format: double + description: Premium request count + remote_steerable: + type: boolean + description: Whether this session supports remote steering + via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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' + event_content: Fix the login button on the homepage + head_ref: copilot/fix-1 + base_ref: main + '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 @@ -7576,7 +10111,16 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/oidc-custom-sub" + title: Actions OIDC Subject customization + description: Actions OIDC Subject customization + type: object + properties: + include_claim_keys: + description: Array of unique strings. Each claim key can only contain + alphanumeric characters and underscores. + type: array + items: + type: string examples: default: "$ref": "#/components/examples/oidc-custom-sub" @@ -10584,7 +13128,20 @@ paths: default: "$ref": "#/components/examples/artifact-deployment-record-list" '403': - "$ref": "#/components/responses/forbidden" + description: Forbidden + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + insufficient_repo_permissions: + value: + message: + cause: artifact metadata write permission required on one or + more repositories + repositories: + - 123 + - 345 '404': "$ref": "#/components/responses/not_found" x-github: @@ -17577,7 +20134,7 @@ paths: To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -17795,7 +20352,7 @@ paths: To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -22170,6 +24727,19 @@ paths: must be specified in the list. items: type: string + failover_network_settings_ids: + type: array + minItems: 0 + maxItems: 1 + description: A list of identifiers of the failover network settings + resources to use for the network configuration. Exactly one resource + identifier must be specified in the list. + items: + type: string + failover_network_enabled: + type: boolean + description: Indicates whether the failover network resource is + enabled. required: - name - network_settings_ids @@ -22271,6 +24841,19 @@ paths: must be specified in the list. items: type: string + failover_network_settings_ids: + type: array + minItems: 0 + maxItems: 1 + description: A list of identifiers of the failover network settings + resources to use for the network configuration. Exactly one resource + identifier must be specified in the list. + items: + type: string + failover_network_enabled: + type: boolean + description: Indicates whether the failover network resource is + enabled. examples: default: value: @@ -78708,6 +81291,7 @@ components: - unknown - direct - transitive + - inconclusive - security_advisory: "$ref": "#/components/schemas/dependabot-alert-security-advisory" @@ -90081,6 +92665,12 @@ components: commit_url: type: string description: The API URL to get the associated commit resource + html_url: + type: string + format: uri + description: The GitHub URL to get the associated commit resource. + examples: + - https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1 required: - path - start_line @@ -90157,6 +92747,12 @@ components: description: The API URL to get the issue where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/1347 + html_url: + type: string + format: uri + description: The GitHub URL for the issue where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url secret-scanning-location-issue-body: @@ -90170,6 +92766,12 @@ components: description: The API URL to get the issue where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/1347 + html_url: + type: string + format: uri + description: The GitHub URL for the issue where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url secret-scanning-location-issue-comment: @@ -90183,6 +92785,12 @@ components: description: The API URL to get the issue comment where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + html_url: + type: string + format: uri + description: The GitHub URL for the issue comment where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url secret-scanning-location-discussion-title: @@ -90237,6 +92845,12 @@ components: description: The API URL to get the pull request where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url secret-scanning-location-pull-request-body: @@ -90251,6 +92865,12 @@ components: description: The API URL to get the pull request where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url secret-scanning-location-pull-request-comment: @@ -90266,6 +92886,13 @@ components: was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request comment where the secret + was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url secret-scanning-location-pull-request-review: @@ -90281,6 +92908,13 @@ components: was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request review where the secret + was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url secret-scanning-location-pull-request-review-comment: @@ -90296,6 +92930,13 @@ components: secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request review comment where the + secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846#discussion_r12 required: - pull_request_review_comment_url secret-scanning-first-detected-location: @@ -97155,6 +99796,7 @@ components: - unknown - direct - transitive + - inconclusive - security_advisory: "$ref": "#/components/schemas/dependabot-alert-security-advisory" @@ -216519,7 +219161,7 @@ components: - cwe_id: CWE-400 name: Uncontrolled Resource Consumption epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 credits: - user: @@ -219549,7 +222191,7 @@ components: vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N score: 8.7 epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 cwes: - cwe_id: CWE-200 @@ -233831,7 +236473,7 @@ components: vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N score: 8.7 epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 cwes: - cwe_id: CWE-200 @@ -234040,7 +236682,7 @@ components: vector_string: CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N score: 8.5 epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 cwes: - cwe_id: CWE-532 diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 511d3240c8..e5e960482e 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -195,6 +195,10 @@ { "name": "projects", "description": "Endpoints to manage Projects using the REST API." + }, + { + "name": "agent-tasks", + "description": "Endpoints to manage and interact with agent tasks." } ], "servers": [ @@ -1352,12 +1356,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { @@ -2218,6 +2220,3301 @@ } } }, + "/agents/repos/{owner}/{repo}/tasks": { + "get": { + "summary": "List tasks for repository", + "description": "Returns a list of tasks for a specific repository", + "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" + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false`, returns only non-archived tasks." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID" + } + ], + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "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": "Create a task", + "description": "Creates a new task for a repository", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/create-task", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#create-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, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "event_content" + ], + "properties": { + "agent_id": { + "type": "integer", + "format": "int64", + "description": "Agent ID (optional, defaults to coding agent)" + }, + "problem_statement": { + "type": "string", + "description": "Additional prompting for the agent" + }, + "event_content": { + "type": "string", + "description": "User's written prompt" + }, + "model": { + "type": "string", + "description": "Model identifier" + }, + "custom_agent": { + "type": "string", + "description": "Custom agent identifier" + }, + "create_pull_request": { + "type": "boolean", + "description": "Whether to create a PR" + }, + "base_ref": { + "type": "string", + "description": "Base ref for new branch/PR" + }, + "event_type": { + "type": "string", + "description": "Type of event" + }, + "event_url": { + "type": "string", + "description": "URL of the triggering event" + }, + "event_identifiers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Identifiers for tracking" + } + } + }, + "examples": { + "default": { + "value": { + "event_content": "Fix the login button on the homepage", + "create_pull_request": true, + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + "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": "Returns a task by ID scoped to an owner/repo path", + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "agent_id": { + "type": "integer", + "format": "int64", + "description": "Agent ID" + }, + "agent_task_id": { + "type": "string", + "description": "Agent internal task ID" + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "event_type": { + "type": "string", + "description": "Type of event that triggered this session" + }, + "event_url": { + "type": "string", + "description": "URL of the triggering event" + }, + "event_content": { + "type": "string", + "description": "Content of the triggering event" + }, + "event_identifiers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Identifiers for tracking" + }, + "resource_type": { + "type": "string", + "description": "Type of resource associated with this session" + }, + "resource_id": { + "type": "integer", + "format": "int64", + "description": "Resource ID" + }, + "resource_number": { + "type": "integer", + "format": "int32", + "description": "Resource number (e.g., PR number)" + }, + "resource_global_id": { + "type": "string", + "description": "GraphQL global ID of the resource" + }, + "resource_state": { + "type": "string", + "description": "State of the associated resource" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "workflow_run_id": { + "type": "integer", + "format": "int64", + "description": "GitHub Actions workflow run ID" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "premium_requests": { + "type": "number", + "format": "double", + "description": "Premium request count" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether this session supports remote steering via Mission Control" + }, + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "event_content": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main" + } + ] + } + } + } + } + } + }, + "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": "Returns a list of tasks for the authenticated user", + "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" + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false`, returns only non-archived tasks." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + } + ], + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "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": "Returns a task by ID with its associated sessions", + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "agent_id": { + "type": "integer", + "format": "int64", + "description": "Agent ID" + }, + "agent_task_id": { + "type": "string", + "description": "Agent internal task ID" + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "event_type": { + "type": "string", + "description": "Type of event that triggered this session" + }, + "event_url": { + "type": "string", + "description": "URL of the triggering event" + }, + "event_content": { + "type": "string", + "description": "Content of the triggering event" + }, + "event_identifiers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Identifiers for tracking" + }, + "resource_type": { + "type": "string", + "description": "Type of resource associated with this session" + }, + "resource_id": { + "type": "integer", + "format": "int64", + "description": "Resource ID" + }, + "resource_number": { + "type": "integer", + "format": "int32", + "description": "Resource number (e.g., PR number)" + }, + "resource_global_id": { + "type": "string", + "description": "GraphQL global ID of the resource" + }, + "resource_state": { + "type": "string", + "description": "State of the associated resource" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "workflow_run_id": { + "type": "integer", + "format": "int64", + "description": "GitHub Actions workflow run ID" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "premium_requests": { + "type": "number", + "format": "double", + "description": "Premium request count" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether this session supports remote steering via Mission Control" + }, + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "event_content": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main" + } + ] + } + } + } + } + } + }, + "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", @@ -24921,6 +28218,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -26445,12 +29743,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -91009,10 +94305,7 @@ "type": "string" } } - }, - "required": [ - "include_claim_keys" - ] + } }, "examples": { "default": { @@ -106745,332 +110038,345 @@ "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": "orgs", - "subcategory": "artifact-metadata" - } - } - }, - "/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.", - "tags": [ - "orgs" - ], - "operationId": "orgs/set-cluster-deployment-records", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cluster", - "in": "path", - "description": "The cluster name.", - "required": true, - "schema": { - "type": "string", - "minLength": 1, - "maxLength": 128, - "pattern": "^[a-zA-Z0-9._-]+$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "logical_environment": { - "type": "string", - "description": "The stage of the deployment.", - "minLength": 1, - "maxLength": 128 - }, - "physical_environment": { - "type": "string", - "description": "The physical region of the deployment.", - "maxLength": 128 - }, - "deployments": { - "type": "array", - "description": "The list of deployments to record.", - "maxItems": 1000, - "items": { - "type": "object", - "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", - "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", - "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", - "maxLength": 100, - "x-multi-segment": true, - "examples": [ - "1.2.3" - ] - }, - "status": { - "type": "string", - "description": "The deployment status of the artifact.", - "default": "deployed", - "enum": [ - "deployed", - "decommissioned" - ] - }, - "deployment_name": { - "type": "string", - "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", - "minLength": 1, - "maxLength": 256 - }, - "github_repository": { - "type": "string", - "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", - "maxLength": 100, - "pattern": "^[A-Za-z0-9.\\-_]+$", - "examples": [ - "my-github-repo" - ] - }, - "tags": { - "type": "object", - "description": "Key-value pairs to tag the deployment record.", - "additionalProperties": { - "type": "string" - } - }, - "runtime_risks": { - "type": "array", - "description": "A list of runtime risks associated with the deployment.", - "maxItems": 4, - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "critical-resource", - "internet-exposed", - "lateral-movement", - "sensitive-data" - ] - } - } - }, - "required": [ - "name", - "deployment_name", - "digest" - ] - } - } - }, - "required": [ - "logical_environment", - "deployments" - ] - }, - "examples": { - "default": { - "value": { - "logical_environment": "prod", - "physical_environment": "pacific-east", - "deployments": [ - { - "name": "awesome-image", - "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", - "version": "2.1.0", - "status": "deployed", - "deployment_name": "deployment-pod", - "tags": { - "runtime-risk": "sensitive-data" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Deployment records created or updated successfully.\n", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "total_count": { - "description": "The number of deployment records created", - "type": "integer" - }, - "deployment_records": { - "type": "array", - "items": { - "title": "Artifact Deployment Record", - "description": "Artifact Metadata Deployment Record", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "digest": { - "type": "string" - }, - "logical_environment": { - "type": "string" - }, - "physical_environment": { - "type": "string" - }, - "cluster": { - "type": "string" - }, - "deployment_name": { - "type": "string" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "runtime_risks": { - "type": "array", - "description": "A list of runtime risks associated with the deployment.", - "maxItems": 4, - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "critical-resource", - "internet-exposed", - "lateral-movement", - "sensitive-data" - ] - } - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "attestation_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the provenance attestation associated with the deployment record." - } - } - } - } - } + } + } + } + }, + "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": "orgs", + "subcategory": "artifact-metadata" + } + } + }, + "/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.", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-cluster-deployment-records", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "path", + "description": "The cluster name.", + "required": true, + "schema": { + "type": "string", + "minLength": 1, + "maxLength": 128, + "pattern": "^[a-zA-Z0-9._-]+$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "logical_environment": { + "type": "string", + "description": "The stage of the deployment.", + "minLength": 1, + "maxLength": 128 + }, + "physical_environment": { + "type": "string", + "description": "The physical region of the deployment.", + "maxLength": 128 + }, + "deployments": { + "type": "array", + "description": "The list of deployments to record.", + "maxItems": 1000, + "items": { + "type": "object", + "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", + "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", + "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", + "maxLength": 100, + "x-multi-segment": true, + "examples": [ + "1.2.3" + ] + }, + "status": { + "type": "string", + "description": "The deployment status of the artifact.", + "default": "deployed", + "enum": [ + "deployed", + "decommissioned" + ] + }, + "deployment_name": { + "type": "string", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", + "minLength": 1, + "maxLength": 256 + }, + "github_repository": { + "type": "string", + "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", + "maxLength": 100, + "pattern": "^[A-Za-z0-9.\\-_]+$", + "examples": [ + "my-github-repo" + ] + }, + "tags": { + "type": "object", + "description": "Key-value pairs to tag the deployment record.", + "additionalProperties": { + "type": "string" + } + }, + "runtime_risks": { + "type": "array", + "description": "A list of runtime risks associated with the deployment.", + "maxItems": 4, + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "critical-resource", + "internet-exposed", + "lateral-movement", + "sensitive-data" + ] + } + } + }, + "required": [ + "name", + "deployment_name", + "digest" + ] + } + } + }, + "required": [ + "logical_environment", + "deployments" + ] + }, + "examples": { + "default": { + "value": { + "logical_environment": "prod", + "physical_environment": "pacific-east", + "deployments": [ + { + "name": "awesome-image", + "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", + "version": "2.1.0", + "status": "deployed", + "deployment_name": "deployment-pod", + "tags": { + "runtime-risk": "sensitive-data" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Deployment records created or updated successfully.\n", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of deployment records created", + "type": "integer" + }, + "deployment_records": { + "type": "array", + "items": { + "title": "Artifact Deployment Record", + "description": "Artifact Metadata Deployment Record", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "digest": { + "type": "string" + }, + "logical_environment": { + "type": "string" + }, + "physical_environment": { + "type": "string" + }, + "cluster": { + "type": "string" + }, + "deployment_name": { + "type": "string" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "runtime_risks": { + "type": "array", + "description": "A list of runtime risks associated with the deployment.", + "maxItems": 4, + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "critical-resource", + "internet-exposed", + "lateral-movement", + "sensitive-data" + ] + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "attestation_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the provenance attestation associated with the deployment record." + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "deployment_records": [ + { + "id": 123, + "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", + "logical_environment": "prod", + "physical_environment": "pacific-east", + "cluster": "moda-1", + "deployment_name": "prod-deployment", + "tags": { + "data": "sensitive" + }, + "created": "2011-01-26T19:14:43Z", + "updated_at": "2011-01-26T19:14:43Z", + "attestation_id": 456 + } + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "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" + } + } }, "examples": { - "default": { + "insufficient_repo_permissions": { "value": { - "total_count": 1, - "deployment_records": [ - { - "id": 123, - "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", - "logical_environment": "prod", - "physical_environment": "pacific-east", - "cluster": "moda-1", - "deployment_name": "prod-deployment", - "tags": { - "data": "sensitive" - }, - "created": "2011-01-26T19:14:43Z", - "updated_at": "2011-01-26T19:14:43Z", - "attestation_id": 456 - } - ] - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "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" + "message": { + "cause": "artifact metadata write permission required on one or more repositories", + "repositories": [ + 123, + 345 + ] + } } } } @@ -130366,6 +133672,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -131890,12 +135197,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -175993,7 +179298,7 @@ "/orgs/{org}/organization-roles": { "get": { "summary": "Get all organization roles for an organization", - "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -176784,7 +180089,7 @@ "/orgs/{org}/organization-roles/{role_id}": { "get": { "summary": "Get an organization role", - "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -238146,6 +241451,14 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] } }, "required": [ @@ -238239,6 +241552,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -238256,6 +241577,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -238273,6 +241602,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] } }, "required": [ @@ -238341,6 +241678,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -238358,6 +241703,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -238375,6 +241728,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] } }, "required": [ @@ -238392,6 +241753,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] } }, "required": [ @@ -238409,6 +241778,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] } }, "required": [ @@ -244063,338 +247440,364 @@ }, "network_settings_ids": { "type": "array", - "minItems": 1, + "minItems": 1, + "maxItems": 1, + "description": "A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", + "items": { + "type": "string" + } + }, + "failover_network_settings_ids": { + "type": "array", + "minItems": 0, + "maxItems": 1, + "description": "A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", + "items": { + "type": "string" + } + }, + "failover_network_enabled": { + "type": "boolean", + "description": "Indicates whether the failover network resource is enabled." + } + }, + "required": [ + "name", + "network_settings_ids" + ] + }, + "examples": { + "default": { + "value": { + "name": "my-network-configuration", + "network_settings_ids": [ + "23456789ABDCEF1" + ], + "compute_service": "actions" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "failover_network_settings_ids": { + "description": "The unique identifier of each failover network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "failover_network_enabled": { + "description": "Indicates whether the failover network resource is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" + ] + } + }, + "required": [ + "id", + "name", + "created_on" + ] + }, + "examples": { + "default": { + "value": { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "network-configurations" + } + } + }, + "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { + "get": { + "summary": "Get a hosted compute network configuration for an organization", + "description": "Gets a hosted compute network configuration configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", + "tags": [ + "hosted-compute" + ], + "operationId": "hosted-compute/get-network-configuration-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "network_configuration_id", + "description": "Unique identifier of the hosted compute network configuration.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "failover_network_settings_ids": { + "description": "The unique identifier of each failover network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "failover_network_enabled": { + "description": "Indicates whether the failover network resource is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" + ] + } + }, + "required": [ + "id", + "name", + "created_on" + ] + }, + "examples": { + "default": { + "value": { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "network-configurations" + } + }, + "patch": { + "summary": "Update a hosted compute network configuration for an organization", + "description": "Updates a hosted compute network configuration for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", + "tags": [ + "hosted-compute" + ], + "operationId": "hosted-compute/update-network-configuration-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "network_configuration_id", + "description": "Unique identifier of the hosted compute network configuration.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", + "type": "string" + }, + "compute_service": { + "description": "The hosted compute service to use for the network configuration.", + "type": "string", + "enum": [ + "none", + "actions" + ] + }, + "network_settings_ids": { + "type": "array", + "minItems": 0, "maxItems": 1, "description": "A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", "items": { "type": "string" } - } - }, - "required": [ - "name", - "network_settings_ids" - ] - }, - "examples": { - "default": { - "value": { - "name": "my-network-configuration", - "network_settings_ids": [ - "23456789ABDCEF1" - ], - "compute_service": "actions" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Hosted compute network configuration", - "description": "A hosted compute network configuration.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the network configuration.", - "type": "string", - "examples": [ - "123ABC456DEF789" - ] - }, - "name": { - "description": "The name of the network configuration.", - "type": "string", - "examples": [ - "my-network-configuration" - ] - }, - "compute_service": { - "description": "The hosted compute service the network configuration supports.", - "type": "string", - "enum": [ - "none", - "actions", - "codespaces" - ] - }, - "network_settings_ids": { - "description": "The unique identifier of each network settings in the configuration.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "123ABC456DEF789" - ] - }, - "failover_network_settings_ids": { - "description": "The unique identifier of each failover network settings in the configuration.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "123ABC456DEF789" - ] - }, - "failover_network_enabled": { - "description": "Indicates whether the failover network resource is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "created_on": { - "description": "The time at which the network configuration was created, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2024-04-26T11:31:07Z" - ] - } }, - "required": [ - "id", - "name", - "created_on" - ] - }, - "examples": { - "default": { - "value": { - "id": "123456789ABCDEF", - "name": "My network configuration", - "compute_service": "actions", - "network_settings_ids": [ - "23456789ABDCEF1", - "3456789ABDCEF12" - ], - "created_on": "2022-10-09T23:39:01Z" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "network-configurations" - } - } - }, - "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { - "get": { - "summary": "Get a hosted compute network configuration for an organization", - "description": "Gets a hosted compute network configuration configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", - "tags": [ - "hosted-compute" - ], - "operationId": "hosted-compute/get-network-configuration-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "network_configuration_id", - "description": "Unique identifier of the hosted compute network configuration.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Hosted compute network configuration", - "description": "A hosted compute network configuration.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the network configuration.", - "type": "string", - "examples": [ - "123ABC456DEF789" - ] - }, - "name": { - "description": "The name of the network configuration.", - "type": "string", - "examples": [ - "my-network-configuration" - ] - }, - "compute_service": { - "description": "The hosted compute service the network configuration supports.", - "type": "string", - "enum": [ - "none", - "actions", - "codespaces" - ] - }, - "network_settings_ids": { - "description": "The unique identifier of each network settings in the configuration.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "123ABC456DEF789" - ] - }, - "failover_network_settings_ids": { - "description": "The unique identifier of each failover network settings in the configuration.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "123ABC456DEF789" - ] - }, - "failover_network_enabled": { - "description": "Indicates whether the failover network resource is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "created_on": { - "description": "The time at which the network configuration was created, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2024-04-26T11:31:07Z" - ] - } - }, - "required": [ - "id", - "name", - "created_on" - ] - }, - "examples": { - "default": { - "value": { - "id": "123456789ABCDEF", - "name": "My network configuration", - "compute_service": "actions", - "network_settings_ids": [ - "23456789ABDCEF1", - "3456789ABDCEF12" - ], - "created_on": "2022-10-09T23:39:01Z" - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "network-configurations" - } - }, - "patch": { - "summary": "Update a hosted compute network configuration for an organization", - "description": "Updates a hosted compute network configuration for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", - "tags": [ - "hosted-compute" - ], - "operationId": "hosted-compute/update-network-configuration-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "network_configuration_id", - "description": "Unique identifier of the hosted compute network configuration.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", - "type": "string" - }, - "compute_service": { - "description": "The hosted compute service to use for the network configuration.", - "type": "string", - "enum": [ - "none", - "actions" - ] - }, - "network_settings_ids": { + "failover_network_settings_ids": { "type": "array", "minItems": 0, "maxItems": 1, - "description": "A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", + "description": "A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", "items": { "type": "string" } + }, + "failover_network_enabled": { + "type": "boolean", + "description": "Indicates whether the failover network resource is enabled." } } }, @@ -378414,6 +381817,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -379386,12 +382790,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -379903,6 +383305,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -380884,12 +384287,10 @@ "score": 8.5 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-532", @@ -381221,6 +384622,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -621194,6 +624596,14 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] } }, "required": [ @@ -621287,6 +624697,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -621304,6 +624722,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -621321,6 +624747,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] } }, "required": [ @@ -621389,6 +624823,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -621406,6 +624848,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -621423,6 +624873,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] } }, "required": [ @@ -621440,6 +624898,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] } }, "required": [ @@ -621457,6 +624923,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] } }, "required": [ @@ -622605,6 +626079,14 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] } }, "required": [ @@ -622698,6 +626180,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -622715,6 +626205,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -622732,6 +626230,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] } }, "required": [ @@ -622800,6 +626306,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -622817,6 +626331,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -622834,6 +626356,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] } }, "required": [ @@ -622851,6 +626381,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] } }, "required": [ @@ -622868,6 +626406,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] } }, "required": [ @@ -623999,6 +627545,14 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] } }, "required": [ @@ -624092,6 +627646,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -624109,6 +627671,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -624126,6 +627696,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] } }, "required": [ @@ -624194,6 +627772,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -624211,6 +627797,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -624228,6 +627822,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] } }, "required": [ @@ -624245,6 +627847,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] } }, "required": [ @@ -624262,6 +627872,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] } }, "required": [ @@ -624707,6 +628325,14 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] } }, "required": [ @@ -624800,6 +628426,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -624817,6 +628451,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -624834,6 +628476,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] } }, "required": [ @@ -624902,6 +628552,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -624919,6 +628577,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -624936,6 +628602,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] } }, "required": [ @@ -624953,6 +628627,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] } }, "required": [ @@ -624970,6 +628652,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] } }, "required": [ @@ -917763,6 +921453,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -920747,6 +924438,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -923731,6 +927423,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -926715,6 +930408,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -929699,6 +933393,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -932683,6 +936378,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -935667,6 +939363,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -938651,6 +942348,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -1567377,6 +1571075,14 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] } }, "required": [ @@ -1567470,6 +1571176,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -1567487,6 +1571201,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -1567504,6 +1571226,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] } }, "required": [ @@ -1567572,6 +1571302,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -1567589,6 +1571327,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -1567606,6 +1571352,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] } }, "required": [ @@ -1567623,6 +1571377,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] } }, "required": [ @@ -1567640,6 +1571402,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] } }, "required": [ diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 99aa116b3a..43c639c7aa 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -103,6 +103,8 @@ tags: description: Endpoints to manage campaigns via the REST API. - name: projects description: Endpoints to manage Projects using the REST API. +- name: agent-tasks + description: Endpoints to manage and interact with agent tasks. servers: - url: https://api.github.com externalDocs: @@ -905,7 +907,7 @@ paths: - subscriptions_url - type - url - type: &314 + type: &313 type: string description: The type of credit the user is receiving. enum: @@ -994,7 +996,7 @@ paths: - cwe_id: CWE-400 name: Uncontrolled Resource Consumption epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 credits: - user: @@ -1071,7 +1073,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &631 + - &630 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1161,6 +1163,2539 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories + "/agents/repos/{owner}/{repo}/tasks": + get: + summary: List tasks for repository + description: Returns a list of tasks for a specific repository + 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 + description: Filter by archived status. When `true`, returns only archived + tasks. When `false`, returns only non-archived tasks. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + - name: creator_id + in: query + schema: + type: integer + description: Filter tasks by creator user ID + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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: Create a task + description: Creates a new task for a repository + tags: + - agent-tasks + operationId: agent-tasks/create-task + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#create-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 + content: + application/json: + schema: + type: object + required: + - event_content + properties: + agent_id: + type: integer + format: int64 + description: Agent ID (optional, defaults to coding agent) + problem_statement: + type: string + description: Additional prompting for the agent + event_content: + type: string + description: User's written prompt + model: + type: string + description: Model identifier + custom_agent: + type: string + description: Custom agent identifier + create_pull_request: + type: boolean + description: Whether to create a PR + base_ref: + type: string + description: Base ref for new branch/PR + event_type: + type: string + description: Type of event + event_url: + type: string + description: URL of the triggering event + event_identifiers: + type: array + items: + type: string + description: Identifiers for tracking + examples: + default: + value: + event_content: Fix the login button on the homepage + create_pull_request: true + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + 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: Returns a task by ID scoped to an owner/repo path + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + agent_id: + type: integer + format: int64 + description: Agent ID + agent_task_id: + type: string + description: Agent internal task ID + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + event_type: + type: string + description: Type of event that triggered this session + event_url: + type: string + description: URL of the triggering event + event_content: + type: string + description: Content of the triggering event + event_identifiers: + type: array + items: + type: string + description: Identifiers for tracking + resource_type: + type: string + description: Type of resource associated with this session + resource_id: + type: integer + format: int64 + description: Resource ID + resource_number: + type: integer + format: int32 + description: Resource number (e.g., PR number) + resource_global_id: + type: string + description: GraphQL global ID of the resource + resource_state: + type: string + description: State of the associated resource + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + workflow_run_id: + type: integer + format: int64 + description: GitHub Actions workflow run ID + model: + type: string + description: Model used for this session + premium_requests: + type: number + format: double + description: Premium request count + remote_steerable: + type: boolean + description: Whether this session supports remote steering + via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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' + event_content: Fix the login button on the homepage + head_ref: copilot/fix-1 + base_ref: main + '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: Returns a list of tasks for the authenticated user + 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 + description: Filter by archived status. When `true`, returns only archived + tasks. When `false`, returns only non-archived tasks. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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: Returns a task by ID with its associated sessions + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + agent_id: + type: integer + format: int64 + description: Agent ID + agent_task_id: + type: string + description: Agent internal task ID + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + event_type: + type: string + description: Type of event that triggered this session + event_url: + type: string + description: URL of the triggering event + event_content: + type: string + description: Content of the triggering event + event_identifiers: + type: array + items: + type: string + description: Identifiers for tracking + resource_type: + type: string + description: Type of resource associated with this session + resource_id: + type: integer + format: int64 + description: Resource ID + resource_number: + type: integer + format: int32 + description: Resource number (e.g., PR number) + resource_global_id: + type: string + description: GraphQL global ID of the resource + resource_state: + type: string + description: State of the associated resource + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + workflow_run_id: + type: integer + format: int64 + description: GitHub Actions workflow run ID + model: + type: string + description: Model used for this session + premium_requests: + type: number + format: double + description: Premium request count + remote_steerable: + type: boolean + description: Whether this session supports remote steering + via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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' + event_content: Fix the login button on the homepage + head_ref: copilot/fix-1 + base_ref: main + '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 @@ -1656,7 +4191,7 @@ paths: schema: type: integer default: 30 - - &204 + - &203 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1665,7 +4200,7 @@ paths: required: false schema: type: string - - &205 + - &204 name: status description: Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries @@ -1685,7 +4220,7 @@ paths: application/json: schema: type: array - items: &206 + items: &205 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1781,7 +4316,7 @@ paths: - installation_id - repository_id examples: - default: &207 + default: &206 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1916,7 +4451,7 @@ paths: description: Response content: application/json: - schema: &208 + schema: &207 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -2051,7 +4586,7 @@ paths: - request - response examples: - default: &209 + default: &208 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -8323,7 +10858,7 @@ paths: description: Response content: application/json: - schema: &182 + schema: &181 type: array description: A list of default code security configurations items: @@ -8339,7 +10874,7 @@ paths: default configuration: *47 examples: - default: &183 + default: &182 value: - default_for_new_repos: public configuration: @@ -8679,7 +11214,7 @@ paths: - *38 - *49 responses: - '204': &184 + '204': &183 description: A header with no content is returned. '400': *14 '403': *27 @@ -8806,7 +11341,7 @@ paths: default: value: default_for_new_repos: all - configuration: &181 + configuration: &180 value: id: 1325 target_type: organization @@ -8891,7 +11426,7 @@ paths: application/json: schema: type: array - items: &185 + items: &184 type: object description: Repositories associated with a code security configuration and attachment status @@ -9236,7 +11771,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &186 + repository: &185 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -9537,7 +12072,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *38 - - &190 + - &189 name: state in: query description: |- @@ -9546,7 +12081,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &191 + - &190 name: severity in: query description: |- @@ -9555,7 +12090,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &192 + - &191 name: ecosystem in: query description: |- @@ -9564,14 +12099,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &193 + - &192 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &194 + - &193 name: epss_percentage in: query description: |- @@ -9583,7 +12118,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 - - &471 + - &470 name: has in: query description: |- @@ -9597,7 +12132,7 @@ paths: type: string enum: - patch - - &195 + - &194 name: assignee in: query description: |- @@ -9606,7 +12141,7 @@ paths: Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. schema: type: string - - &196 + - &195 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -9616,7 +12151,7 @@ paths: enum: - development - runtime - - &197 + - &196 name: sort in: query description: |- @@ -9642,11 +12177,11 @@ paths: application/json: schema: type: array - items: &198 + items: &197 type: object description: A Dependabot alert. properties: - number: &171 + number: &170 type: integer description: The security alert number. readOnly: true @@ -9711,8 +12246,9 @@ paths: - unknown - direct - transitive + - inconclusive - - security_advisory: &472 + security_advisory: &471 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9919,29 +12455,29 @@ paths: - withdrawn_at additionalProperties: false security_vulnerability: *63 - url: &174 + url: &173 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &175 + html_url: &174 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &172 + created_at: &171 type: string description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &173 + updated_at: &172 type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_at: &177 + dismissed_at: &176 type: - string - 'null' @@ -9972,7 +12508,7 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: &176 + fixed_at: &175 type: - string - 'null' @@ -9980,7 +12516,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &473 + auto_dismissed_at: &472 type: - string - 'null' @@ -9988,7 +12524,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &474 + dismissal_request: &473 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -10051,7 +12587,7 @@ paths: - repository additionalProperties: false examples: - default: &199 + default: &198 value: - number: 2 state: dismissed @@ -10100,7 +12636,7 @@ paths: vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N score: 8.7 epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 cwes: - cwe_id: CWE-200 @@ -11415,7 +13951,7 @@ paths: properties: action: type: string - discussion: &722 + discussion: &721 title: Discussion description: A Discussion in a repository. type: object @@ -11916,7 +14452,7 @@ paths: milestone: anyOf: - type: 'null' - - &266 + - &265 title: Milestone description: A collection of related issues and pull requests. @@ -12088,7 +14624,7 @@ paths: timeline_url: type: string format: uri - type: &230 + type: &229 title: Issue Type description: The type of issue. type: @@ -12199,7 +14735,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &643 + sub_issues_summary: &642 title: Sub-issues Summary type: object properties: @@ -12283,7 +14819,7 @@ paths: pin: anyOf: - type: 'null' - - &544 + - &543 title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. @@ -12310,7 +14846,7 @@ paths: - url - created_at - updated_at - issue_dependencies_summary: &644 + issue_dependencies_summary: &643 title: Issue Dependencies Summary type: object properties: @@ -12329,7 +14865,7 @@ paths: - total_blocking issue_field_values: type: array - items: &529 + items: &528 title: Issue Field Value description: A value assigned to an issue field type: object @@ -13110,7 +15646,7 @@ paths: type: string release: allOf: - - &576 + - &575 title: Release description: A release. type: object @@ -13192,7 +15728,7 @@ paths: author: *4 assets: type: array - items: &577 + items: &576 title: Release Asset description: Data related to a release. type: object @@ -13795,7 +16331,7 @@ paths: url: type: string format: uri - user: &650 + user: &649 title: Public User description: Public User type: object @@ -15692,7 +18228,7 @@ paths: - closed - all default: open - - &233 + - &232 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -15743,7 +18279,7 @@ paths: type: array items: *81 examples: - default: &234 + default: &233 value: - id: 1 node_id: MDU6SXNzdWUx @@ -17155,14 +19691,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &325 + - &324 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &326 + - &325 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -17224,7 +19760,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &329 + '301': &328 description: Moved permanently content: application/json: @@ -17246,7 +19782,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &552 + - &551 name: all description: If `true`, show notifications marked as read. in: query @@ -17254,7 +19790,7 @@ paths: schema: type: boolean default: false - - &553 + - &552 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -17264,7 +19800,7 @@ paths: type: boolean default: false - *86 - - &554 + - &553 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: @@ -17296,7 +19832,7 @@ paths: properties: id: type: string - repository: &153 + repository: &152 title: Minimal Repository description: Minimal Repository type: object @@ -17646,7 +20182,7 @@ paths: type: boolean examples: - false - security_and_analysis: &281 + security_and_analysis: &280 type: - object - 'null' @@ -17850,7 +20386,7 @@ paths: - url - subscription_url examples: - default: &555 + default: &554 value: - id: '1' repository: @@ -19420,7 +21956,7 @@ paths: required: false schema: type: string - - &699 + - &698 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -19566,7 +22102,7 @@ paths: parameters: - *73 - *115 - - &700 + - &699 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 @@ -19678,7 +22214,7 @@ paths: - *115 - *117 - *116 - - &701 + - &700 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -19686,7 +22222,7 @@ paths: schema: type: string - *118 - - &702 + - &701 name: sku description: The SKU to query for usage. in: query @@ -20665,7 +23201,7 @@ paths: type: integer repository_cache_usages: type: array - items: &336 + items: &335 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -20913,7 +23449,7 @@ paths: - public_ip_enabled - platform examples: - default: &152 + default: &151 value: total_count: 2 runners: @@ -21908,7 +24444,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &135 + schema: title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -21922,7 +24458,7 @@ paths: required: - include_claim_keys examples: - default: &136 + default: &135 value: include_claim_keys: - repo @@ -21949,15 +24485,25 @@ paths: required: true content: application/json: - schema: *135 + schema: + title: Actions OIDC Subject customization + description: Actions OIDC Subject customization + type: object + properties: + include_claim_keys: + description: Array of unique strings. Each claim key can only contain + alphanumeric characters and underscores. + type: array + items: + type: string examples: - default: *136 + default: *135 responses: '201': description: Empty response content: application/json: - schema: &162 + schema: &161 title: Empty Object description: An object without any properties. type: object @@ -21996,7 +24542,7 @@ paths: schema: type: object properties: - enabled_repositories: &137 + enabled_repositories: &136 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -22009,7 +24555,7 @@ paths: description: The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. - allowed_actions: &138 + allowed_actions: &137 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -22017,12 +24563,12 @@ paths: - all - local_only - selected - selected_actions_url: &342 + selected_actions_url: &341 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. - sha_pinning_required: &139 + sha_pinning_required: &138 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -22064,9 +24610,9 @@ paths: schema: type: object properties: - enabled_repositories: *137 - allowed_actions: *138 - sha_pinning_required: *139 + enabled_repositories: *136 + allowed_actions: *137 + sha_pinning_required: *138 required: - enabled_repositories examples: @@ -22100,7 +24646,7 @@ paths: description: Response content: application/json: - schema: &346 + schema: &345 type: object properties: days: @@ -22142,7 +24688,7 @@ paths: required: true content: application/json: - schema: &347 + schema: &346 type: object properties: days: @@ -22185,7 +24731,7 @@ paths: description: Response content: application/json: - schema: &140 + schema: &139 type: object properties: approval_policy: @@ -22199,7 +24745,7 @@ paths: required: - approval_policy examples: - default: &348 + default: &347 value: approval_policy: first_time_contributors '404': *6 @@ -22230,7 +24776,7 @@ paths: required: true content: application/json: - schema: *140 + schema: *139 examples: default: summary: Set approval policy to first time contributors @@ -22258,7 +24804,7 @@ paths: description: Response content: application/json: - schema: &349 + schema: &348 type: object required: - run_workflows_from_fork_pull_requests @@ -22284,7 +24830,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &141 + default: &140 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -22312,7 +24858,7 @@ paths: required: true content: application/json: - schema: &350 + schema: &349 type: object required: - run_workflows_from_fork_pull_requests @@ -22335,7 +24881,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *141 + default: *140 responses: '204': description: Empty response for successful settings update @@ -22385,7 +24931,7 @@ paths: type: array items: *77 examples: - default: &145 + default: &144 value: total_count: 1 repositories: @@ -22570,7 +25116,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *73 - - &142 + - &141 name: repository_id description: The unique identifier of the repository. in: path @@ -22599,7 +25145,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *73 - - *142 + - *141 responses: '204': description: Response @@ -22628,7 +25174,7 @@ paths: description: Response content: application/json: - schema: &143 + schema: &142 type: object properties: github_owned_allowed: @@ -22650,7 +25196,7 @@ paths: items: type: string examples: - default: &144 + default: &143 value: github_owned_allowed: true verified_allowed: false @@ -22683,9 +25229,9 @@ paths: required: false content: application/json: - schema: *143 + schema: *142 examples: - selected_actions: *144 + selected_actions: *143 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22817,7 +25363,7 @@ paths: type: array items: *77 examples: - default: *145 + default: *144 '403': *27 '404': *6 x-github: @@ -22886,7 +25432,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - *73 - - *142 + - *141 responses: '204': description: No content @@ -22913,7 +25459,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - *73 - - *142 + - *141 responses: '204': description: No content @@ -22947,17 +25493,17 @@ paths: description: Response content: application/json: - schema: &351 + schema: &350 type: object properties: - default_workflow_permissions: &146 + default_workflow_permissions: &145 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &147 + can_approve_pull_request_reviews: &146 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -22965,7 +25511,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &148 + default: &147 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -22998,13 +25544,13 @@ paths: required: false content: application/json: - schema: &352 + schema: &351 type: object properties: - default_workflow_permissions: *146 - can_approve_pull_request_reviews: *147 + default_workflow_permissions: *145 + can_approve_pull_request_reviews: *146 examples: - default: *148 + default: *147 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23049,7 +25595,7 @@ paths: type: number runner_groups: type: array - items: &149 + items: &148 type: object properties: id: @@ -23239,9 +25785,9 @@ paths: description: Response content: application/json: - schema: *149 + schema: *148 examples: - default: &151 + default: &150 value: id: 2 name: octo-runner-group @@ -23277,7 +25823,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - *73 - - &150 + - &149 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -23289,7 +25835,7 @@ paths: description: Response content: application/json: - schema: *149 + schema: *148 examples: default: value: @@ -23326,7 +25872,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - *73 - - *150 + - *149 requestBody: required: true content: @@ -23382,9 +25928,9 @@ paths: description: Response content: application/json: - schema: *149 + schema: *148 examples: - default: *151 + default: *150 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -23404,7 +25950,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - *73 - - *150 + - *149 responses: '204': description: Response @@ -23428,7 +25974,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - *73 - - *150 + - *149 - *17 - *19 responses: @@ -23448,7 +25994,7 @@ paths: type: array items: *123 examples: - default: *152 + default: *151 headers: Link: *65 x-github: @@ -23471,7 +26017,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *73 - - *150 + - *149 - *19 - *17 responses: @@ -23489,9 +26035,9 @@ paths: type: number repositories: type: array - items: *153 + items: *152 examples: - default: &189 + default: &188 value: total_count: 1 repositories: @@ -23744,7 +26290,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - *73 - - *150 + - *149 requestBody: required: true content: @@ -23789,8 +26335,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *73 - - *150 - - *142 + - *149 + - *141 responses: '204': description: Response @@ -23813,8 +26359,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *73 - - *150 - - *142 + - *149 + - *141 responses: '204': description: Response @@ -23838,7 +26384,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - *73 - - *150 + - *149 - *17 - *19 responses: @@ -23856,7 +26402,7 @@ paths: type: number runners: type: array - items: &155 + items: &154 title: Self hosted runners description: A self hosted runner type: object @@ -23890,7 +26436,7 @@ paths: type: boolean labels: type: array - items: &158 + items: &157 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -23920,7 +26466,7 @@ paths: - busy - labels examples: - default: &156 + default: &155 value: total_count: 2 runners: @@ -23980,7 +26526,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - *73 - - *150 + - *149 requestBody: required: true content: @@ -24025,8 +26571,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - *73 - - *150 - - &154 + - *149 + - &153 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -24055,8 +26601,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - *73 - - *150 - - *154 + - *149 + - *153 responses: '204': description: Response @@ -24104,9 +26650,9 @@ paths: type: integer runners: type: array - items: *155 + items: *154 examples: - default: *156 + default: *155 headers: Link: *65 x-github: @@ -24138,7 +26684,7 @@ paths: application/json: schema: type: array - items: &353 + items: &352 title: Runner Application description: Runner Application type: object @@ -24163,7 +26709,7 @@ paths: - download_url - filename examples: - default: &354 + default: &353 value: - os: osx architecture: x64 @@ -24249,7 +26795,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &355 + '201': &354 description: Response content: application/json: @@ -24259,7 +26805,7 @@ paths: - runner - encoded_jit_config properties: - runner: *155 + runner: *154 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -24322,7 +26868,7 @@ paths: description: Response content: application/json: - schema: &157 + schema: &156 title: Authentication Token description: Authentication Token type: object @@ -24364,7 +26910,7 @@ paths: - token - expires_at examples: - default: &356 + default: &355 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -24401,9 +26947,9 @@ paths: description: Response content: application/json: - schema: *157 + schema: *156 examples: - default: &357 + default: &356 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -24429,15 +26975,15 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - *73 - - *154 + - *153 responses: '200': description: Response content: application/json: - schema: *155 + schema: *154 examples: - default: &358 + default: &357 value: id: 23 name: MBP @@ -24479,7 +27025,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - *73 - - *154 + - *153 responses: '204': description: Response @@ -24506,9 +27052,9 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - *73 - - *154 + - *153 responses: - '200': &159 + '200': &158 description: Response content: application/json: @@ -24522,7 +27068,7 @@ paths: type: integer labels: type: array - items: *158 + items: *157 examples: default: value: @@ -24562,7 +27108,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - *73 - - *154 + - *153 requestBody: required: true content: @@ -24586,7 +27132,7 @@ paths: - gpu - accelerated responses: - '200': *159 + '200': *158 '404': *6 '422': *7 x-github: @@ -24611,7 +27157,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - *73 - - *154 + - *153 requestBody: required: true content: @@ -24636,7 +27182,7 @@ paths: - gpu - accelerated responses: - '200': *159 + '200': *158 '404': *6 '422': *7 x-github: @@ -24661,9 +27207,9 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - *73 - - *154 + - *153 responses: - '200': &359 + '200': &358 description: Response content: application/json: @@ -24677,7 +27223,7 @@ paths: type: integer labels: type: array - items: *158 + items: *157 examples: default: value: @@ -24719,8 +27265,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - *73 - - *154 - - &360 + - *153 + - &359 name: name description: The name of a self-hosted runner's custom label. in: path @@ -24728,7 +27274,7 @@ paths: schema: type: string responses: - '200': *159 + '200': *158 '404': *6 '422': *7 x-github: @@ -24771,7 +27317,7 @@ paths: type: integer secrets: type: array - items: &160 + items: &159 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -24852,7 +27398,7 @@ paths: description: Response content: application/json: - schema: &372 + schema: &371 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -24887,7 +27433,7 @@ paths: - key_id - key examples: - default: &373 + default: &372 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -24913,7 +27459,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - *73 - - &161 + - &160 name: secret_name description: The name of the secret. in: path @@ -24925,7 +27471,7 @@ paths: description: Response content: application/json: - schema: *160 + schema: *159 examples: default: value: @@ -24956,7 +27502,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - *73 - - *161 + - *160 requestBody: required: true content: @@ -25013,7 +27559,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -25040,7 +27586,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - *73 - - *161 + - *160 responses: '204': description: Response @@ -25067,7 +27613,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - *73 - - *161 + - *160 - *19 - *17 responses: @@ -25085,9 +27631,9 @@ paths: type: integer repositories: type: array - items: *153 + items: *152 examples: - default: &165 + default: &164 value: total_count: 1 repositories: @@ -25180,7 +27726,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - *73 - - *161 + - *160 requestBody: required: true content: @@ -25233,7 +27779,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - *73 - - *161 + - *160 - name: repository_id in: path required: true @@ -25267,7 +27813,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - *73 - - *161 + - *160 - name: repository_id in: path required: true @@ -25300,7 +27846,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *73 - - &341 + - &340 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/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -25324,7 +27870,7 @@ paths: type: integer variables: type: array - items: &163 + items: &162 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -25462,7 +28008,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -25488,7 +28034,7 @@ paths: url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - *73 - - &164 + - &163 name: name description: The name of the variable. in: path @@ -25500,7 +28046,7 @@ paths: description: Response content: application/json: - schema: *163 + schema: *162 examples: default: value: @@ -25531,7 +28077,7 @@ paths: url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - *73 - - *164 + - *163 requestBody: required: true content: @@ -25594,7 +28140,7 @@ paths: url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - *73 - - *164 + - *163 responses: '204': description: Response @@ -25621,7 +28167,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - *73 - - *164 + - *163 - *19 - *17 responses: @@ -25639,9 +28185,9 @@ paths: type: integer repositories: type: array - items: *153 + items: *152 examples: - default: *165 + default: *164 '409': description: Response when the visibility of the variable is not set to `selected` @@ -25668,7 +28214,7 @@ paths: url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - *73 - - *164 + - *163 requestBody: required: true content: @@ -25718,7 +28264,7 @@ paths: url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - *73 - - *164 + - *163 - name: repository_id in: path required: true @@ -25753,7 +28299,7 @@ paths: url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - *73 - - *164 + - *163 - name: repository_id in: path required: true @@ -25913,7 +28459,7 @@ paths: type: integer deployment_records: type: array - items: &166 + items: &165 title: Artifact Deployment Record description: Artifact Metadata Deployment Record type: object @@ -25958,7 +28504,7 @@ paths: description: The ID of the provenance attestation associated with the deployment record. examples: - default: &167 + default: &166 value: total_count: 1 deployment_records: @@ -26133,10 +28679,23 @@ paths: type: integer deployment_records: type: array - items: *166 + items: *165 examples: - default: *167 - '403': *27 + default: *166 + '403': + description: Forbidden + content: + application/json: + schema: *3 + examples: + insufficient_repo_permissions: + value: + message: + cause: artifact metadata write permission required on one or + more repositories + repositories: + - 123 + - 345 '404': *6 x-github: githubCloudOnly: false @@ -26349,9 +28908,9 @@ paths: - 3 deployment_records: type: array - items: *166 + items: *165 examples: - default: *167 + default: *166 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26481,12 +29040,12 @@ paths: required: - subject_digests examples: - default: &681 + default: &680 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &682 + withPredicateType: &681 value: subject_digests: - sha256:abc123 @@ -26545,7 +29104,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &683 + default: &682 value: attestations_subject_digests: - sha256:abc: @@ -26896,7 +29455,7 @@ paths: initiator: type: string examples: - default: &386 + default: &385 value: attestations: - bundle: @@ -27115,7 +29674,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &168 + schema: &167 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -27141,7 +29700,7 @@ paths: application/json: schema: type: array - items: &169 + items: &168 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -27172,7 +29731,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &188 + items: &187 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -27249,7 +29808,7 @@ paths: parent: anyOf: - type: 'null' - - &245 + - &244 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -27385,7 +29944,7 @@ paths: - string - 'null' format: date-time - state: *168 + state: *167 contact_link: description: The contact link of the campaign. type: @@ -27608,9 +30167,9 @@ paths: description: Response content: application/json: - schema: *169 + schema: *168 examples: - default: &170 + default: &169 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -27693,9 +30252,9 @@ paths: description: Response content: application/json: - schema: *169 + schema: *168 examples: - default: *170 + default: *169 '404': *6 '422': description: Unprocessable Entity @@ -27773,7 +30332,7 @@ paths: - string - 'null' format: uri - state: *168 + state: *167 examples: default: value: @@ -27783,9 +30342,9 @@ paths: description: Response content: application/json: - schema: *169 + schema: *168 examples: - default: *170 + default: *169 '400': description: Bad Request content: @@ -27852,17 +30411,17 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *73 - - &410 + - &409 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. in: query required: false - schema: &178 + schema: &177 type: string description: The name of the tool used to generate the code scanning analysis. - - &411 + - &410 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -27870,7 +30429,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &179 + schema: &178 type: - string - 'null' @@ -27886,7 +30445,7 @@ paths: be returned. in: query required: false - schema: &413 + schema: &412 type: string description: State of a code scanning alert. enum: @@ -27909,7 +30468,7 @@ paths: be returned. in: query required: false - schema: &414 + schema: &413 type: string description: Severity of a code scanning alert. enum: @@ -27938,18 +30497,18 @@ paths: items: type: object properties: - number: *171 - created_at: *172 - updated_at: *173 - url: *174 - html_url: *175 - instances_url: &415 + number: *170 + created_at: *171 + updated_at: *172 + url: *173 + html_url: *174 + instances_url: &414 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &180 + state: &179 type: - string - 'null' @@ -27959,13 +30518,13 @@ paths: - dismissed - fixed - - fixed_at: *176 + fixed_at: *175 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *177 - dismissed_reason: &416 + dismissed_at: *176 + dismissed_reason: &415 type: - string - 'null' @@ -27976,14 +30535,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &417 + dismissed_comment: &416 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &418 + rule: &417 type: object properties: id: @@ -28044,43 +30603,43 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &419 + tool: &418 type: object properties: - name: *178 + name: *177 version: type: - string - 'null' description: The version of the tool used to generate the code scanning analysis. - guid: *179 - most_recent_instance: &420 + guid: *178 + most_recent_instance: &419 type: object properties: - ref: &412 + ref: &411 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &430 + analysis_key: &429 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: &431 + environment: &430 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: &432 + category: &431 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. - state: *180 + state: *179 commit_sha: type: string message: @@ -28094,7 +30653,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: &433 + location: &432 type: object description: Describe a region within a file for the alert. properties: @@ -28115,7 +30674,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: &434 + items: &433 type: - string - 'null' @@ -28751,7 +31310,7 @@ paths: application/json: schema: *47 examples: - default: *181 + default: *180 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28779,9 +31338,9 @@ paths: description: Response content: application/json: - schema: *182 + schema: *181 examples: - default: *183 + default: *182 '304': *35 '403': *27 '404': *6 @@ -28833,7 +31392,7 @@ paths: - 32 - 91 responses: - '204': *184 + '204': *183 '400': *14 '403': *27 '404': *6 @@ -28868,7 +31427,7 @@ paths: application/json: schema: *47 examples: - default: *181 + default: *180 '304': *35 '403': *27 '404': *6 @@ -29168,7 +31727,7 @@ paths: - *73 - *49 responses: - '204': *184 + '204': *183 '400': *14 '403': *27 '404': *6 @@ -29306,7 +31865,7 @@ paths: default: value: default_for_new_repos: all - configuration: *181 + configuration: *180 '403': *27 '404': *6 x-github: @@ -29359,13 +31918,13 @@ paths: application/json: schema: type: array - items: *185 + items: *184 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *186 + repository: *185 '403': *27 '404': *6 x-github: @@ -29405,7 +31964,7 @@ paths: type: integer codespaces: type: array - items: &235 + items: &234 type: object title: Codespace description: A codespace. @@ -29436,11 +31995,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *153 + repository: *152 machine: anyOf: - type: 'null' - - &446 + - &445 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -29727,7 +32286,7 @@ paths: - pulls_url - recent_folders examples: - default: &236 + default: &235 value: total_count: 3 codespaces: @@ -30351,7 +32910,7 @@ paths: type: integer secrets: type: array - items: &187 + items: &186 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -30392,7 +32951,7 @@ paths: - updated_at - visibility examples: - default: &447 + default: &446 value: total_count: 2 secrets: @@ -30430,7 +32989,7 @@ paths: description: Response content: application/json: - schema: &448 + schema: &447 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -30465,7 +33024,7 @@ paths: - key_id - key examples: - default: &449 + default: &448 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -30489,15 +33048,15 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - *73 - - *161 + - *160 responses: '200': description: Response content: application/json: - schema: *187 + schema: *186 examples: - default: &451 + default: &450 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -30525,7 +33084,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - *73 - - *161 + - *160 requestBody: required: true content: @@ -30580,7 +33139,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -30607,7 +33166,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - *73 - - *161 + - *160 responses: '204': description: Response @@ -30633,7 +33192,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - *73 - - *161 + - *160 - *19 - *17 responses: @@ -30651,9 +33210,9 @@ paths: type: integer repositories: type: array - items: *153 + items: *152 examples: - default: *165 + default: *164 '404': *6 x-github: githubCloudOnly: false @@ -30676,7 +33235,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - *73 - - *161 + - *160 requestBody: required: true content: @@ -30727,7 +33286,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - *73 - - *161 + - *160 - name: repository_id in: path required: true @@ -30761,7 +33320,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - *73 - - *161 + - *160 - name: repository_id in: path required: true @@ -30964,7 +33523,7 @@ paths: currently being billed. seats: type: array - items: &238 + items: &237 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -30982,7 +33541,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *188 + - *187 - *66 type: - 'null' @@ -31595,12 +34154,12 @@ paths: type: integer repositories: type: array - items: *153 + items: *152 required: - total_count - repositories examples: - default: *189 + default: *188 '500': *53 '401': *23 '403': *27 @@ -31686,7 +34245,7 @@ paths: url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization parameters: - *73 - - *142 + - *141 responses: '204': description: No Content @@ -31720,7 +34279,7 @@ paths: url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization parameters: - *73 - - *142 + - *141 responses: '204': description: No Content @@ -31935,7 +34494,7 @@ paths: application/json: schema: type: array - items: &318 + items: &317 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -32250,7 +34809,7 @@ paths: - date additionalProperties: true examples: - default: &319 + default: &318 value: - date: '2024-06-24' total_active_users: 24 @@ -32352,7 +34911,7 @@ paths: '500': *53 '403': *27 '404': *6 - '422': &320 + '422': &319 description: Copilot Usage Metrics API setting is disabled at the organization or enterprise level. content: @@ -32393,7 +34952,7 @@ paths: schema: *55 examples: default: *56 - '204': *184 + '204': *183 '500': *53 '403': *27 '404': *6 @@ -32469,7 +35028,7 @@ paths: schema: *55 examples: default: *56 - '204': *184 + '204': *183 '500': *53 '403': *27 '404': *6 @@ -32532,11 +35091,11 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *73 + - *189 - *190 - *191 - *192 - *193 - - *194 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -32566,7 +35125,7 @@ paths: enum: - patch - deployment - - *195 + - *194 - name: runtime_risk in: query description: |- @@ -32575,8 +35134,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string + - *195 - *196 - - *197 - *59 - *45 - *46 @@ -32588,9 +35147,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *199 + default: *198 '304': *35 '400': *14 '403': *27 @@ -32634,7 +35193,7 @@ paths: type: integer secrets: type: array - items: &200 + items: &199 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -32713,7 +35272,7 @@ paths: description: Response content: application/json: - schema: &477 + schema: &476 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -32732,7 +35291,7 @@ paths: - key_id - key examples: - default: &478 + default: &477 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -32756,13 +35315,13 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - *73 - - *161 + - *160 responses: '200': description: Response content: application/json: - schema: *200 + schema: *199 examples: default: value: @@ -32791,7 +35350,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - *73 - - *161 + - *160 requestBody: required: true content: @@ -32848,7 +35407,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -32873,7 +35432,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - *73 - - *161 + - *160 responses: '204': description: Response @@ -32898,7 +35457,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - *73 - - *161 + - *160 - *19 - *17 responses: @@ -32916,9 +35475,9 @@ paths: type: integer repositories: type: array - items: *153 + items: *152 examples: - default: *165 + default: *164 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32940,7 +35499,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - *73 - - *161 + - *160 requestBody: required: true content: @@ -32991,7 +35550,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - *73 - - *161 + - *160 - name: repository_id in: path required: true @@ -33023,7 +35582,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - *73 - - *161 + - *160 - name: repository_id in: path required: true @@ -33061,7 +35620,7 @@ paths: application/json: schema: type: array - items: &247 + items: &246 title: Package description: A software package type: object @@ -33114,7 +35673,7 @@ paths: repository: anyOf: - type: 'null' - - *153 + - *152 created_at: type: string format: date-time @@ -33132,7 +35691,7 @@ paths: - created_at - updated_at examples: - default: &248 + default: &247 value: - id: 197 name: hello_docker @@ -33302,7 +35861,7 @@ paths: application/json: schema: type: array - items: &224 + items: &223 title: Organization Invitation description: Organization Invitation type: object @@ -33356,7 +35915,7 @@ paths: - invitation_teams_url - node_id examples: - default: &225 + default: &224 value: - id: 1 login: monalisa @@ -33423,7 +35982,7 @@ paths: application/json: schema: type: array - items: &201 + items: &200 title: Org Hook description: Org Hook type: object @@ -33608,9 +36167,9 @@ paths: description: Response content: application/json: - schema: *201 + schema: *200 examples: - default: &202 + default: &201 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -33658,7 +36217,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - *73 - - &203 + - &202 name: hook_id description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. @@ -33671,9 +36230,9 @@ paths: description: Response content: application/json: - schema: *201 + schema: *200 examples: - default: *202 + default: *201 '404': *6 x-github: githubCloudOnly: false @@ -33701,7 +36260,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - *73 - - *203 + - *202 requestBody: required: false content: @@ -33747,7 +36306,7 @@ paths: description: Response content: application/json: - schema: *201 + schema: *200 examples: default: value: @@ -33789,7 +36348,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - *73 - - *203 + - *202 responses: '204': description: Response @@ -33817,7 +36376,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *73 - - *203 + - *202 responses: '200': description: Response @@ -33848,7 +36407,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *73 - - *203 + - *202 requestBody: required: false content: @@ -33899,10 +36458,10 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *73 - - *203 + - *202 - *17 + - *203 - *204 - - *205 responses: '200': description: Response @@ -33910,9 +36469,9 @@ paths: application/json: schema: type: array - items: *206 + items: *205 examples: - default: *207 + default: *206 '400': *14 '422': *15 x-github: @@ -33938,16 +36497,16 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *73 - - *203 + - *202 - *16 responses: '200': description: Response content: application/json: - schema: *208 + schema: *207 examples: - default: *209 + default: *208 '400': *14 '422': *15 x-github: @@ -33973,7 +36532,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *73 - - *203 + - *202 - *16 responses: '202': *37 @@ -34003,7 +36562,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - *73 - - *203 + - *202 responses: '204': description: Response @@ -34026,7 +36585,7 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - *73 - - &214 + - &213 name: actor_type in: path description: The type of the actor @@ -34039,14 +36598,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &215 + - &214 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &210 + - &209 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -34054,7 +36613,7 @@ paths: required: true schema: type: string - - &211 + - &210 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -34149,12 +36708,12 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - *73 + - *209 - *210 - - *211 - *19 - *17 - *59 - - &220 + - &219 name: sort description: The property to sort the results by. in: query @@ -34233,14 +36792,14 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - *73 + - *209 - *210 - - *211 responses: '200': description: Response content: application/json: - schema: &212 + schema: &211 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -34256,7 +36815,7 @@ paths: type: integer format: int64 examples: - default: &213 + default: &212 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -34277,23 +36836,23 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - *73 - - &216 + - &215 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string + - *209 - *210 - - *211 responses: '200': description: Response content: application/json: - schema: *212 + schema: *211 examples: - default: *213 + default: *212 x-github: enabledForGitHubApps: true category: orgs @@ -34312,18 +36871,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *73 + - *209 - *210 - - *211 + - *213 - *214 - - *215 responses: '200': description: Response content: application/json: - schema: *212 + schema: *211 examples: - default: *213 + default: *212 x-github: enabledForGitHubApps: true category: orgs @@ -34341,9 +36900,9 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - *73 + - *209 - *210 - - *211 - - &217 + - &216 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -34356,7 +36915,7 @@ paths: description: Response content: application/json: - schema: &218 + schema: &217 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -34372,7 +36931,7 @@ paths: type: integer format: int64 examples: - default: &219 + default: &218 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -34409,18 +36968,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - *73 - - *216 + - *215 + - *209 - *210 - - *211 - - *217 + - *216 responses: '200': description: Response content: application/json: - schema: *218 + schema: *217 examples: - default: *219 + default: *218 x-github: enabledForGitHubApps: true category: orgs @@ -34438,19 +36997,19 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - *73 + - *213 - *214 - - *215 + - *209 - *210 - - *211 - - *217 + - *216 responses: '200': description: Response content: application/json: - schema: *218 + schema: *217 examples: - default: *219 + default: *218 x-github: enabledForGitHubApps: true category: orgs @@ -34468,13 +37027,13 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - *73 - - *216 + - *215 + - *209 - *210 - - *211 - *19 - *17 - *59 - - *220 + - *219 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -34558,7 +37117,7 @@ paths: application/json: schema: *20 examples: - default: &516 + default: &515 value: id: 1 account: @@ -34724,12 +37283,12 @@ paths: application/json: schema: anyOf: - - &222 + - &221 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &221 + limit: &220 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -34757,7 +37316,7 @@ paths: properties: {} additionalProperties: false examples: - default: &223 + default: &222 value: limit: collaborators_only origin: organization @@ -34786,13 +37345,13 @@ paths: required: true content: application/json: - schema: &517 + schema: &516 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *221 + limit: *220 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -34817,9 +37376,9 @@ paths: description: Response content: application/json: - schema: *222 + schema: *221 examples: - default: *223 + default: *222 '422': *15 x-github: githubCloudOnly: false @@ -34895,9 +37454,9 @@ paths: application/json: schema: type: array - items: *224 + items: *223 examples: - default: *225 + default: *224 headers: Link: *65 '404': *6 @@ -34974,7 +37533,7 @@ paths: description: Response content: application/json: - schema: *224 + schema: *223 examples: default: value: @@ -35029,7 +37588,7 @@ paths: url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - *73 - - &226 + - &225 name: invitation_id description: The unique identifier of the invitation. in: path @@ -35060,7 +37619,7 @@ paths: url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - *73 - - *226 + - *225 - *17 - *19 responses: @@ -35070,9 +37629,9 @@ paths: application/json: schema: type: array - items: *188 + items: *187 examples: - default: &246 + default: &245 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -35115,7 +37674,7 @@ paths: application/json: schema: type: array - items: &227 + items: &226 title: Issue Field description: A custom attribute defined at the organization level for attaching structured data to issues. @@ -35358,9 +37917,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *226 examples: - default: &228 + default: &227 value: id: 512 node_id: IF_kwDNAd3NAZr @@ -35416,7 +37975,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-fields#update-issue-field-for-an-organization parameters: - *73 - - &229 + - &228 name: issue_field_id description: The unique identifier of the issue field. in: path @@ -35517,9 +38076,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *226 examples: - default: *228 + default: *227 '404': *6 '422': *7 x-github: @@ -35544,9 +38103,9 @@ paths: url: https://docs.github.com/rest/orgs/issue-fields#delete-issue-field-for-an-organization parameters: - *73 - - *229 + - *228 responses: - '204': *184 + '204': *183 '404': *6 '422': *7 x-github: @@ -35574,7 +38133,7 @@ paths: application/json: schema: type: array - items: *230 + items: *229 examples: default: value: @@ -35662,9 +38221,9 @@ paths: description: Response content: application/json: - schema: *230 + schema: *229 examples: - default: &231 + default: &230 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -35697,7 +38256,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *73 - - &232 + - &231 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -35753,9 +38312,9 @@ paths: description: Response content: application/json: - schema: *230 + schema: *229 examples: - default: *231 + default: *230 '404': *6 '422': *7 x-github: @@ -35780,7 +38339,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *73 - - *232 + - *231 responses: '204': description: Response @@ -35843,7 +38402,7 @@ paths: - closed - all default: open - - *233 + - *232 - name: type description: Can be the name of an issue type. in: query @@ -35874,7 +38433,7 @@ paths: type: array items: *81 examples: - default: *234 + default: *233 headers: Link: *65 '404': *6 @@ -36033,9 +38592,9 @@ paths: type: integer codespaces: type: array - items: *235 + items: *234 examples: - default: *236 + default: *235 '304': *35 '500': *53 '401': *23 @@ -36062,7 +38621,7 @@ paths: parameters: - *73 - *69 - - &237 + - &236 name: codespace_name in: path required: true @@ -36097,15 +38656,15 @@ paths: parameters: - *73 - *69 - - *237 + - *236 responses: '200': description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: &445 + default: &444 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -36285,7 +38844,7 @@ paths: description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *238 + schema: *237 examples: default: value: @@ -36361,7 +38920,7 @@ paths: description: Response content: application/json: - schema: &239 + schema: &238 title: Org Membership description: Org Membership type: object @@ -36430,7 +38989,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &240 + response-if-user-has-an-active-admin-membership-with-organization: &239 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -36531,9 +39090,9 @@ paths: description: Response content: application/json: - schema: *239 + schema: *238 examples: - response-if-user-already-had-membership-with-organization: *240 + response-if-user-already-had-membership-with-organization: *239 '422': *15 '403': *27 x-github: @@ -36605,7 +39164,7 @@ paths: application/json: schema: type: array - items: &241 + items: &240 title: Migration description: A migration. type: object @@ -36943,7 +39502,7 @@ paths: description: Response content: application/json: - schema: *241 + schema: *240 examples: default: value: @@ -37122,7 +39681,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - *73 - - &242 + - &241 name: migration_id description: The unique identifier of the migration. in: path @@ -37150,7 +39709,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *241 + schema: *240 examples: default: value: @@ -37320,7 +39879,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - *73 - - *242 + - *241 responses: '302': description: Response @@ -37342,7 +39901,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *73 - - *242 + - *241 responses: '204': description: Response @@ -37366,8 +39925,8 @@ paths: url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - *73 - - *242 - - &664 + - *241 + - &663 name: repo_name description: repo_name parameter in: path @@ -37395,7 +39954,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *73 - - *242 + - *241 - *17 - *19 responses: @@ -37405,9 +39964,9 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: - default: &253 + default: &252 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -37536,7 +40095,7 @@ paths: To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -37562,7 +40121,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &244 + items: &243 title: Organization Role description: Organization roles type: object @@ -37739,7 +40298,7 @@ paths: parameters: - *73 - *75 - - &243 + - &242 name: role_id description: The unique identifier of the role. in: path @@ -37776,7 +40335,7 @@ paths: parameters: - *73 - *75 - - *243 + - *242 responses: '204': description: Response @@ -37829,7 +40388,7 @@ paths: parameters: - *73 - *69 - - *243 + - *242 responses: '204': description: Response @@ -37861,7 +40420,7 @@ paths: parameters: - *73 - *69 - - *243 + - *242 responses: '204': description: Response @@ -37879,7 +40438,7 @@ paths: To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -37890,13 +40449,13 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - *73 - - *243 + - *242 responses: '200': description: Response content: application/json: - schema: *244 + schema: *243 examples: default: value: @@ -37947,7 +40506,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - *73 - - *243 + - *242 - *17 - *19 responses: @@ -38026,7 +40585,7 @@ paths: parent: anyOf: - type: 'null' - - *245 + - *244 type: description: The ownership type of the team type: string @@ -38059,7 +40618,7 @@ paths: - type - parent examples: - default: *246 + default: *245 headers: Link: *65 '404': @@ -38089,7 +40648,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - *73 - - *243 + - *242 - *17 - *19 responses: @@ -38118,7 +40677,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *245 + items: *244 name: type: - string @@ -38428,7 +40987,7 @@ paths: - nuget - container - *73 - - &665 + - &664 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -38464,12 +41023,12 @@ paths: application/json: schema: type: array - items: *247 + items: *246 examples: - default: *248 + default: *247 '403': *27 '401': *23 - '400': &667 + '400': &666 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -38491,7 +41050,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &249 + - &248 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -38509,7 +41068,7 @@ paths: - docker - nuget - container - - &250 + - &249 name: package_name description: The name of the package. in: path @@ -38522,7 +41081,7 @@ paths: description: Response content: application/json: - schema: *247 + schema: *246 examples: default: value: @@ -38574,8 +41133,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: + - *248 - *249 - - *250 - *73 responses: '204': @@ -38608,8 +41167,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: + - *248 - *249 - - *250 - *73 - name: token description: package token @@ -38642,8 +41201,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: + - *248 - *249 - - *250 - *73 - *19 - *17 @@ -38664,7 +41223,7 @@ paths: application/json: schema: type: array - items: &251 + items: &250 title: Package Version description: A version of a software package type: object @@ -38799,10 +41358,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: + - *248 - *249 - - *250 - *73 - - &252 + - &251 name: package_version_id description: Unique identifier of the package version. in: path @@ -38814,7 +41373,7 @@ paths: description: Response content: application/json: - schema: *251 + schema: *250 examples: default: value: @@ -38850,10 +41409,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: + - *248 - *249 - - *250 - *73 - - *252 + - *251 responses: '204': description: Response @@ -38885,10 +41444,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: + - *248 - *249 - - *250 - *73 - - *252 + - *251 responses: '204': description: Response @@ -38918,7 +41477,7 @@ paths: - *73 - *17 - *19 - - &254 + - &253 name: sort description: The property by which to sort the results. in: query @@ -38929,7 +41488,7 @@ paths: - created_at default: created_at - *59 - - &255 + - &254 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -38941,7 +41500,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &256 + - &255 name: repository description: The name of the repository to use to filter the results. in: query @@ -38950,7 +41509,7 @@ paths: type: string examples: - Hello-World - - &257 + - &256 name: permission description: The permission to use to filter the results. in: query @@ -38959,7 +41518,7 @@ paths: type: string examples: - issues_read - - &258 + - &257 name: last_used_before description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -38969,7 +41528,7 @@ paths: schema: type: string format: date-time - - &259 + - &258 name: last_used_after description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -38979,7 +41538,7 @@ paths: schema: type: string format: date-time - - &260 + - &259 name: token_id description: The ID of the token in: query @@ -39255,7 +41814,7 @@ paths: '422': *15 '404': *6 '403': *27 - '204': *184 + '204': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39296,9 +41855,9 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: - default: *253 + default: *252 headers: Link: *65 x-github: @@ -39324,14 +41883,14 @@ paths: - *73 - *17 - *19 - - *254 + - *253 - *59 + - *254 - *255 - *256 - *257 - *258 - *259 - - *260 responses: '500': *53 '422': *15 @@ -39572,7 +42131,7 @@ paths: responses: '500': *53 '404': *6 - '204': *184 + '204': *183 '403': *27 '422': *15 x-github: @@ -39613,9 +42172,9 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: - default: *253 + default: *252 headers: Link: *65 x-github: @@ -39657,7 +42216,7 @@ paths: type: integer configurations: type: array - items: &261 + items: &260 title: Organization private registry description: Private registry configuration for an organization type: object @@ -40091,7 +42650,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &262 + org-private-registry-with-selected-visibility: &261 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -40183,15 +42742,15 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - *73 - - *161 + - *160 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *261 + schema: *260 examples: - default: *262 + default: *261 '404': *6 x-github: githubCloudOnly: false @@ -40214,7 +42773,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - *73 - - *161 + - *160 requestBody: required: true content: @@ -40379,7 +42938,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - *73 - - *161 + - *160 responses: '204': description: Response @@ -40419,7 +42978,7 @@ paths: application/json: schema: type: array - items: &263 + items: &262 title: Projects v2 Project description: A projects v2 project type: object @@ -40493,7 +43052,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &750 + - &749 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -40578,7 +43137,7 @@ paths: - deleted_at - deleted_by examples: - default: &264 + default: &263 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -40681,7 +43240,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &265 + - &264 name: project_number description: The project's number. in: path @@ -40694,9 +43253,9 @@ paths: description: Response content: application/json: - schema: *263 + schema: *262 examples: - default: *264 + default: *263 headers: Link: *65 '304': *35 @@ -40719,7 +43278,7 @@ paths: url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - *73 - - *265 + - *264 requestBody: required: true description: Details of the draft item to create in the project. @@ -40753,7 +43312,7 @@ paths: description: Response content: application/json: - schema: &270 + schema: &269 title: Projects v2 Item description: An item belonging to a project type: object @@ -40767,7 +43326,7 @@ paths: content: oneOf: - *81 - - &460 + - &459 title: Pull Request Simple description: Pull Request Simple type: object @@ -40887,7 +43446,7 @@ paths: milestone: anyOf: - type: 'null' - - *266 + - *265 active_lock_reason: type: - string @@ -40936,7 +43495,7 @@ paths: items: *4 requested_teams: type: array - items: *188 + items: *187 head: type: object properties: @@ -40980,7 +43539,7 @@ paths: _links: type: object properties: - comments: &267 + comments: &266 title: Link description: Hypermedia Link type: object @@ -40989,13 +43548,13 @@ paths: type: string required: - href - commits: *267 - statuses: *267 - html: *267 - issue: *267 - review_comments: *267 - review_comment: *267 - self: *267 + commits: *266 + statuses: *266 + html: *266 + issue: *266 + review_comments: *266 + review_comment: *266 + self: *266 required: - comments - commits @@ -41006,7 +43565,7 @@ paths: - review_comment - self author_association: *78 - auto_merge: &562 + auto_merge: &561 title: Auto merge description: The status of auto merging a pull request. type: @@ -41108,7 +43667,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &269 + content_type: &268 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -41152,7 +43711,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &271 + draft_issue: &270 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -41226,7 +43785,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *265 + - *264 - *73 - *17 - *45 @@ -41238,7 +43797,7 @@ paths: application/json: schema: type: array - items: &268 + items: &267 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -41391,7 +43950,7 @@ paths: - updated_at - project_url examples: - default: &686 + default: &685 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -41521,7 +44080,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project parameters: - - *265 + - *264 - *73 requestBody: required: true @@ -41568,7 +44127,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &687 + items: &686 type: object properties: name: @@ -41605,7 +44164,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &688 + iteration_configuration: &687 type: object description: The configuration for iteration fields. properties: @@ -41655,7 +44214,7 @@ paths: value: name: Due date data_type: date - single_select_field: &689 + single_select_field: &688 summary: Create a single select field value: name: Priority @@ -41682,7 +44241,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &690 + iteration_field: &689 summary: Create an iteration field value: name: Sprint @@ -41706,9 +44265,9 @@ paths: description: Response for adding a field to an organization-owned project. content: application/json: - schema: *268 + schema: *267 examples: - text_field: &691 + text_field: &690 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -41717,7 +44276,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: &692 + number_field: &691 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -41726,7 +44285,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: &693 + date_field: &692 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -41735,7 +44294,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: &694 + single_select_field: &693 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -41769,7 +44328,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &695 + iteration_field: &694 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -41814,8 +44373,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *265 - - &696 + - *264 + - &695 name: field_id description: The unique identifier of the field. in: path @@ -41828,9 +44387,9 @@ paths: description: Response content: application/json: - schema: *268 + schema: *267 examples: - default: &697 + default: &696 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -41886,7 +44445,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *265 + - *264 - *73 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) @@ -41919,7 +44478,7 @@ paths: application/json: schema: type: array - items: &272 + items: &271 title: Projects v2 Item description: An item belonging to a project type: object @@ -41936,7 +44495,7 @@ paths: description: The API URL of the project that contains this item. examples: - https://api.github.com/users/monalisa/2/projectsV2/3 - content_type: *269 + content_type: *268 content: type: - object @@ -41986,7 +44545,7 @@ paths: - updated_at - archived_at examples: - default: &273 + default: &272 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -42684,7 +45243,7 @@ paths: url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - *73 - - *265 + - *264 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -42754,22 +45313,22 @@ paths: description: Response content: application/json: - schema: *270 + schema: *269 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *271 + value: *270 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *271 + value: *270 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *271 + value: *270 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *271 + value: *270 '304': *35 '403': *27 '401': *23 @@ -42789,9 +45348,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *265 + - *264 - *73 - - &274 + - &273 name: item_id description: The unique identifier of the project item. in: path @@ -42817,9 +45376,9 @@ paths: description: Response content: application/json: - schema: *272 + schema: *271 examples: - default: *273 + default: *272 headers: Link: *65 '304': *35 @@ -42840,9 +45399,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *265 + - *264 - *73 - - *274 + - *273 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -42915,13 +45474,13 @@ paths: description: Response content: application/json: - schema: *272 + schema: *271 examples: - text_field: *273 - number_field: *273 - date_field: *273 - single_select_field: *273 - iteration_field: *273 + text_field: *272 + number_field: *272 + date_field: *272 + single_select_field: *272 + iteration_field: *272 '401': *23 '403': *27 '404': *6 @@ -42941,9 +45500,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *265 + - *264 - *73 - - *274 + - *273 responses: '204': description: Response @@ -42967,7 +45526,7 @@ paths: url: https://docs.github.com/rest/projects/views#create-a-view-for-an-organization-owned-project parameters: - *73 - - *265 + - *264 requestBody: required: true content: @@ -43041,7 +45600,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &678 + schema: &677 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -43145,7 +45704,7 @@ paths: examples: table_view: summary: Response for creating a table view - value: &275 + value: &274 value: id: 1 number: 1 @@ -43191,10 +45750,10 @@ paths: - 456 board_view: summary: Response for creating a board view with filter - value: *275 + value: *274 roadmap_view: summary: Response for creating a roadmap view - value: *275 + value: *274 '304': *35 '403': *27 '401': *23 @@ -43222,9 +45781,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-project-view parameters: - - *265 + - *264 - *73 - - &698 + - &697 name: view_number description: The number that identifies the project view. in: path @@ -43256,9 +45815,9 @@ paths: application/json: schema: type: array - items: *272 + items: *271 examples: - default: *273 + default: *272 headers: Link: *65 '304': *35 @@ -43291,7 +45850,7 @@ paths: application/json: schema: type: array - items: &276 + items: &275 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -43369,7 +45928,7 @@ paths: - property_name - value_type examples: - default: &277 + default: &276 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -43429,7 +45988,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *276 + items: *275 minItems: 1 maxItems: 100 required: @@ -43459,9 +46018,9 @@ paths: application/json: schema: type: array - items: *276 + items: *275 examples: - default: *277 + default: *276 '403': *27 '404': *6 x-github: @@ -43483,7 +46042,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - *73 - - &278 + - &277 name: custom_property_name description: The custom property name in: path @@ -43495,9 +46054,9 @@ paths: description: Response content: application/json: - schema: *276 + schema: *275 examples: - default: &279 + default: &278 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -43532,7 +46091,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - *73 - - *278 + - *277 requestBody: required: true content: @@ -43612,9 +46171,9 @@ paths: description: Response content: application/json: - schema: *276 + schema: *275 examples: - default: *279 + default: *278 '403': *27 '404': *6 x-github: @@ -43638,9 +46197,9 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - *73 - - *278 + - *277 responses: - '204': *184 + '204': *183 '403': *27 '404': *6 x-github: @@ -43702,7 +46261,7 @@ paths: - octocat/Hello-World properties: type: array - items: &280 + items: &279 title: Custom Property Value description: Custom property name and associated value type: object @@ -43792,7 +46351,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *280 + items: *279 required: - repository_names - properties @@ -43982,9 +46541,9 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: - default: *253 + default: *252 headers: Link: *65 x-github: @@ -44187,7 +46746,7 @@ paths: description: Response content: application/json: - schema: &328 + schema: &327 title: Full Repository description: Full Repository type: object @@ -44665,7 +47224,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &465 + code_of_conduct: &464 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -44695,7 +47254,7 @@ paths: - key - name - html_url - security_and_analysis: *281 + security_and_analysis: *280 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -44779,7 +47338,7 @@ paths: - network_count - subscribers_count examples: - default: &330 + default: &329 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -45300,7 +47859,7 @@ paths: - *73 - *17 - *19 - - &584 + - &583 name: targets description: | A comma-separated list of rule targets to filter by. @@ -45319,7 +47878,7 @@ paths: application/json: schema: type: array - items: &308 + items: &307 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -45354,7 +47913,7 @@ paths: source: type: string description: The name of the source - enforcement: &284 + enforcement: &283 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -45367,7 +47926,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &285 + items: &284 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -45438,7 +47997,7 @@ paths: description: The html URL of the ruleset conditions: anyOf: - - &282 + - &281 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -45462,7 +48021,7 @@ paths: match. items: type: string - - &286 + - &285 title: Organization ruleset conditions type: object description: |- @@ -45476,7 +48035,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *282 + - *281 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -45510,7 +48069,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *282 + - *281 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -45532,7 +48091,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *282 + - *281 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -45545,7 +48104,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &283 + items: &282 title: Repository ruleset property targeting definition type: object @@ -45578,7 +48137,7 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *283 + items: *282 required: - repository_property type: @@ -45586,12 +48145,12 @@ paths: - object rules: type: array - items: &585 + items: &584 title: Repository Rule type: object description: A repository rule. oneOf: - - &287 + - &286 title: creation description: Only allow users with bypass permission to create matching refs. @@ -45603,7 +48162,7 @@ paths: type: string enum: - creation - - &288 + - &287 title: update description: Only allow users with bypass permission to update matching refs. @@ -45624,7 +48183,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &289 + - &288 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -45636,7 +48195,7 @@ paths: type: string enum: - deletion - - &290 + - &289 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -45648,7 +48207,7 @@ paths: type: string enum: - required_linear_history - - &583 + - &582 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -45726,7 +48285,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &291 + - &290 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -45750,7 +48309,7 @@ paths: type: string required: - required_deployment_environments - - &292 + - &291 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -45762,7 +48321,7 @@ paths: type: string enum: - required_signatures - - &293 + - &292 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -45868,7 +48427,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &294 + - &293 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -45916,7 +48475,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &295 + - &294 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -45928,7 +48487,7 @@ paths: type: string enum: - non_fast_forward - - &296 + - &295 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -45965,7 +48524,7 @@ paths: required: - operator - pattern - - &297 + - &296 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -46002,7 +48561,7 @@ paths: required: - operator - pattern - - &298 + - &297 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -46039,7 +48598,7 @@ paths: required: - operator - pattern - - &299 + - &298 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -46076,7 +48635,7 @@ paths: required: - operator - pattern - - &300 + - &299 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -46113,7 +48672,7 @@ paths: required: - operator - pattern - - &301 + - &300 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -46138,7 +48697,7 @@ paths: type: string required: - restricted_file_paths - - &302 + - &301 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -46162,7 +48721,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &303 + - &302 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -46185,7 +48744,7 @@ paths: type: string required: - restricted_file_extensions - - &304 + - &303 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -46210,7 +48769,7 @@ paths: maximum: 100 required: - max_file_size - - &305 + - &304 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -46260,7 +48819,7 @@ paths: - repository_id required: - workflows - - &306 + - &305 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -46321,7 +48880,7 @@ paths: - tool required: - code_scanning_tools - - &307 + - &306 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -46420,20 +48979,21 @@ paths: - push - repository default: branch - enforcement: *284 + enforcement: *283 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *285 - conditions: *286 + items: *284 + conditions: *285 rules: type: array description: An array of rules within the ruleset. - items: &310 + items: &309 title: Repository Rule type: object description: A repository rule. oneOf: + - *286 - *287 - *288 - *289 @@ -46454,7 +49014,6 @@ paths: - *304 - *305 - *306 - - *307 required: - name - enforcement @@ -46492,9 +49051,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *307 examples: - default: &309 + default: &308 value: id: 21 name: super cool ruleset @@ -46550,7 +49109,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *73 - - &586 + - &585 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 @@ -46565,7 +49124,7 @@ paths: in: query schema: type: string - - &587 + - &586 name: time_period description: |- The time period to filter by. @@ -46581,14 +49140,14 @@ paths: - week - month default: day - - &588 + - &587 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 - - &589 + - &588 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -46608,7 +49167,7 @@ paths: description: Response content: application/json: - schema: &590 + schema: &589 title: Rule Suites description: Response type: array @@ -46664,7 +49223,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &591 + default: &590 value: - id: 21 actor_id: 12 @@ -46708,7 +49267,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *73 - - &592 + - &591 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -46724,7 +49283,7 @@ paths: description: Response content: application/json: - schema: &593 + schema: &592 title: Rule Suite description: Response type: object @@ -46831,7 +49390,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &594 + default: &593 value: id: 21 actor_id: 12 @@ -46904,9 +49463,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *307 examples: - default: *309 + default: *308 '404': *6 '500': *53 put: @@ -46950,16 +49509,16 @@ paths: - tag - push - repository - enforcement: *284 + enforcement: *283 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *285 - conditions: *286 + items: *284 + conditions: *285 rules: description: An array of rules within the ruleset. type: array - items: *310 + items: *309 examples: default: value: @@ -46994,9 +49553,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *307 examples: - default: *309 + default: *308 '404': *6 '422': *15 '500': *53 @@ -47054,7 +49613,7 @@ paths: application/json: schema: type: array - items: &311 + items: &310 title: Ruleset version type: object description: The historical version of a ruleset @@ -47078,7 +49637,7 @@ paths: type: string format: date-time examples: - default: &596 + default: &595 value: - version_id: 3 actor: @@ -47131,9 +49690,9 @@ paths: description: Response content: application/json: - schema: &597 + schema: &596 allOf: - - *311 + - *310 - type: object required: - state @@ -47203,7 +49762,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *73 - - &598 + - &597 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -47214,7 +49773,7 @@ paths: enum: - open - resolved - - &599 + - &598 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -47224,7 +49783,7 @@ paths: required: false schema: type: string - - &600 + - &599 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -47233,7 +49792,7 @@ paths: required: false schema: type: string - - &601 + - &600 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -47252,7 +49811,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &602 + - &601 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -47267,7 +49826,7 @@ paths: - *59 - *19 - *17 - - &603 + - &602 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 events before this cursor. To @@ -47277,7 +49836,7 @@ paths: required: false schema: type: string - - &604 + - &603 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 events after this cursor. To @@ -47287,7 +49846,7 @@ paths: required: false schema: type: string - - &605 + - &604 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -47296,7 +49855,7 @@ paths: required: false schema: type: string - - &606 + - &605 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -47305,7 +49864,7 @@ paths: schema: type: boolean default: false - - &607 + - &606 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -47314,7 +49873,7 @@ paths: schema: type: boolean default: false - - &608 + - &607 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -47333,27 +49892,27 @@ paths: items: type: object properties: - number: *171 - created_at: *172 + number: *170 + created_at: *171 updated_at: anyOf: - type: 'null' - - *173 - url: *174 - html_url: *175 + - *172 + url: *173 + html_url: *174 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &609 + state: &608 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: &610 + resolution: &609 type: - string - 'null' @@ -47460,14 +50019,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &611 + - &610 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &613 + - &612 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -47514,6 +50073,13 @@ paths: type: string description: The API URL to get the associated commit resource + html_url: + type: string + format: uri + description: The GitHub URL to get the associated commit + resource. + examples: + - https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1 required: - path - start_line @@ -47524,7 +50090,7 @@ paths: - blob_url - commit_sha - commit_url - - &614 + - &613 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. @@ -47585,7 +50151,7 @@ paths: - page_url - commit_sha - commit_url - - &615 + - &614 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -47598,9 +50164,16 @@ paths: secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/1347 + html_url: + type: string + format: uri + description: The GitHub URL for the issue where the + secret was detected. + examples: + - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &616 + - &615 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -47613,9 +50186,16 @@ paths: secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/1347 + html_url: + type: string + format: uri + description: The GitHub URL for the issue where the + secret was detected. + examples: + - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &617 + - &616 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -47628,9 +50208,16 @@ paths: the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + html_url: + type: string + format: uri + description: The GitHub URL for the issue comment where + the secret was detected. + examples: + - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &618 + - &617 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -47645,7 +50232,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &619 + - &618 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -47660,7 +50247,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &620 + - &619 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -47675,7 +50262,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &621 + - &620 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. @@ -47688,9 +50275,16 @@ paths: the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request where + the secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &622 + - &621 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. @@ -47703,9 +50297,16 @@ paths: the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request where + the secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &623 + - &622 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. @@ -47718,9 +50319,16 @@ paths: where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request comment + where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &624 + - &623 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. @@ -47733,9 +50341,16 @@ paths: where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request review + where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &625 + - &624 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 @@ -47749,6 +50364,13 @@ paths: comment where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request review + comment where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846#discussion_r12 required: - pull_request_review_comment_url has_more_locations: @@ -47975,7 +50597,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &313 + pattern_config_version: &312 type: - string - 'null' @@ -47985,7 +50607,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &312 + items: &311 type: object properties: token_type: @@ -48054,7 +50676,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *312 + items: *311 examples: default: value: @@ -48111,7 +50733,7 @@ paths: schema: type: object properties: - pattern_config_version: *313 + pattern_config_version: *312 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -48137,7 +50759,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *313 + custom_pattern_version: *312 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -48235,7 +50857,7 @@ paths: application/json: schema: type: array - items: &629 + items: &628 description: A repository security advisory. type: object properties: @@ -48479,7 +51101,7 @@ paths: login: type: string description: The username of the user credited. - type: *314 + type: *313 credits_detailed: type: - array @@ -48490,7 +51112,7 @@ paths: type: object properties: user: *4 - type: *314 + type: *313 state: type: string description: The state of the user's acceptance of the @@ -48516,7 +51138,7 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *188 + items: *187 private_fork: readOnly: true description: A temporary private fork of the advisory's repository @@ -48554,7 +51176,7 @@ paths: - private_fork additionalProperties: false examples: - default: &630 + default: &629 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -48941,7 +51563,7 @@ paths: application/json: schema: type: array - items: *245 + items: *244 examples: default: value: @@ -49161,9 +51783,9 @@ paths: type: integer repositories: type: array - items: *153 + items: *152 examples: - default: *165 + default: *164 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49232,7 +51854,7 @@ paths: url: https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *73 - - *142 + - *141 responses: '204': description: Response @@ -49255,7 +51877,7 @@ paths: url: https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *73 - - *142 + - *141 responses: '204': description: Response @@ -49296,7 +51918,7 @@ paths: type: integer network_configurations: type: array - items: &315 + items: &314 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -49421,6 +52043,19 @@ paths: must be specified in the list. items: type: string + failover_network_settings_ids: + type: array + minItems: 0 + maxItems: 1 + description: A list of identifiers of the failover network settings + resources to use for the network configuration. Exactly one resource + identifier must be specified in the list. + items: + type: string + failover_network_enabled: + type: boolean + description: Indicates whether the failover network resource is + enabled. required: - name - network_settings_ids @@ -49436,9 +52071,9 @@ paths: description: Response content: application/json: - schema: *315 + schema: *314 examples: - default: &316 + default: &315 value: id: 123456789ABCDEF name: My network configuration @@ -49467,7 +52102,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - *73 - - &317 + - &316 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -49479,9 +52114,9 @@ paths: description: Response content: application/json: - schema: *315 + schema: *314 examples: - default: *316 + default: *315 headers: Link: *65 x-github: @@ -49503,7 +52138,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - *73 - - *317 + - *316 requestBody: required: true content: @@ -49531,6 +52166,19 @@ paths: must be specified in the list. items: type: string + failover_network_settings_ids: + type: array + minItems: 0 + maxItems: 1 + description: A list of identifiers of the failover network settings + resources to use for the network configuration. Exactly one resource + identifier must be specified in the list. + items: + type: string + failover_network_enabled: + type: boolean + description: Indicates whether the failover network resource is + enabled. examples: default: value: @@ -49543,9 +52191,9 @@ paths: description: Response content: application/json: - schema: *315 + schema: *314 examples: - default: *316 + default: *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49565,7 +52213,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - *73 - - *317 + - *316 responses: '204': description: Response @@ -49710,13 +52358,13 @@ paths: application/json: schema: type: array - items: *318 + items: *317 examples: - default: *319 + default: *318 '500': *53 '403': *27 '404': *6 - '422': *320 + '422': *319 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49756,9 +52404,9 @@ paths: application/json: schema: type: array - items: *188 + items: *187 examples: - default: *246 + default: *245 headers: Link: *65 '403': *27 @@ -49852,7 +52500,7 @@ paths: description: Response content: application/json: - schema: &321 + schema: &320 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -49926,7 +52574,7 @@ paths: parent: anyOf: - type: 'null' - - *245 + - *244 members_count: type: integer examples: @@ -50251,7 +52899,7 @@ paths: - repos_count - organization examples: - default: &322 + default: &321 value: id: 1 node_id: MDQ6VGVhbTE= @@ -50328,9 +52976,9 @@ paths: description: Response content: application/json: - schema: *321 + schema: *320 examples: - default: *322 + default: *321 '404': *6 x-github: githubCloudOnly: false @@ -50415,16 +53063,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *321 + schema: *320 examples: - default: *322 + default: *321 '201': description: Response content: application/json: - schema: *321 + schema: *320 examples: - default: *322 + default: *321 '404': *6 '422': *15 '403': *27 @@ -50454,7 +53102,7 @@ paths: responses: '204': description: Response - '422': &323 + '422': &322 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -50488,12 +53136,12 @@ paths: application/json: schema: type: array - items: *224 + items: *223 examples: - default: *225 + default: *224 headers: Link: *65 - '422': *323 + '422': *322 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50575,7 +53223,7 @@ paths: description: Response content: application/json: - schema: &324 + schema: &323 title: Team Membership description: Team Membership type: object @@ -50603,7 +53251,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &646 + response-if-user-is-a-team-maintainer: &645 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -50666,9 +53314,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *323 examples: - response-if-users-membership-with-team-is-now-pending: &647 + response-if-users-membership-with-team-is-now-pending: &646 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -50742,9 +53390,9 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: - default: *253 + default: *252 headers: Link: *65 x-github: @@ -50775,14 +53423,14 @@ paths: parameters: - *73 - *75 + - *324 - *325 - - *326 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &648 + schema: &647 title: Team Repository description: A team's access to a repository. type: object @@ -51425,8 +54073,8 @@ paths: parameters: - *73 - *75 + - *324 - *325 - - *326 requestBody: required: false content: @@ -51473,8 +54121,8 @@ paths: parameters: - *73 - *75 + - *324 - *325 - - *326 responses: '204': description: Response @@ -51509,9 +54157,9 @@ paths: application/json: schema: type: array - items: *188 + items: *187 examples: - response-if-child-teams-exist: &649 + response-if-child-teams-exist: &648 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -51665,7 +54313,7 @@ paths: resources: type: object properties: - core: &327 + core: &326 title: Rate Limit type: object properties: @@ -51682,21 +54330,21 @@ paths: - remaining - reset - used - graphql: *327 - search: *327 - code_search: *327 - source_import: *327 - integration_manifest: *327 - code_scanning_upload: *327 - actions_runner_registration: *327 - scim: *327 - dependency_snapshots: *327 - dependency_sbom: *327 - code_scanning_autofix: *327 + graphql: *326 + search: *326 + code_search: *326 + source_import: *326 + integration_manifest: *326 + code_scanning_upload: *326 + actions_runner_registration: *326 + scim: *326 + dependency_snapshots: *326 + dependency_sbom: *326 + code_scanning_autofix: *326 required: - core - search - rate: *327 + rate: *326 required: - rate - resources @@ -51801,14 +54449,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *328 + schema: *327 examples: default-response: summary: Default response @@ -52313,7 +54961,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *329 + '301': *328 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52331,8 +54979,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: false content: @@ -52624,10 +55272,10 @@ paths: description: Response content: application/json: - schema: *328 + schema: *327 examples: - default: *330 - '307': &331 + default: *329 + '307': &330 description: Temporary Redirect content: application/json: @@ -52656,8 +55304,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -52679,7 +55327,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *331 + '307': *330 '404': *6 '409': *52 x-github: @@ -52703,11 +55351,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: + - *324 - *325 - - *326 - *17 - *19 - - &364 + - &363 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -52730,7 +55378,7 @@ paths: type: integer artifacts: type: array - items: &332 + items: &331 title: Artifact description: An artifact type: object @@ -52825,7 +55473,7 @@ paths: - expires_at - updated_at examples: - default: &365 + default: &364 value: total_count: 2 artifacts: @@ -52886,9 +55534,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: + - *324 - *325 - - *326 - - &333 + - &332 name: artifact_id description: The unique identifier of the artifact. in: path @@ -52900,7 +55548,7 @@ paths: description: Response content: application/json: - schema: *332 + schema: *331 examples: default: value: @@ -52938,9 +55586,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: + - *324 - *325 - - *326 - - *333 + - *332 responses: '204': description: Response @@ -52964,9 +55612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: + - *324 - *325 - - *326 - - *333 + - *332 - name: archive_format in: path required: true @@ -52980,7 +55628,7 @@ paths: 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': &520 + '410': &519 description: Gone content: application/json: @@ -53005,14 +55653,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: &334 + schema: &333 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -53046,13 +55694,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: application/json: - schema: *334 + schema: *333 examples: selected_actions: *40 responses: @@ -53081,14 +55729,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: &335 + schema: &334 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -53122,13 +55770,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: application/json: - schema: *335 + schema: *334 examples: selected_actions: *42 responses: @@ -53159,14 +55807,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *336 + schema: *335 examples: default: value: @@ -53192,11 +55840,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: + - *324 - *325 - - *326 - *17 - *19 - - &337 + - &336 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 @@ -53230,7 +55878,7 @@ paths: description: Response content: application/json: - schema: &338 + schema: &337 title: Repository actions caches description: Repository actions caches type: object @@ -53280,7 +55928,7 @@ paths: - total_count - actions_caches examples: - default: &339 + default: &338 value: total_count: 1 actions_caches: @@ -53312,23 +55960,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: + - *324 - *325 - - *326 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *337 + - *336 responses: '200': description: Response content: application/json: - schema: *338 + schema: *337 examples: - default: *339 + default: *338 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53348,8 +55996,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: + - *324 - *325 - - *326 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -53380,9 +56028,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: + - *324 - *325 - - *326 - - &340 + - &339 name: job_id description: The unique identifier of the job. in: path @@ -53394,7 +56042,7 @@ paths: description: Response content: application/json: - schema: &368 + schema: &367 title: Job description: Information of a job execution in a workflow run type: object @@ -53741,9 +56389,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: + - *324 - *325 - - *326 - - *340 + - *339 responses: '302': description: Response @@ -53771,9 +56419,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: + - *324 - *325 - - *326 - - *340 + - *339 requestBody: required: false content: @@ -53795,7 +56443,7 @@ paths: description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -53819,8 +56467,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Status response @@ -53870,8 +56518,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -53905,7 +56553,7 @@ paths: description: Empty response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -53934,8 +56582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -53953,7 +56601,7 @@ paths: type: integer secrets: type: array - items: &370 + items: &369 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -53974,7 +56622,7 @@ paths: - created_at - updated_at examples: - default: &371 + default: &370 value: total_count: 2 secrets: @@ -54007,9 +56655,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: + - *324 - *325 - - *326 - - *341 + - *340 - *19 responses: '200': @@ -54026,7 +56674,7 @@ paths: type: integer variables: type: array - items: &374 + items: &373 title: Actions Variable type: object properties: @@ -54060,7 +56708,7 @@ paths: - created_at - updated_at examples: - default: &375 + default: &374 value: total_count: 2 variables: @@ -54093,8 +56741,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -54103,12 +56751,12 @@ paths: schema: type: object properties: - enabled: &343 + enabled: &342 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *138 - selected_actions_url: *342 - sha_pinning_required: *139 + allowed_actions: *137 + selected_actions_url: *341 + sha_pinning_required: *138 required: - enabled examples: @@ -54136,8 +56784,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -54148,9 +56796,9 @@ paths: schema: type: object properties: - enabled: *343 - allowed_actions: *138 - sha_pinning_required: *139 + enabled: *342 + allowed_actions: *137 + sha_pinning_required: *138 required: - enabled examples: @@ -54180,14 +56828,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: &344 + schema: &343 type: object properties: access_level: @@ -54204,7 +56852,7 @@ paths: required: - access_level examples: - default: &345 + default: &344 value: access_level: organization x-github: @@ -54228,15 +56876,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: application/json: - schema: *344 + schema: *343 examples: - default: *345 + default: *344 responses: '204': description: Response @@ -54260,14 +56908,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *346 + schema: *345 examples: default: value: @@ -54291,8 +56939,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: + - *324 - *325 - - *326 responses: '204': description: Empty response for successful settings update @@ -54302,7 +56950,7 @@ paths: required: true content: application/json: - schema: *347 + schema: *346 examples: default: summary: Set retention days @@ -54326,16 +56974,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *140 + schema: *139 examples: - default: *348 + default: *347 '404': *6 x-github: enabledForGitHubApps: true @@ -54354,8 +57002,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -54365,7 +57013,7 @@ paths: required: true content: application/json: - schema: *140 + schema: *139 examples: default: summary: Set approval policy to first time contributors @@ -54389,16 +57037,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *349 + schema: *348 examples: - default: *141 + default: *140 '403': *27 '404': *6 x-github: @@ -54418,15 +57066,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: application/json: - schema: *350 + schema: *349 examples: - default: *141 + default: *140 responses: '204': description: Empty response for successful settings update @@ -54450,16 +57098,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *143 + schema: *142 examples: - default: *144 + default: *143 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -54478,8 +57126,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -54487,9 +57135,9 @@ paths: required: false content: application/json: - schema: *143 + schema: *142 examples: - selected_actions: *144 + selected_actions: *143 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -54511,16 +57159,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *351 + schema: *350 examples: - default: *148 + default: *147 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54541,8 +57189,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: + - *324 - *325 - - *326 responses: '204': description: Success response @@ -54553,9 +57201,9 @@ paths: required: true content: application/json: - schema: *352 + schema: *351 examples: - default: *148 + default: *147 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54582,8 +57230,8 @@ paths: in: query schema: type: string + - *324 - *325 - - *326 - *17 - *19 responses: @@ -54601,9 +57249,9 @@ paths: type: integer runners: type: array - items: *155 + items: *154 examples: - default: *156 + default: *155 headers: Link: *65 x-github: @@ -54627,8 +57275,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -54636,9 +57284,9 @@ paths: application/json: schema: type: array - items: *353 + items: *352 examples: - default: *354 + default: *353 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54660,8 +57308,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -54704,7 +57352,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *355 + '201': *354 '404': *6 '422': *7 '409': *52 @@ -54735,16 +57383,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: + - *324 - *325 - - *326 responses: '201': description: Response content: application/json: - schema: *157 + schema: *156 examples: - default: *356 + default: *355 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54772,16 +57420,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: + - *324 - *325 - - *326 responses: '201': description: Response content: application/json: - schema: *157 + schema: *156 examples: - default: *357 + default: *356 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54803,17 +57451,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: + - *324 - *325 - - *326 - - *154 + - *153 responses: '200': description: Response content: application/json: - schema: *155 + schema: *154 examples: - default: *358 + default: *357 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54834,9 +57482,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: + - *324 - *325 - - *326 - - *154 + - *153 responses: '204': description: Response @@ -54862,11 +57510,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: + - *324 - *325 - - *326 - - *154 + - *153 responses: - '200': *159 + '200': *158 '404': *6 x-github: githubCloudOnly: false @@ -54888,9 +57536,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: + - *324 - *325 - - *326 - - *154 + - *153 requestBody: required: true content: @@ -54914,7 +57562,7 @@ paths: - gpu - accelerated responses: - '200': *159 + '200': *158 '404': *6 '422': *7 x-github: @@ -54938,9 +57586,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: + - *324 - *325 - - *326 - - *154 + - *153 requestBody: required: true content: @@ -54965,7 +57613,7 @@ paths: - gpu - accelerated responses: - '200': *159 + '200': *158 '404': *6 '422': *7 x-github: @@ -54989,11 +57637,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: + - *324 - *325 - - *326 - - *154 + - *153 responses: - '200': *359 + '200': *358 '404': *6 x-github: githubCloudOnly: false @@ -55020,12 +57668,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: + - *324 - *325 - - *326 - - *154 - - *360 + - *153 + - *359 responses: - '200': *159 + '200': *158 '404': *6 '422': *7 x-github: @@ -55051,9 +57699,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: + - *324 - *325 - - *326 - - &378 + - &377 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. @@ -55061,7 +57709,7 @@ paths: required: false schema: type: string - - &379 + - &378 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -55069,7 +57717,7 @@ paths: required: false schema: type: string - - &380 + - &379 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -55078,7 +57726,7 @@ paths: required: false schema: type: string - - &381 + - &380 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 @@ -55105,7 +57753,7 @@ paths: - pending - *17 - *19 - - &382 + - &381 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/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -55114,7 +57762,7 @@ paths: schema: type: string format: date-time - - &361 + - &360 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -55123,13 +57771,13 @@ paths: schema: type: boolean default: false - - &383 + - &382 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &384 + - &383 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -55152,7 +57800,7 @@ paths: type: integer workflow_runs: type: array - items: &362 + items: &361 title: Workflow Run description: An invocation of a workflow type: object @@ -55330,7 +57978,7 @@ paths: head_commit: anyOf: - type: 'null' - - &406 + - &405 title: Simple Commit description: A commit. type: object @@ -55404,8 +58052,8 @@ paths: - timestamp - author - committer - repository: *153 - head_repository: *153 + repository: *152 + head_repository: *152 head_repository_id: type: integer examples: @@ -55445,7 +58093,7 @@ paths: - workflow_url - pull_requests examples: - default: &385 + default: &384 value: total_count: 1 workflow_runs: @@ -55681,24 +58329,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: + - *324 - *325 - - *326 - - &363 + - &362 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *361 + - *360 responses: '200': description: Response content: application/json: - schema: *362 + schema: *361 examples: - default: &366 + default: &365 value: id: 30433642 name: Build @@ -55939,9 +58587,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: + - *324 - *325 - - *326 - - *363 + - *362 responses: '204': description: Response @@ -55964,9 +58612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: + - *324 - *325 - - *326 - - *363 + - *362 responses: '200': description: Response @@ -56094,15 +58742,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: + - *324 - *325 - - *326 - - *363 + - *362 responses: '201': description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -56129,12 +58777,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: + - *324 - *325 - - *326 - - *363 + - *362 - *17 - *19 - - *364 + - *363 - *59 responses: '200': @@ -56151,9 +58799,9 @@ paths: type: integer artifacts: type: array - items: *332 + items: *331 examples: - default: *365 + default: *364 headers: Link: *65 x-github: @@ -56177,25 +58825,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: + - *324 - *325 - - *326 - - *363 - - &367 + - *362 + - &366 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *361 + - *360 responses: '200': description: Response content: application/json: - schema: *362 + schema: *361 examples: - default: *366 + default: *365 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56218,10 +58866,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: + - *324 - *325 - - *326 - - *363 - - *367 + - *362 + - *366 - *17 - *19 responses: @@ -56239,9 +58887,9 @@ paths: type: integer jobs: type: array - items: *368 + items: *367 examples: - default: &369 + default: &368 value: total_count: 1 jobs: @@ -56354,10 +59002,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: + - *324 - *325 - - *326 - - *363 - - *367 + - *362 + - *366 responses: '302': description: Response @@ -56385,15 +59033,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: + - *324 - *325 - - *326 - - *363 + - *362 responses: '202': description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -56420,9 +59068,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: + - *324 - *325 - - *326 - - *363 + - *362 requestBody: required: true content: @@ -56489,15 +59137,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: + - *324 - *325 - - *326 - - *363 + - *362 responses: '202': description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -56524,9 +59172,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: + - *324 - *325 - - *326 - - *363 + - *362 - 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 @@ -56556,9 +59204,9 @@ paths: type: integer jobs: type: array - items: *368 + items: *367 examples: - default: *369 + default: *368 headers: Link: *65 x-github: @@ -56583,9 +59231,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: + - *324 - *325 - - *326 - - *363 + - *362 responses: '302': description: Response @@ -56612,9 +59260,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: + - *324 - *325 - - *326 - - *363 + - *362 responses: '204': description: Response @@ -56641,9 +59289,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: + - *324 - *325 - - *326 - - *363 + - *362 responses: '200': description: Response @@ -56712,7 +59360,7 @@ paths: items: type: object properties: - type: &486 + type: &485 type: string description: The type of reviewer. enum: @@ -56723,7 +59371,7 @@ paths: reviewer: anyOf: - *4 - - *188 + - *187 required: - environment - wait_timer @@ -56798,9 +59446,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: + - *324 - *325 - - *326 - - *363 + - *362 requestBody: required: true content: @@ -56850,7 +59498,7 @@ paths: application/json: schema: type: array - items: &481 + items: &480 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -56962,7 +59610,7 @@ paths: - created_at - updated_at examples: - default: &482 + default: &481 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -57018,9 +59666,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: + - *324 - *325 - - *326 - - *363 + - *362 requestBody: required: false content: @@ -57042,7 +59690,7 @@ paths: description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -57065,9 +59713,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: + - *324 - *325 - - *326 - - *363 + - *362 requestBody: required: false content: @@ -57089,7 +59737,7 @@ paths: description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -57121,9 +59769,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: + - *324 - *325 - - *326 - - *363 + - *362 responses: '200': description: Response @@ -57260,8 +59908,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -57279,9 +59927,9 @@ paths: type: integer secrets: type: array - items: *370 + items: *369 examples: - default: *371 + default: *370 headers: Link: *65 x-github: @@ -57306,16 +59954,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *372 + schema: *371 examples: - default: *373 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57337,17 +59985,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: + - *324 - *325 - - *326 - - *161 + - *160 responses: '200': description: Response content: application/json: - schema: *370 + schema: *369 examples: - default: &499 + default: &498 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -57373,9 +60021,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: + - *324 - *325 - - *326 - - *161 + - *160 requestBody: required: true content: @@ -57406,7 +60054,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -57432,9 +60080,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: + - *324 - *325 - - *326 - - *161 + - *160 responses: '204': description: Response @@ -57459,9 +60107,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: + - *324 - *325 - - *326 - - *341 + - *340 - *19 responses: '200': @@ -57478,9 +60126,9 @@ paths: type: integer variables: type: array - items: *374 + items: *373 examples: - default: *375 + default: *374 headers: Link: *65 x-github: @@ -57503,8 +60151,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -57531,7 +60179,7 @@ paths: description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -57556,17 +60204,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: + - *324 - *325 - - *326 - - *164 + - *163 responses: '200': description: Response content: application/json: - schema: *374 + schema: *373 examples: - default: &500 + default: &499 value: name: USERNAME value: octocat @@ -57592,9 +60240,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: + - *324 - *325 - - *326 - - *164 + - *163 requestBody: required: true content: @@ -57636,9 +60284,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: + - *324 - *325 - - *326 - - *164 + - *163 responses: '204': description: Response @@ -57663,8 +60311,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -57682,7 +60330,7 @@ paths: type: integer workflows: type: array - items: &376 + items: &375 title: Workflow description: A GitHub Actions workflow type: object @@ -57800,9 +60448,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: + - *324 - *325 - - *326 - - &377 + - &376 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -57817,7 +60465,7 @@ paths: description: Response content: application/json: - schema: *376 + schema: *375 examples: default: value: @@ -57850,9 +60498,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: + - *324 - *325 - - *326 - - *377 + - *376 responses: '204': description: Response @@ -57877,9 +60525,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: + - *324 - *325 - - *326 - - *377 + - *376 responses: '204': description: Empty response when `return_run_details` parameter is `false`. @@ -57966,9 +60614,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: + - *324 - *325 - - *326 - - *377 + - *376 responses: '204': description: Response @@ -57995,19 +60643,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: + - *324 - *325 - - *326 + - *376 - *377 - *378 - *379 - *380 - - *381 - *17 - *19 + - *381 + - *360 - *382 - - *361 - *383 - - *384 responses: '200': description: Response @@ -58023,9 +60671,9 @@ paths: type: integer workflow_runs: type: array - items: *362 + items: *361 examples: - default: *385 + default: *384 headers: Link: *65 x-github: @@ -58057,9 +60705,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: + - *324 - *325 - - *326 - - *377 + - *376 responses: '200': description: Response @@ -58120,8 +60768,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: + - *324 - *325 - - *326 - *59 - *17 - *45 @@ -58289,8 +60937,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -58327,8 +60975,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: + - *324 - *325 - - *326 - name: assignee in: path required: true @@ -58364,8 +61012,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -58475,8 +61123,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: + - *324 - *325 - - *326 - *17 - *45 - *46 @@ -58533,7 +61181,7 @@ paths: initiator: type: string examples: - default: *386 + default: *385 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58553,8 +61201,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -58562,7 +61210,7 @@ paths: application/json: schema: type: array - items: &387 + items: &386 title: Autolink reference description: An autolink reference. type: object @@ -58621,8 +61269,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -58661,9 +61309,9 @@ paths: description: response content: application/json: - schema: *387 + schema: *386 examples: - default: &388 + default: &387 value: id: 1 key_prefix: TICKET- @@ -58694,9 +61342,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: + - *324 - *325 - - *326 - - &389 + - &388 name: autolink_id description: The unique identifier of the autolink. in: path @@ -58708,9 +61356,9 @@ paths: description: Response content: application/json: - schema: *387 + schema: *386 examples: - default: *388 + default: *387 '404': *6 x-github: githubCloudOnly: false @@ -58730,9 +61378,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: + - *324 - *325 - - *326 - - *389 + - *388 responses: '204': description: Response @@ -58756,8 +61404,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response if Dependabot is enabled @@ -58807,8 +61455,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -58829,8 +61477,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -58850,8 +61498,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: + - *324 - *325 - - *326 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -58889,7 +61537,7 @@ paths: - url protected: type: boolean - protection: &391 + protection: &390 title: Branch Protection description: Branch Protection type: object @@ -58932,7 +61580,7 @@ paths: required: - contexts - checks - enforce_admins: &394 + enforce_admins: &393 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -58949,7 +61597,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &396 + required_pull_request_reviews: &395 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -58971,7 +61619,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *188 + items: *187 apps: description: The list of apps with review dismissal access. @@ -59003,7 +61651,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *188 + items: *187 apps: description: The list of apps allowed to bypass pull request requirements. @@ -59033,7 +61681,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &393 + restrictions: &392 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -59096,7 +61744,7 @@ paths: type: string teams: type: array - items: *188 + items: *187 apps: type: array items: @@ -59326,9 +61974,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: + - *324 - *325 - - *326 - - &392 + - &391 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/graphql). @@ -59342,14 +61990,14 @@ paths: description: Response content: application/json: - schema: &402 + schema: &401 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &456 + commit: &455 title: Commit description: Commit type: object @@ -59388,7 +62036,7 @@ paths: author: anyOf: - type: 'null' - - &390 + - &389 title: Git User description: Metaproperties for Git author/committer information. @@ -59410,7 +62058,7 @@ paths: committer: anyOf: - type: 'null' - - *390 + - *389 message: type: string examples: @@ -59434,7 +62082,7 @@ paths: required: - sha - url - verification: &506 + verification: &505 title: Verification type: object properties: @@ -59470,14 +62118,14 @@ paths: author: oneOf: - *4 - - *162 + - *161 type: - 'null' - object committer: oneOf: - *4 - - *162 + - *161 type: - 'null' - object @@ -59514,7 +62162,7 @@ paths: type: integer files: type: array - items: &467 + items: &466 title: Diff Entry description: Diff Entry type: object @@ -59610,7 +62258,7 @@ paths: - self protected: type: boolean - protection: *391 + protection: *390 protection_url: type: string format: uri @@ -59719,7 +62367,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *329 + '301': *328 '404': *6 x-github: githubCloudOnly: false @@ -59741,15 +62389,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response content: application/json: - schema: *391 + schema: *390 examples: default: value: @@ -59943,9 +62591,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: true content: @@ -60205,7 +62853,7 @@ paths: url: type: string format: uri - required_status_checks: &399 + required_status_checks: &398 title: Status Check Policy description: Status Check Policy type: object @@ -60286,7 +62934,7 @@ paths: items: *4 teams: type: array - items: *188 + items: *187 apps: type: array items: *5 @@ -60304,7 +62952,7 @@ paths: items: *4 teams: type: array - items: *188 + items: *187 apps: type: array items: *5 @@ -60364,7 +63012,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *393 + restrictions: *392 required_conversation_resolution: type: object properties: @@ -60476,9 +63124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '204': description: Response @@ -60503,17 +63151,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response content: application/json: - schema: *394 + schema: *393 examples: - default: &395 + default: &394 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -60535,17 +63183,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response content: application/json: - schema: *394 + schema: *393 examples: - default: *395 + default: *394 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60564,9 +63212,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '204': description: Response @@ -60591,17 +63239,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response content: application/json: - schema: *396 + schema: *395 examples: - default: &397 + default: &396 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -60697,9 +63345,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: false content: @@ -60797,9 +63445,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *395 examples: - default: *397 + default: *396 '422': *15 x-github: githubCloudOnly: false @@ -60820,9 +63468,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '204': description: Response @@ -60849,17 +63497,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response content: application/json: - schema: *394 + schema: *393 examples: - default: &398 + default: &397 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -60882,17 +63530,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response content: application/json: - schema: *394 + schema: *393 examples: - default: *398 + default: *397 '404': *6 x-github: githubCloudOnly: false @@ -60912,9 +63560,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '204': description: Response @@ -60939,17 +63587,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response content: application/json: - schema: *399 + schema: *398 examples: - default: &400 + default: &399 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -60975,9 +63623,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: false content: @@ -61029,9 +63677,9 @@ paths: description: Response content: application/json: - schema: *399 + schema: *398 examples: - default: *400 + default: *399 '404': *6 '422': *15 x-github: @@ -61053,9 +63701,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '204': description: Response @@ -61079,9 +63727,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response @@ -61115,9 +63763,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: false content: @@ -61184,9 +63832,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: false content: @@ -61250,9 +63898,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: content: application/json: @@ -61318,15 +63966,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response content: application/json: - schema: *393 + schema: *392 examples: default: value: @@ -61417,9 +64065,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '204': description: Response @@ -61442,9 +64090,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response @@ -61454,7 +64102,7 @@ paths: type: array items: *5 examples: - default: &401 + default: &400 value: - id: 1 slug: octoapp @@ -61511,9 +64159,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: true content: @@ -61547,7 +64195,7 @@ paths: type: array items: *5 examples: - default: *401 + default: *400 '422': *15 x-github: githubCloudOnly: false @@ -61568,9 +64216,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: true content: @@ -61604,7 +64252,7 @@ paths: type: array items: *5 examples: - default: *401 + default: *400 '422': *15 x-github: githubCloudOnly: false @@ -61625,9 +64273,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: true content: @@ -61661,7 +64309,7 @@ paths: type: array items: *5 examples: - default: *401 + default: *400 '422': *15 x-github: githubCloudOnly: false @@ -61683,9 +64331,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response @@ -61693,9 +64341,9 @@ paths: application/json: schema: type: array - items: *188 + items: *187 examples: - default: *246 + default: *245 '404': *6 x-github: githubCloudOnly: false @@ -61715,9 +64363,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: false content: @@ -61753,9 +64401,9 @@ paths: application/json: schema: type: array - items: *188 + items: *187 examples: - default: *246 + default: *245 '422': *15 x-github: githubCloudOnly: false @@ -61776,9 +64424,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: false content: @@ -61814,9 +64462,9 @@ paths: application/json: schema: type: array - items: *188 + items: *187 examples: - default: *246 + default: *245 '422': *15 x-github: githubCloudOnly: false @@ -61837,9 +64485,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: content: application/json: @@ -61874,9 +64522,9 @@ paths: application/json: schema: type: array - items: *188 + items: *187 examples: - default: *246 + default: *245 '422': *15 x-github: githubCloudOnly: false @@ -61898,9 +64546,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response @@ -61934,9 +64582,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: true content: @@ -61994,9 +64642,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: true content: @@ -62054,9 +64702,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: true content: @@ -62116,9 +64764,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: true content: @@ -62140,7 +64788,7 @@ paths: description: Response content: application/json: - schema: *402 + schema: *401 examples: default: value: @@ -62256,8 +64904,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -62536,7 +65184,7 @@ paths: description: Response content: application/json: - schema: &403 + schema: &402 title: CheckRun description: A check performed on the code of a given code change type: object @@ -62672,7 +65320,7 @@ paths: check. type: array items: *84 - deployment: &711 + deployment: &710 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -62959,9 +65607,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: + - *324 - *325 - - *326 - - &404 + - &403 name: check_run_id description: The unique identifier of the check run. in: path @@ -62973,9 +65621,9 @@ paths: description: Response content: application/json: - schema: *403 + schema: *402 examples: - default: &405 + default: &404 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -63075,9 +65723,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: + - *324 - *325 - - *326 - - *404 + - *403 requestBody: required: true content: @@ -63317,9 +65965,9 @@ paths: description: Response content: application/json: - schema: *403 + schema: *402 examples: - default: *405 + default: *404 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63339,9 +65987,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: + - *324 - *325 - - *326 - - *404 + - *403 - *17 - *19 responses: @@ -63451,15 +66099,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: + - *324 - *325 - - *326 - - *404 + - *403 responses: '201': description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -63497,8 +66145,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -63520,7 +66168,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &407 + schema: &406 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -63607,7 +66255,7 @@ paths: anyOf: - type: 'null' - *5 - repository: *153 + repository: *152 created_at: type: - string @@ -63618,7 +66266,7 @@ paths: - string - 'null' format: date-time - head_commit: *406 + head_commit: *405 latest_check_runs_count: type: integer check_runs_url: @@ -63646,7 +66294,7 @@ paths: - check_runs_url - pull_requests examples: - default: &408 + default: &407 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -63937,9 +66585,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *407 + schema: *406 examples: - default: *408 + default: *407 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63958,8 +66606,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -64020,7 +66668,7 @@ paths: required: - app_id - setting - repository: *153 + repository: *152 examples: default: value: @@ -64268,9 +66916,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: + - *324 - *325 - - *326 - - &409 + - &408 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -64282,9 +66930,9 @@ paths: description: Response content: application/json: - schema: *407 + schema: *406 examples: - default: *408 + default: *407 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64307,17 +66955,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: + - *324 - *325 - - *326 - - *409 - - &462 + - *408 + - &461 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &463 + - &462 name: status description: Returns check runs with the specified `status`. in: query @@ -64356,9 +67004,9 @@ paths: type: integer check_runs: type: array - items: *403 + items: *402 examples: - default: &464 + default: &463 value: total_count: 1 check_runs: @@ -64460,15 +67108,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: + - *324 - *325 - - *326 - - *409 + - *408 responses: '201': description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -64495,21 +67143,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: + - *324 - *325 - - *326 + - *409 - *410 - - *411 - *19 - *17 - - &428 + - &427 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: *412 - - &429 + schema: *411 + - &428 name: pr description: The number of the pull request for the results you want to list. in: query @@ -64534,13 +67182,13 @@ paths: be returned. in: query required: false - schema: *413 + schema: *412 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *414 + schema: *413 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -64559,24 +67207,24 @@ paths: items: type: object properties: - number: *171 - created_at: *172 - updated_at: *173 - url: *174 - html_url: *175 - instances_url: *415 - state: *180 - fixed_at: *176 + number: *170 + created_at: *171 + updated_at: *172 + url: *173 + html_url: *174 + instances_url: *414 + state: *179 + fixed_at: *175 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *177 - dismissed_reason: *416 - dismissed_comment: *417 - rule: *418 - tool: *419 - most_recent_instance: *420 + dismissed_at: *176 + dismissed_reason: *415 + dismissed_comment: *416 + rule: *417 + tool: *418 + most_recent_instance: *419 dismissal_approved_by: anyOf: - type: 'null' @@ -64699,7 +67347,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &421 + '403': &420 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -64726,9 +67374,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: + - *324 - *325 - - *326 - - &422 + - &421 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -64736,30 +67384,30 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *171 + schema: *170 responses: '200': description: Response content: application/json: - schema: &423 + schema: &422 type: object properties: - number: *171 - created_at: *172 - updated_at: *173 - url: *174 - html_url: *175 - instances_url: *415 - state: *180 - fixed_at: *176 + number: *170 + created_at: *171 + updated_at: *172 + url: *173 + html_url: *174 + instances_url: *414 + state: *179 + fixed_at: *175 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *177 - dismissed_reason: *416 - dismissed_comment: *417 + dismissed_at: *176 + dismissed_reason: *415 + dismissed_comment: *416 rule: type: object properties: @@ -64821,8 +67469,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *419 - most_recent_instance: *420 + tool: *418 + most_recent_instance: *419 dismissal_approved_by: anyOf: - type: 'null' @@ -64918,7 +67566,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *421 + '403': *420 '404': *6 '503': *113 x-github: @@ -64938,9 +67586,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: + - *324 - *325 - - *326 - - *422 + - *421 requestBody: required: true content: @@ -64955,8 +67603,8 @@ paths: enum: - open - dismissed - dismissed_reason: *416 - dismissed_comment: *417 + dismissed_reason: *415 + dismissed_comment: *416 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -64984,7 +67632,7 @@ paths: description: Response content: application/json: - schema: *423 + schema: *422 examples: default: value: @@ -65060,7 +67708,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &427 + '403': &426 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -65087,15 +67735,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: + - *324 - *325 - - *326 - - *422 + - *421 responses: '200': description: Response content: application/json: - schema: &424 + schema: &423 type: object properties: status: @@ -65122,13 +67770,13 @@ paths: - description - started_at examples: - default: &425 + default: &424 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &426 + '400': &425 description: Bad Request content: application/json: @@ -65139,7 +67787,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': *421 + '403': *420 '404': *6 '503': *113 x-github: @@ -65164,29 +67812,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: + - *324 - *325 - - *326 - - *422 + - *421 responses: '200': description: OK content: application/json: - schema: *424 + schema: *423 examples: - default: *425 + default: *424 '202': description: Accepted content: application/json: - schema: *424 + schema: *423 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *426 + '400': *425 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -65218,9 +67866,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: + - *324 - *325 - - *326 - - *422 + - *421 requestBody: required: false content: @@ -65266,8 +67914,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *426 - '403': *427 + '400': *425 + '403': *426 '404': *6 '422': description: Unprocessable Entity @@ -65291,13 +67939,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: + - *324 - *325 - - *326 - - *422 + - *421 - *19 - *17 + - *427 - *428 - - *429 responses: '200': description: Response @@ -65308,10 +67956,10 @@ paths: items: type: object properties: - ref: *412 - analysis_key: *430 - environment: *431 - category: *432 + ref: *411 + analysis_key: *429 + environment: *430 + category: *431 state: type: - string @@ -65328,7 +67976,7 @@ paths: properties: text: type: string - location: *433 + location: *432 html_url: type: string classifications: @@ -65336,7 +67984,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: *434 + items: *433 examples: default: value: @@ -65373,7 +68021,7 @@ paths: end_column: 50 classifications: - source - '403': *421 + '403': *420 '404': *6 '503': *113 x-github: @@ -65407,25 +68055,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: + - *324 - *325 - - *326 + - *409 - *410 - - *411 - *19 - *17 - - *429 + - *428 - 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: *412 + schema: *411 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &435 + schema: &434 type: string description: An identifier for the upload. examples: @@ -65447,23 +68095,23 @@ paths: application/json: schema: type: array - items: &436 + items: &435 type: object properties: - ref: *412 - commit_sha: &444 + ref: *411 + commit_sha: &443 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: *430 + analysis_key: *429 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *432 + category: *431 error: type: string examples: @@ -65488,8 +68136,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *435 - tool: *419 + sarif_id: *434 + tool: *418 deletable: type: boolean warning: @@ -65551,7 +68199,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *421 + '403': *420 '404': *6 '503': *113 x-github: @@ -65587,8 +68235,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: + - *324 - *325 - - *326 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -65601,7 +68249,7 @@ paths: description: Response content: application/json: - schema: *436 + schema: *435 examples: response: summary: application/json response @@ -65655,7 +68303,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *421 + '403': *420 '404': *6 '422': description: Response if analysis could not be processed @@ -65742,8 +68390,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: + - *324 - *325 - - *326 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -65799,7 +68447,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': *427 + '403': *426 '404': *6 '503': *113 x-github: @@ -65821,8 +68469,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -65830,7 +68478,7 @@ paths: application/json: schema: type: array - items: &437 + items: &436 title: CodeQL Database description: A CodeQL database. type: object @@ -65942,7 +68590,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': *421 + '403': *420 '404': *6 '503': *113 x-github: @@ -65971,8 +68619,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: + - *324 - *325 - - *326 - name: language in: path description: The language of the CodeQL database. @@ -65984,7 +68632,7 @@ paths: description: Response content: application/json: - schema: *437 + schema: *436 examples: default: value: @@ -66016,9 +68664,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': &469 + '302': &468 description: Found - '403': *421 + '403': *420 '404': *6 '503': *113 x-github: @@ -66040,8 +68688,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: + - *324 - *325 - - *326 - name: language in: path description: The language of the CodeQL database. @@ -66051,7 +68699,7 @@ paths: responses: '204': description: Response - '403': *427 + '403': *426 '404': *6 '503': *113 x-github: @@ -66079,8 +68727,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -66089,7 +68737,7 @@ paths: type: object additionalProperties: false properties: - language: &438 + language: &437 type: string description: The language targeted by the CodeQL query enum: @@ -66169,7 +68817,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &442 + schema: &441 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -66179,7 +68827,7 @@ paths: description: The ID of the variant analysis. controller_repo: *64 actor: *4 - query_language: *438 + query_language: *437 query_pack_url: type: string description: The download url for the query pack. @@ -66227,7 +68875,7 @@ paths: items: type: object properties: - repository: &439 + repository: &438 title: Repository Identifier description: Repository Identifier type: object @@ -66269,7 +68917,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &443 + analysis_status: &442 type: string description: The new status of the CodeQL variant analysis repository task. @@ -66301,7 +68949,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &440 + access_mismatch_repos: &439 type: object properties: repository_count: @@ -66316,7 +68964,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: *439 + items: *438 required: - repository_count - repositories @@ -66339,8 +68987,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *440 - over_limit_repos: *440 + no_codeql_db_repos: *439 + over_limit_repos: *439 required: - access_mismatch_repos - not_found_repos @@ -66356,7 +69004,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &441 + value: &440 summary: Default response value: id: 1 @@ -66502,10 +69150,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *441 + value: *440 repository_lists: summary: Response for a successful variant analysis submission - value: *441 + value: *440 '404': *6 '422': description: Unable to process variant analysis submission @@ -66533,8 +69181,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: + - *324 - *325 - - *326 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -66546,9 +69194,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *441 examples: - default: *441 + default: *440 '404': *6 '503': *113 x-github: @@ -66571,7 +69219,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *325 + - *324 - name: repo in: path description: The name of the controller repository. @@ -66606,7 +69254,7 @@ paths: type: object properties: repository: *64 - analysis_status: *443 + analysis_status: *442 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -66731,8 +69379,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -66825,7 +69473,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *421 + '403': *420 '404': *6 '503': *113 x-github: @@ -66846,8 +69494,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -66916,7 +69564,7 @@ paths: description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -66941,7 +69589,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *427 + '403': *426 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -67012,8 +69660,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -67021,7 +69669,7 @@ paths: schema: type: object properties: - commit_sha: *444 + commit_sha: *443 ref: type: string description: |- @@ -67081,7 +69729,7 @@ paths: schema: type: object properties: - id: *435 + id: *434 url: type: string description: The REST API URL for checking the status of the upload. @@ -67095,7 +69743,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': *427 + '403': *426 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -67118,8 +69766,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: + - *324 - *325 - - *326 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -67167,7 +69815,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': *421 + '403': *420 '404': description: Not Found if the sarif id does not match any upload '503': *113 @@ -67192,8 +69840,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -67249,7 +69897,7 @@ paths: html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 created_at: '2024-05-01T00:00:00Z' updated_at: '2024-05-01T00:00:00Z' - '204': *184 + '204': *183 '304': *35 '403': *27 '404': *6 @@ -67274,8 +69922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: + - *324 - *325 - - *326 - 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 @@ -67403,8 +70051,8 @@ paths: parameters: - *17 - *19 + - *324 - *325 - - *326 responses: '200': description: Response @@ -67420,7 +70068,7 @@ paths: type: integer codespaces: type: array - items: *235 + items: *234 examples: default: value: @@ -67718,8 +70366,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -67783,17 +70431,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '400': *14 '401': *23 '403': *27 @@ -67822,8 +70470,8 @@ paths: parameters: - *17 - *19 + - *324 - *325 - - *326 responses: '200': description: Response @@ -67887,8 +70535,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: + - *324 - *325 - - *326 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -67925,9 +70573,9 @@ paths: type: integer machines: type: array - items: *446 + items: *445 examples: - default: &655 + default: &654 value: total_count: 2 machines: @@ -67967,8 +70615,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: + - *324 - *325 - - *326 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -68055,8 +70703,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: + - *324 - *325 - - *326 - 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 @@ -68125,8 +70773,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -68144,7 +70792,7 @@ paths: type: integer secrets: type: array - items: &450 + items: &449 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -68165,7 +70813,7 @@ paths: - created_at - updated_at examples: - default: *447 + default: *446 headers: Link: *65 x-github: @@ -68188,16 +70836,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *448 + schema: *447 examples: - default: *449 + default: *448 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -68217,17 +70865,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: + - *324 - *325 - - *326 - - *161 + - *160 responses: '200': description: Response content: application/json: - schema: *450 + schema: *449 examples: - default: *451 + default: *450 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68247,9 +70895,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: + - *324 - *325 - - *326 - - *161 + - *160 requestBody: required: true content: @@ -68277,7 +70925,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -68301,9 +70949,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: + - *324 - *325 - - *326 - - *161 + - *160 responses: '204': description: Response @@ -68331,8 +70979,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: + - *324 - *325 - - *326 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -68370,7 +71018,7 @@ paths: application/json: schema: type: array - items: &452 + items: &451 title: Collaborator description: Collaborator type: object @@ -68563,8 +71211,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: + - *324 - *325 - - *326 - *69 responses: '204': @@ -68611,8 +71259,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: + - *324 - *325 - - *326 - *69 requestBody: required: false @@ -68639,7 +71287,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &519 + schema: &518 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -68651,7 +71299,7 @@ paths: format: int64 examples: - 42 - repository: *153 + repository: *152 invitee: anyOf: - type: 'null' @@ -68867,8 +71515,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: + - *324 - *325 - - *326 - *69 responses: '204': @@ -68900,8 +71548,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: + - *324 - *325 - - *326 - *69 responses: '200': @@ -68922,7 +71570,7 @@ paths: user: anyOf: - type: 'null' - - *452 + - *451 required: - permission - role_name @@ -68976,8 +71624,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -68987,7 +71635,7 @@ paths: application/json: schema: type: array - items: &453 + items: &452 title: Commit Comment description: Commit Comment type: object @@ -69045,7 +71693,7 @@ paths: - created_at - updated_at examples: - default: &458 + default: &457 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -69104,17 +71752,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: + - *324 - *325 - - *326 - *95 responses: '200': description: Response content: application/json: - schema: *453 + schema: *452 examples: - default: &459 + default: &458 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -69171,8 +71819,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: + - *324 - *325 - - *326 - *95 requestBody: required: true @@ -69195,7 +71843,7 @@ paths: description: Response content: application/json: - schema: *453 + schema: *452 examples: default: value: @@ -69246,8 +71894,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: + - *324 - *325 - - *326 - *95 responses: '204': @@ -69269,8 +71917,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: + - *324 - *325 - - *326 - *95 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -69297,7 +71945,7 @@ paths: application/json: schema: type: array - items: &454 + items: &453 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -69341,7 +71989,7 @@ paths: - content - created_at examples: - default: &522 + default: &521 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -69386,8 +72034,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: + - *324 - *325 - - *326 - *95 requestBody: required: true @@ -69420,9 +72068,9 @@ paths: description: Reaction exists content: application/json: - schema: *454 + schema: *453 examples: - default: &455 + default: &454 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -69451,9 +72099,9 @@ paths: description: Reaction created content: application/json: - schema: *454 + schema: *453 examples: - default: *455 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -69475,10 +72123,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: + - *324 - *325 - - *326 - *95 - - &523 + - &522 name: reaction_id description: The unique identifier of the reaction. in: path @@ -69533,8 +72181,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: + - *324 - *325 - - *326 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -69590,9 +72238,9 @@ paths: application/json: schema: type: array - items: *456 + items: *455 examples: - default: &569 + default: &568 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -69686,9 +72334,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: + - *324 - *325 - - *326 - - &457 + - &456 name: commit_sha description: The SHA of the commit. in: path @@ -69760,9 +72408,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: + - *324 - *325 - - *326 - - *457 + - *456 - *17 - *19 responses: @@ -69772,9 +72420,9 @@ paths: application/json: schema: type: array - items: *453 + items: *452 examples: - default: *458 + default: *457 headers: Link: *65 x-github: @@ -69802,9 +72450,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: + - *324 - *325 - - *326 - - *457 + - *456 requestBody: required: true content: @@ -69839,9 +72487,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *452 examples: - default: *459 + default: *458 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -69869,9 +72517,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: + - *324 - *325 - - *326 - - *457 + - *456 - *17 - *19 responses: @@ -69881,9 +72529,9 @@ paths: application/json: schema: type: array - items: *460 + items: *459 examples: - default: &561 + default: &560 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -70420,11 +73068,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: + - *324 - *325 - - *326 - *19 - *17 - - &461 + - &460 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)" @@ -70439,9 +73087,9 @@ paths: description: Response content: application/json: - schema: *456 + schema: *455 examples: - default: &549 + default: &548 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -70554,11 +73202,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: + - *324 - *325 - - *326 + - *460 - *461 - *462 - - *463 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -70592,9 +73240,9 @@ paths: type: integer check_runs: type: array - items: *403 + items: *402 examples: - default: *464 + default: *463 headers: Link: *65 x-github: @@ -70619,9 +73267,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: + - *324 - *325 - - *326 - - *461 + - *460 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -70629,7 +73277,7 @@ paths: schema: type: integer example: 1 - - *462 + - *461 - *17 - *19 responses: @@ -70647,7 +73295,7 @@ paths: type: integer check_suites: type: array - items: *407 + items: *406 examples: default: value: @@ -70847,9 +73495,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: + - *324 - *325 - - *326 - - *461 + - *460 - *17 - *19 responses: @@ -70920,7 +73568,7 @@ paths: type: string total_count: type: integer - repository: *153 + repository: *152 commit_url: type: string format: uri @@ -71051,9 +73699,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: + - *324 - *325 - - *326 - - *461 + - *460 - *17 - *19 responses: @@ -71063,7 +73711,7 @@ paths: application/json: schema: type: array - items: &634 + items: &633 title: Status description: The status of a commit. type: object @@ -71144,7 +73792,7 @@ paths: site_admin: false headers: Link: *65 - '301': *329 + '301': *328 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71172,8 +73820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -71206,11 +73854,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *465 + - *464 code_of_conduct_file: anyOf: - type: 'null' - - &466 + - &465 title: Community Health File type: object properties: @@ -71230,19 +73878,19 @@ paths: contributing: anyOf: - type: 'null' - - *466 + - *465 readme: anyOf: - type: 'null' - - *466 + - *465 issue_template: anyOf: - type: 'null' - - *466 + - *465 pull_request_template: anyOf: - type: 'null' - - *466 + - *465 required: - code_of_conduct - code_of_conduct_file @@ -71371,8 +74019,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: + - *324 - *325 - - *326 - *19 - *17 - name: basehead @@ -71420,8 +74068,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *456 - merge_base_commit: *456 + base_commit: *455 + merge_base_commit: *455 status: type: string enum: @@ -71445,10 +74093,10 @@ paths: - 6 commits: type: array - items: *456 + items: *455 files: type: array - items: *467 + items: *466 required: - url - html_url @@ -71734,8 +74382,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: + - *324 - *325 - - *326 - name: path description: path parameter in: path @@ -71905,7 +74553,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &468 + response-if-content-is-a-file-github-object: &467 summary: Response if content is a file value: type: file @@ -72042,7 +74690,7 @@ paths: - size - type - url - - &574 + - &573 title: Content File description: Content File type: object @@ -72260,7 +74908,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *468 + response-if-content-is-a-file: *467 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -72329,7 +74977,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *469 + '302': *468 '304': *35 x-github: githubCloudOnly: false @@ -72352,8 +75000,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: + - *324 - *325 - - *326 - name: path description: path parameter in: path @@ -72448,7 +75096,7 @@ paths: description: Response content: application/json: - schema: &470 + schema: &469 title: File Commit description: File Commit type: object @@ -72604,7 +75252,7 @@ paths: description: Response content: application/json: - schema: *470 + schema: *469 examples: example-for-creating-a-file: value: @@ -72658,7 +75306,7 @@ paths: schema: oneOf: - *3 - - &501 + - &500 description: Repository rule violation was detected type: object properties: @@ -72679,7 +75327,7 @@ paths: items: type: object properties: - placeholder_id: &626 + placeholder_id: &625 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -72711,8 +75359,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: + - *324 - *325 - - *326 - name: path description: path parameter in: path @@ -72773,7 +75421,7 @@ paths: description: Response content: application/json: - schema: *470 + schema: *469 examples: default: value: @@ -72828,8 +75476,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: + - *324 - *325 - - *326 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -72953,23 +75601,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: + - *324 - *325 - - *326 + - *189 - *190 - *191 - *192 - - *193 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string + - *193 + - *470 - *194 - - *471 - *195 - *196 - - *197 - *59 - *45 - *46 @@ -72981,11 +75629,11 @@ paths: application/json: schema: type: array - items: &475 + items: &474 type: object description: A Dependabot alert. properties: - number: *171 + number: *170 state: type: string description: The state of the Dependabot alert. @@ -73030,14 +75678,15 @@ paths: - unknown - direct - transitive + - inconclusive - - security_advisory: *472 + security_advisory: *471 security_vulnerability: *63 - url: *174 - html_url: *175 - created_at: *172 - updated_at: *173 - dismissed_at: *177 + url: *173 + html_url: *174 + created_at: *171 + updated_at: *172 + dismissed_at: *176 dismissed_by: anyOf: - type: 'null' @@ -73061,9 +75710,9 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: *176 - auto_dismissed_at: *473 - dismissal_request: *474 + fixed_at: *175 + auto_dismissed_at: *472 + dismissal_request: *473 assignees: type: array description: The users assigned to this alert. @@ -73135,7 +75784,7 @@ paths: vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N score: 8.7 epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 cwes: - cwe_id: CWE-200 @@ -73318,9 +75967,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: + - *324 - *325 - - *326 - - &476 + - &475 name: alert_number in: path description: |- @@ -73329,13 +75978,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *171 + schema: *170 responses: '200': description: Response content: application/json: - schema: *475 + schema: *474 examples: default: value: @@ -73392,7 +76041,7 @@ paths: vector_string: CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N score: 8.5 epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 cwes: - cwe_id: CWE-532 @@ -73467,9 +76116,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: + - *324 - *325 - - *326 - - *476 + - *475 requestBody: required: true content: @@ -73525,7 +76174,7 @@ paths: description: Response content: application/json: - schema: *475 + schema: *474 examples: default: value: @@ -73655,8 +76304,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -73674,7 +76323,7 @@ paths: type: integer secrets: type: array - items: &479 + items: &478 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -73728,16 +76377,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *477 + schema: *476 examples: - default: *478 + default: *477 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73757,15 +76406,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: + - *324 - *325 - - *326 - - *161 + - *160 responses: '200': description: Response content: application/json: - schema: *479 + schema: *478 examples: default: value: @@ -73791,9 +76440,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: + - *324 - *325 - - *326 - - *161 + - *160 requestBody: required: true content: @@ -73821,7 +76470,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -73845,9 +76494,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: + - *324 - *325 - - *326 - - *161 + - *160 responses: '204': description: Response @@ -73869,8 +76518,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: + - *324 - *325 - - *326 - 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 @@ -74044,8 +76693,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -74305,8 +76954,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -74389,7 +77038,7 @@ paths: - version - url additionalProperties: false - metadata: &480 + metadata: &479 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -74428,7 +77077,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *480 + metadata: *479 resolved: type: object description: A collection of resolved package dependencies. @@ -74442,7 +77091,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *480 + metadata: *479 relationship: type: string description: A notation of whether a dependency is requested @@ -74575,8 +77224,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: + - *324 - *325 - - *326 - name: sha description: The SHA recorded at creation time. in: query @@ -74617,9 +77266,9 @@ paths: application/json: schema: type: array - items: *481 + items: *480 examples: - default: *482 + default: *481 headers: Link: *65 x-github: @@ -74685,8 +77334,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -74768,7 +77417,7 @@ paths: description: Response content: application/json: - schema: *481 + schema: *480 examples: simple-example: summary: Simple example @@ -74841,9 +77490,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: + - *324 - *325 - - *326 - - &483 + - &482 name: deployment_id description: deployment_id parameter in: path @@ -74855,7 +77504,7 @@ paths: description: Response content: application/json: - schema: *481 + schema: *480 examples: default: value: @@ -74920,9 +77569,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: + - *324 - *325 - - *326 - - *483 + - *482 responses: '204': description: Response @@ -74944,9 +77593,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: + - *324 - *325 - - *326 - - *483 + - *482 - *17 - *19 responses: @@ -74956,7 +77605,7 @@ paths: application/json: schema: type: array - items: &484 + items: &483 title: Deployment Status description: The status of a deployment. type: object @@ -75120,9 +77769,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: + - *324 - *325 - - *326 - - *483 + - *482 requestBody: required: true content: @@ -75197,9 +77846,9 @@ paths: description: Response content: application/json: - schema: *484 + schema: *483 examples: - default: &485 + default: &484 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -75255,9 +77904,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: + - *324 - *325 - - *326 - - *483 + - *482 - name: status_id in: path required: true @@ -75268,9 +77917,9 @@ paths: description: Response content: application/json: - schema: *484 + schema: *483 examples: - default: *485 + default: *484 '404': *6 x-github: githubCloudOnly: false @@ -75295,8 +77944,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -75353,8 +78002,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -75372,7 +78021,7 @@ paths: - 5 environments: type: array - items: &487 + items: &486 title: Environment description: Details of a deployment environment type: object @@ -75434,7 +78083,7 @@ paths: type: string examples: - wait_timer - wait_timer: &489 + wait_timer: &488 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -75476,11 +78125,11 @@ paths: items: type: object properties: - type: *486 + type: *485 reviewer: anyOf: - *4 - - *188 + - *187 required: - id - node_id @@ -75503,7 +78152,7 @@ paths: - id - node_id - type - deployment_branch_policy: &490 + deployment_branch_policy: &489 type: - object - 'null' @@ -75620,9 +78269,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: + - *324 - *325 - - *326 - - &488 + - &487 name: environment_name in: path required: true @@ -75635,9 +78284,9 @@ paths: description: Response content: application/json: - schema: *487 + schema: *486 examples: - default: &491 + default: &490 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -75721,9 +78370,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: + - *324 - *325 - - *326 - - *488 + - *487 requestBody: required: false content: @@ -75733,7 +78382,7 @@ paths: - object - 'null' properties: - wait_timer: *489 + wait_timer: *488 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -75752,14 +78401,14 @@ paths: items: type: object properties: - type: *486 + type: *485 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *490 + deployment_branch_policy: *489 additionalProperties: false examples: default: @@ -75779,9 +78428,9 @@ paths: description: Response content: application/json: - schema: *487 + schema: *486 examples: - default: *491 + default: *490 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -75805,9 +78454,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: + - *324 - *325 - - *326 - - *488 + - *487 responses: '204': description: Default response @@ -75832,9 +78481,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: + - *324 - *325 - - *326 - - *488 + - *487 - *17 - *19 responses: @@ -75853,7 +78502,7 @@ paths: - 2 branch_policies: type: array - items: &492 + items: &491 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -75914,9 +78563,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: + - *324 - *325 - - *326 - - *488 + - *487 requestBody: required: true content: @@ -75964,9 +78613,9 @@ paths: description: Response content: application/json: - schema: *492 + schema: *491 examples: - example-wildcard: &493 + example-wildcard: &492 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -76008,10 +78657,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: + - *324 - *325 - - *326 - - *488 - - &494 + - *487 + - &493 name: branch_policy_id in: path required: true @@ -76023,9 +78672,9 @@ paths: description: Response content: application/json: - schema: *492 + schema: *491 examples: - default: *493 + default: *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76044,10 +78693,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: + - *324 - *325 - - *326 - - *488 - - *494 + - *487 + - *493 requestBody: required: true content: @@ -76076,9 +78725,9 @@ paths: description: Response content: application/json: - schema: *492 + schema: *491 examples: - default: *493 + default: *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76097,10 +78746,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: + - *324 - *325 - - *326 - - *488 - - *494 + - *487 + - *493 responses: '204': description: Response @@ -76125,9 +78774,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *488 - - *326 + - *487 - *325 + - *324 responses: '200': description: List of deployment protection rules @@ -76144,7 +78793,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &495 + items: &494 title: Deployment protection rule description: Deployment protection rule type: object @@ -76166,7 +78815,7 @@ paths: for the environment. examples: - true - app: &496 + app: &495 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -76269,9 +78918,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *488 - - *326 + - *487 - *325 + - *324 requestBody: content: application/json: @@ -76292,9 +78941,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *495 + schema: *494 examples: - default: &497 + default: &496 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -76329,9 +78978,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *488 - - *326 + - *487 - *325 + - *324 - *19 - *17 responses: @@ -76351,7 +79000,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *496 + items: *495 examples: default: value: @@ -76386,10 +79035,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: + - *324 - *325 - - *326 - - *488 - - &498 + - *487 + - &497 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -76401,9 +79050,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *494 examples: - default: *497 + default: *496 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76424,10 +79073,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *488 - - *326 + - *487 - *325 - - *498 + - *324 + - *497 responses: '204': description: Response @@ -76453,9 +79102,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: + - *324 - *325 - - *326 - - *488 + - *487 - *17 - *19 responses: @@ -76473,9 +79122,9 @@ paths: type: integer secrets: type: array - items: *370 + items: *369 examples: - default: *371 + default: *370 headers: Link: *65 x-github: @@ -76500,17 +79149,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: + - *324 - *325 - - *326 - - *488 + - *487 responses: '200': description: Response content: application/json: - schema: *372 + schema: *371 examples: - default: *373 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76532,18 +79181,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: + - *324 - *325 - - *326 - - *488 - - *161 + - *487 + - *160 responses: '200': description: Response content: application/json: - schema: *370 + schema: *369 examples: - default: *499 + default: *498 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76565,10 +79214,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: + - *324 - *325 - - *326 - - *488 - - *161 + - *487 + - *160 requestBody: required: true content: @@ -76599,7 +79248,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -76625,10 +79274,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: + - *324 - *325 - - *326 - - *488 - - *161 + - *487 + - *160 responses: '204': description: Default response @@ -76653,10 +79302,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: + - *324 - *325 - - *326 - - *488 - - *341 + - *487 + - *340 - *19 responses: '200': @@ -76673,9 +79322,9 @@ paths: type: integer variables: type: array - items: *374 + items: *373 examples: - default: *375 + default: *374 headers: Link: *65 x-github: @@ -76698,9 +79347,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: + - *324 - *325 - - *326 - - *488 + - *487 requestBody: required: true content: @@ -76727,7 +79376,7 @@ paths: description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -76752,18 +79401,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: + - *324 - *325 - - *326 - - *488 - - *164 + - *487 + - *163 responses: '200': description: Response content: application/json: - schema: *374 + schema: *373 examples: - default: *500 + default: *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76784,10 +79433,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: + - *324 - *325 - - *326 - - *164 - - *488 + - *163 + - *487 requestBody: required: true content: @@ -76829,10 +79478,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: + - *324 - *325 - - *326 - - *164 - - *488 + - *163 + - *487 responses: '204': description: Response @@ -76854,8 +79503,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -76923,8 +79572,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: + - *324 - *325 - - *326 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -76946,7 +79595,7 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: default: value: @@ -77083,8 +79732,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: + - *324 - *325 - - *326 requestBody: required: false content: @@ -77117,9 +79766,9 @@ paths: description: Response content: application/json: - schema: *328 + schema: *327 examples: - default: *330 + default: *329 '400': *14 '422': *15 '403': *27 @@ -77140,8 +79789,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -77201,7 +79850,7 @@ paths: schema: oneOf: - *121 - - *501 + - *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77226,8 +79875,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: + - *324 - *325 - - *326 - name: file_sha in: path required: true @@ -77327,8 +79976,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -77437,7 +80086,7 @@ paths: description: Response content: application/json: - schema: &502 + schema: &501 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -77664,15 +80313,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: + - *324 - *325 - - *326 - - *457 + - *456 responses: '200': description: Response content: application/json: - schema: *502 + schema: *501 examples: default: value: @@ -77728,9 +80377,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: + - *324 - *325 - - *326 - - &503 + - &502 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. @@ -77747,7 +80396,7 @@ paths: application/json: schema: type: array - items: &504 + items: &503 title: Git Reference description: Git references within a repository type: object @@ -77823,17 +80472,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: + - *324 - *325 - - *326 - - *503 + - *502 responses: '200': description: Response content: application/json: - schema: *504 + schema: *503 examples: - default: &505 + default: &504 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -77862,8 +80511,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -77892,9 +80541,9 @@ paths: description: Response content: application/json: - schema: *504 + schema: *503 examples: - default: *505 + default: *504 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -77920,9 +80569,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: + - *324 - *325 - - *326 - - *503 + - *502 requestBody: required: true content: @@ -77951,9 +80600,9 @@ paths: description: Response content: application/json: - schema: *504 + schema: *503 examples: - default: *505 + default: *504 '422': *15 '409': *52 x-github: @@ -77971,9 +80620,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: + - *324 - *325 - - *326 - - *503 + - *502 responses: '204': description: Response @@ -78028,8 +80677,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -78096,7 +80745,7 @@ paths: description: Response content: application/json: - schema: &507 + schema: &506 title: Git Tag description: Metadata for a Git tag type: object @@ -78152,7 +80801,7 @@ paths: - sha - type - url - verification: *506 + verification: *505 required: - sha - url @@ -78162,7 +80811,7 @@ paths: - tag - message examples: - default: &508 + default: &507 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -78235,8 +80884,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: + - *324 - *325 - - *326 - name: tag_sha in: path required: true @@ -78247,9 +80896,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *506 examples: - default: *508 + default: *507 '404': *6 '409': *52 x-github: @@ -78273,8 +80922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -78348,7 +80997,7 @@ paths: description: Response content: application/json: - schema: &509 + schema: &508 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -78450,8 +81099,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: + - *324 - *325 - - *326 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -78474,7 +81123,7 @@ paths: description: Response content: application/json: - schema: *509 + schema: *508 examples: default-response: summary: Default response @@ -78533,8 +81182,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -78544,7 +81193,7 @@ paths: application/json: schema: type: array - items: &510 + items: &509 title: Webhook description: Webhooks for repositories. type: object @@ -78607,7 +81256,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &742 + last_response: &741 title: Hook Response type: object properties: @@ -78684,8 +81333,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: + - *324 - *325 - - *326 requestBody: required: false content: @@ -78738,9 +81387,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *509 examples: - default: &511 + default: &510 value: type: Repository id: 12345678 @@ -78788,17 +81437,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: + - *324 - *325 - - *326 - - *203 + - *202 responses: '200': description: Response content: application/json: - schema: *510 + schema: *509 examples: - default: *511 + default: *510 '404': *6 x-github: githubCloudOnly: false @@ -78818,9 +81467,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: + - *324 - *325 - - *326 - - *203 + - *202 requestBody: required: true content: @@ -78865,9 +81514,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *509 examples: - default: *511 + default: *510 '422': *15 '404': *6 x-github: @@ -78888,9 +81537,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: + - *324 - *325 - - *326 - - *203 + - *202 responses: '204': description: Response @@ -78914,9 +81563,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: + - *324 - *325 - - *326 - - *203 + - *202 responses: '200': description: Response @@ -78943,9 +81592,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: + - *324 - *325 - - *326 - - *203 + - *202 requestBody: required: false content: @@ -78989,12 +81638,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: + - *324 - *325 - - *326 - - *203 + - *202 - *17 + - *203 - *204 - - *205 responses: '200': description: Response @@ -79002,9 +81651,9 @@ paths: application/json: schema: type: array - items: *206 + items: *205 examples: - default: *207 + default: *206 '400': *14 '422': *15 x-github: @@ -79023,18 +81672,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: + - *324 - *325 - - *326 - - *203 + - *202 - *16 responses: '200': description: Response content: application/json: - schema: *208 + schema: *207 examples: - default: *209 + default: *208 '400': *14 '422': *15 x-github: @@ -79053,9 +81702,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: + - *324 - *325 - - *326 - - *203 + - *202 - *16 responses: '202': *37 @@ -79078,9 +81727,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: + - *324 - *325 - - *326 - - *203 + - *202 responses: '204': description: Response @@ -79105,9 +81754,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: + - *324 - *325 - - *326 - - *203 + - *202 responses: '204': description: Response @@ -79130,8 +81779,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response if immutable releases are enabled @@ -79179,10 +81828,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: + - *324 - *325 - - *326 responses: - '204': *184 + '204': *183 '409': *52 x-github: githubCloudOnly: false @@ -79200,10 +81849,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: + - *324 - *325 - - *326 responses: - '204': *184 + '204': *183 '409': *52 x-github: githubCloudOnly: false @@ -79258,14 +81907,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: &512 + schema: &511 title: Import description: A repository import from an external source. type: object @@ -79372,7 +82021,7 @@ paths: - html_url - authors_url examples: - default: &515 + default: &514 value: vcs: subversion use_lfs: true @@ -79388,7 +82037,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': &513 + '503': &512 description: Unavailable due to service under maintenance. content: application/json: @@ -79417,8 +82066,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -79466,7 +82115,7 @@ paths: description: Response content: application/json: - schema: *512 + schema: *511 examples: default: value: @@ -79491,7 +82140,7 @@ paths: type: string '422': *15 '404': *6 - '503': *513 + '503': *512 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79519,8 +82168,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: + - *324 - *325 - - *326 requestBody: required: false content: @@ -79572,7 +82221,7 @@ paths: description: Response content: application/json: - schema: *512 + schema: *511 examples: example-1: summary: Example 1 @@ -79620,7 +82269,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': *513 + '503': *512 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79643,12 +82292,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: + - *324 - *325 - - *326 responses: '204': description: Response - '503': *513 + '503': *512 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79674,9 +82323,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: + - *324 - *325 - - *326 - - &676 + - &675 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -79690,7 +82339,7 @@ paths: application/json: schema: type: array - items: &514 + items: &513 title: Porter Author description: Porter Author type: object @@ -79744,7 +82393,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': *513 + '503': *512 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79769,8 +82418,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: + - *324 - *325 - - *326 - name: author_id in: path required: true @@ -79800,7 +82449,7 @@ paths: description: Response content: application/json: - schema: *514 + schema: *513 examples: default: value: @@ -79813,7 +82462,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *513 + '503': *512 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79837,8 +82486,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -79879,7 +82528,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *513 + '503': *512 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79907,8 +82556,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -79935,11 +82584,11 @@ paths: description: Response content: application/json: - schema: *512 + schema: *511 examples: - default: *515 + default: *514 '422': *15 - '503': *513 + '503': *512 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79962,8 +82611,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -79971,8 +82620,8 @@ paths: application/json: schema: *20 examples: - default: *516 - '301': *329 + default: *515 + '301': *328 '404': *6 x-github: githubCloudOnly: false @@ -79992,8 +82641,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -80001,12 +82650,12 @@ paths: application/json: schema: anyOf: - - *222 + - *221 - type: object properties: {} additionalProperties: false examples: - default: &518 + default: &517 value: limit: collaborators_only origin: repository @@ -80031,13 +82680,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: application/json: - schema: *517 + schema: *516 examples: default: summary: Example request body @@ -80049,9 +82698,9 @@ paths: description: Response content: application/json: - schema: *222 + schema: *221 examples: - default: *518 + default: *517 '409': description: Response x-github: @@ -80073,8 +82722,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -80097,8 +82746,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -80108,9 +82757,9 @@ paths: application/json: schema: type: array - items: *519 + items: *518 examples: - default: &669 + default: &668 value: - id: 1 repository: @@ -80241,9 +82890,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: + - *324 - *325 - - *326 - - *226 + - *225 requestBody: required: false content: @@ -80272,7 +82921,7 @@ paths: description: Response content: application/json: - schema: *519 + schema: *518 examples: default: value: @@ -80403,9 +83052,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: + - *324 - *325 - - *326 - - *226 + - *225 responses: '204': description: Response @@ -80436,8 +83085,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: + - *324 - *325 - - *326 - 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 @@ -80485,7 +83134,7 @@ paths: required: false schema: type: string - - *233 + - *232 - name: sort description: What to sort results by. in: query @@ -80510,7 +83159,7 @@ paths: type: array items: *81 examples: - default: &528 + default: &527 value: - id: 1 node_id: MDU6SXNzdWUx @@ -80659,7 +83308,7 @@ paths: state_reason: completed headers: Link: *65 - '301': *329 + '301': *328 '422': *15 '404': *6 x-github: @@ -80688,8 +83337,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -80781,7 +83430,7 @@ paths: application/json: schema: *81 examples: - default: &525 + default: &524 value: id: 1 node_id: MDU6SXNzdWUx @@ -80938,7 +83587,7 @@ paths: '422': *15 '503': *113 '404': *6 - '410': *520 + '410': *519 x-github: triggersNotification: true githubCloudOnly: false @@ -80966,8 +83615,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: + - *324 - *325 - - *326 - *103 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -80990,7 +83639,7 @@ paths: type: array items: *82 examples: - default: &527 + default: &526 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -81048,8 +83697,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: + - *324 - *325 - - *326 - *95 responses: '200': @@ -81058,7 +83707,7 @@ paths: application/json: schema: *82 examples: - default: &521 + default: &520 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -81113,8 +83762,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: + - *324 - *325 - - *326 - *95 requestBody: required: true @@ -81139,7 +83788,7 @@ paths: application/json: schema: *82 examples: - default: *521 + default: *520 '422': *15 x-github: githubCloudOnly: false @@ -81157,8 +83806,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: + - *324 - *325 - - *326 - *95 responses: '204': @@ -81187,8 +83836,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment parameters: + - *324 - *325 - - *326 - *95 responses: '200': @@ -81251,7 +83900,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *520 + '410': *519 '422': *15 x-github: githubCloudOnly: false @@ -81268,8 +83917,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment parameters: + - *324 - *325 - - *326 - *95 responses: '204': @@ -81277,7 +83926,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *520 + '410': *519 '503': *113 x-github: githubCloudOnly: false @@ -81295,8 +83944,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: + - *324 - *325 - - *326 - *95 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -81323,9 +83972,9 @@ paths: application/json: schema: type: array - items: *454 + items: *453 examples: - default: *522 + default: *521 headers: Link: *65 '404': *6 @@ -81346,8 +83995,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: + - *324 - *325 - - *326 - *95 requestBody: required: true @@ -81380,16 +84029,16 @@ paths: description: Reaction exists content: application/json: - schema: *454 + schema: *453 examples: - default: *455 + default: *454 '201': description: Reaction created content: application/json: - schema: *454 + schema: *453 examples: - default: *455 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -81411,10 +84060,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: + - *324 - *325 - - *326 - *95 - - *523 + - *522 responses: '204': description: Response @@ -81434,8 +84083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -81445,7 +84094,7 @@ paths: application/json: schema: type: array - items: &524 + items: &523 title: Issue Event description: Issue Event type: object @@ -81525,7 +84174,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *188 + requested_team: *187 dismissed_review: title: Issue Event Dismissed Review type: object @@ -81785,8 +84434,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: + - *324 - *325 - - *326 - name: event_id in: path required: true @@ -81797,7 +84446,7 @@ paths: description: Response content: application/json: - schema: *524 + schema: *523 examples: default: value: @@ -81990,7 +84639,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *520 + '410': *519 '403': *27 x-github: githubCloudOnly: false @@ -82024,9 +84673,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: + - *324 - *325 - - *326 - - &526 + - &525 name: issue_number description: The number that identifies the issue. in: path @@ -82042,7 +84691,7 @@ paths: examples: default: summary: Issue - value: *525 + value: *524 pinned_comment: summary: Issue with pinned comment value: @@ -82241,9 +84890,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *329 + '301': *328 '404': *6 - '410': *520 + '410': *519 '304': *35 x-github: githubCloudOnly: false @@ -82268,9 +84917,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: false content: @@ -82411,13 +85060,13 @@ paths: application/json: schema: *81 examples: - default: *525 + default: *524 '422': *15 '503': *113 '403': *27 - '301': *329 + '301': *328 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82435,9 +85084,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: false content: @@ -82465,7 +85114,7 @@ paths: application/json: schema: *81 examples: - default: *525 + default: *524 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82481,9 +85130,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: content: application/json: @@ -82510,7 +85159,7 @@ paths: application/json: schema: *81 examples: - default: *525 + default: *524 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82532,9 +85181,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 - name: assignee in: path required: true @@ -82574,9 +85223,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: + - *324 - *325 - - *326 - - *526 + - *525 - *86 - *17 - *19 @@ -82589,11 +85238,11 @@ paths: type: array items: *82 examples: - default: *527 + default: *526 headers: Link: *65 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82622,9 +85271,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: true content: @@ -82648,14 +85297,14 @@ paths: application/json: schema: *82 examples: - default: *521 + default: *520 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *520 + '410': *519 '422': *15 '404': *6 x-github: @@ -82683,9 +85332,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: + - *324 - *325 - - *326 - - *526 + - *525 - *17 - *19 responses: @@ -82697,12 +85346,12 @@ paths: type: array items: *81 examples: - default: *528 + default: *527 headers: Link: *65 - '301': *329 + '301': *328 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82730,9 +85379,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: true content: @@ -82756,15 +85405,15 @@ paths: application/json: schema: *81 examples: - default: *525 + default: *524 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *329 + '301': *328 '403': *27 - '410': *520 + '410': *519 '422': *15 '404': *6 x-github: @@ -82795,9 +85444,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: + - *324 - *325 - - *326 - - *526 + - *525 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -82811,13 +85460,13 @@ paths: application/json: schema: *81 examples: - default: *525 - '301': *329 + default: *524 + '301': *328 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *520 + '410': *519 x-github: triggersNotification: true githubCloudOnly: false @@ -82843,9 +85492,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: + - *324 - *325 - - *326 - - *526 + - *525 - *17 - *19 responses: @@ -82857,12 +85506,12 @@ paths: type: array items: *81 examples: - default: *528 + default: *527 headers: Link: *65 - '301': *329 + '301': *328 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82879,9 +85528,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: + - *324 - *325 - - *326 - - *526 + - *525 - *17 - *19 responses: @@ -82895,7 +85544,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &531 + - &530 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -82944,7 +85593,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &532 + - &531 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -83072,7 +85721,7 @@ paths: - performed_via_github_app - assignee - assigner - - &533 + - &532 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -83118,7 +85767,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &534 + - &533 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -83164,7 +85813,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &535 + - &534 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -83213,7 +85862,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &536 + - &535 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -83242,7 +85891,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *188 + requested_team: *187 requested_reviewer: *4 required: - review_requester @@ -83255,7 +85904,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &537 + - &536 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -83284,7 +85933,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *188 + requested_team: *187 requested_reviewer: *4 required: - review_requester @@ -83297,7 +85946,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &538 + - &537 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -83353,7 +86002,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &539 + - &538 title: Locked Issue Event description: Locked Issue Event type: object @@ -83398,7 +86047,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &540 + - &539 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -83459,7 +86108,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &541 + - &540 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -83520,7 +86169,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &542 + - &541 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -83581,7 +86230,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &543 + - &542 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -83674,7 +86323,7 @@ paths: color: red headers: Link: *65 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83691,9 +86340,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 - *17 - *19 responses: @@ -83703,9 +86352,9 @@ paths: application/json: schema: type: array - items: *529 + items: *528 examples: - default: &640 + default: &639 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -83729,9 +86378,9 @@ paths: value: '2025-12-25' headers: Link: *65 - '301': *329 + '301': *328 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83748,9 +86397,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 - *17 - *19 responses: @@ -83762,7 +86411,7 @@ paths: type: array items: *80 examples: - default: &530 + default: &529 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -83780,9 +86429,9 @@ paths: default: false headers: Link: *65 - '301': *329 + '301': *328 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83798,9 +86447,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: false content: @@ -83845,10 +86494,10 @@ paths: type: array items: *80 examples: - default: *530 - '301': *329 + default: *529 + '301': *328 '404': *6 - '410': *520 + '410': *519 '422': *15 x-github: githubCloudOnly: false @@ -83865,9 +86514,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: false content: @@ -83929,10 +86578,10 @@ paths: type: array items: *80 examples: - default: *530 - '301': *329 + default: *529 + '301': *328 '404': *6 - '410': *520 + '410': *519 '422': *15 x-github: githubCloudOnly: false @@ -83949,15 +86598,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 responses: '204': description: Response - '301': *329 + '301': *328 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83976,9 +86625,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 - name: name in: path required: true @@ -84002,9 +86651,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *329 + '301': *328 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84024,9 +86673,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: false content: @@ -84055,7 +86704,7 @@ paths: '204': description: Response '403': *27 - '410': *520 + '410': *519 '404': *6 '422': *15 x-github: @@ -84073,9 +86722,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 responses: '204': description: Response @@ -84105,9 +86754,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 responses: '200': description: Response @@ -84115,10 +86764,10 @@ paths: application/json: schema: *81 examples: - default: *525 - '301': *329 + default: *524 + '301': *328 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84135,9 +86784,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -84163,13 +86812,13 @@ paths: application/json: schema: type: array - items: *454 + items: *453 examples: - default: *522 + default: *521 headers: Link: *65 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84187,9 +86836,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: true content: @@ -84221,16 +86870,16 @@ paths: description: Response content: application/json: - schema: *454 + schema: *453 examples: - default: *455 + default: *454 '201': description: Response content: application/json: - schema: *454 + schema: *453 examples: - default: *455 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -84252,10 +86901,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: + - *324 - *325 - - *326 - - *526 - - *523 + - *525 + - *522 responses: '204': description: Response @@ -84284,9 +86933,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: true content: @@ -84310,7 +86959,7 @@ paths: application/json: schema: *81 examples: - default: *525 + default: *524 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -84343,9 +86992,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: + - *324 - *325 - - *326 - - *526 + - *525 - *17 - *19 responses: @@ -84357,11 +87006,11 @@ paths: type: array items: *81 examples: - default: *528 + default: *527 headers: Link: *65 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84389,9 +87038,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: true content: @@ -84420,14 +87069,14 @@ paths: application/json: schema: *81 examples: - default: *525 + default: *524 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *520 + '410': *519 '422': *15 '404': *6 x-github: @@ -84447,9 +87096,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: true content: @@ -84482,7 +87131,7 @@ paths: application/json: schema: *81 examples: - default: *525 + default: *524 '403': *27 '404': *6 '422': *7 @@ -84504,9 +87153,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 - *17 - *19 responses: @@ -84521,6 +87170,7 @@ paths: description: Timeline Event type: object anyOf: + - *530 - *531 - *532 - *533 @@ -84533,7 +87183,6 @@ paths: - *540 - *541 - *542 - - *543 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -84590,7 +87239,7 @@ paths: pin: anyOf: - type: 'null' - - *544 + - *543 required: - event - actor @@ -84866,7 +87515,7 @@ paths: type: string comments: type: array - items: &563 + items: &562 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -85107,7 +87756,7 @@ paths: type: string comments: type: array - items: *453 + items: *452 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -85382,7 +88031,7 @@ paths: headers: Link: *65 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85399,8 +88048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -85410,7 +88059,7 @@ paths: application/json: schema: type: array - items: &545 + items: &544 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -85478,8 +88127,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -85515,9 +88164,9 @@ paths: description: Response content: application/json: - schema: *545 + schema: *544 examples: - default: &546 + default: &545 value: id: 1 key: ssh-rsa AAA... @@ -85551,9 +88200,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: + - *324 - *325 - - *326 - - &547 + - &546 name: key_id description: The unique identifier of the key. in: path @@ -85565,9 +88214,9 @@ paths: description: Response content: application/json: - schema: *545 + schema: *544 examples: - default: *546 + default: *545 '404': *6 x-github: githubCloudOnly: false @@ -85585,9 +88234,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: + - *324 - *325 - - *326 - - *547 + - *546 responses: '204': description: Response @@ -85607,8 +88256,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -85620,7 +88269,7 @@ paths: type: array items: *80 examples: - default: *530 + default: *529 headers: Link: *65 '404': *6 @@ -85641,8 +88290,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -85680,7 +88329,7 @@ paths: application/json: schema: *80 examples: - default: &548 + default: &547 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -85712,8 +88361,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: + - *324 - *325 - - *326 - name: name in: path required: true @@ -85726,7 +88375,7 @@ paths: application/json: schema: *80 examples: - default: *548 + default: *547 '404': *6 x-github: githubCloudOnly: false @@ -85743,8 +88392,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: + - *324 - *325 - - *326 - name: name in: path required: true @@ -85809,8 +88458,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: + - *324 - *325 - - *326 - name: name in: path required: true @@ -85836,8 +88485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -85876,9 +88525,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: + - *324 - *325 - - *326 - - *428 + - *427 responses: '200': description: Response @@ -86025,8 +88674,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -86091,8 +88740,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -86126,9 +88775,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *456 + schema: *455 examples: - default: *549 + default: *548 '204': description: Response when already merged '404': @@ -86153,8 +88802,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: + - *324 - *325 - - *326 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -86195,7 +88844,7 @@ paths: application/json: schema: type: array - items: *266 + items: *265 examples: default: value: @@ -86251,8 +88900,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -86292,9 +88941,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *265 examples: - default: &550 + default: &549 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -86353,9 +89002,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: + - *324 - *325 - - *326 - - &551 + - &550 name: milestone_number description: The number that identifies the milestone. in: path @@ -86367,9 +89016,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *265 examples: - default: *550 + default: *549 '404': *6 x-github: githubCloudOnly: false @@ -86386,9 +89035,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: + - *324 - *325 - - *326 - - *551 + - *550 requestBody: required: false content: @@ -86426,9 +89075,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *265 examples: - default: *550 + default: *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86444,9 +89093,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: + - *324 - *325 - - *326 - - *551 + - *550 responses: '204': description: Response @@ -86467,9 +89116,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: + - *324 - *325 - - *326 - - *551 + - *550 - *17 - *19 responses: @@ -86481,7 +89130,7 @@ paths: type: array items: *80 examples: - default: *530 + default: *529 headers: Link: *65 x-github: @@ -86500,12 +89149,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: + - *324 - *325 - - *326 + - *551 - *552 - - *553 - *86 - - *554 + - *553 - *17 - *19 responses: @@ -86517,7 +89166,7 @@ paths: type: array items: *106 examples: - default: *555 + default: *554 headers: Link: *65 x-github: @@ -86541,8 +89190,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: + - *324 - *325 - - *326 requestBody: required: false content: @@ -86600,14 +89249,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: &556 + schema: &555 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -86751,7 +89400,7 @@ paths: - custom_404 - public examples: - default: &557 + default: &556 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -86792,8 +89441,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -86848,9 +89497,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *555 examples: - default: *557 + default: *556 '422': *15 '409': *52 x-github: @@ -86873,8 +89522,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -86974,8 +89623,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -87001,8 +89650,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -87012,7 +89661,7 @@ paths: application/json: schema: type: array - items: &558 + items: &557 title: Page Build description: Page Build type: object @@ -87104,8 +89753,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: + - *324 - *325 - - *326 responses: '201': description: Response @@ -87152,16 +89801,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *558 + schema: *557 examples: - default: &559 + default: &558 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -87209,8 +89858,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: + - *324 - *325 - - *326 - name: build_id in: path required: true @@ -87221,9 +89870,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *557 examples: - default: *559 + default: *558 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87243,8 +89892,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -87352,9 +90001,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: + - *324 - *325 - - *326 - - &560 + - &559 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -87412,11 +90061,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: + - *324 - *325 - - *326 - - *560 + - *559 responses: - '204': *184 + '204': *183 '404': *6 x-github: githubCloudOnly: false @@ -87441,8 +90090,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -87710,7 +90359,7 @@ paths: description: Empty response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -87737,8 +90386,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Private vulnerability reporting status @@ -87775,10 +90424,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: + - *324 - *325 - - *326 responses: - '204': *184 + '204': *183 '422': *14 x-github: githubCloudOnly: false @@ -87797,10 +90446,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: + - *324 - *325 - - *326 responses: - '204': *184 + '204': *183 '422': *14 x-github: githubCloudOnly: false @@ -87820,8 +90469,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -87829,7 +90478,7 @@ paths: application/json: schema: type: array - items: *280 + items: *279 examples: default: value: @@ -87860,8 +90509,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -87873,7 +90522,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *280 + items: *279 required: - properties examples: @@ -87923,8 +90572,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: + - *324 - *325 - - *326 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -87984,9 +90633,9 @@ paths: application/json: schema: type: array - items: *460 + items: *459 examples: - default: *561 + default: *560 headers: Link: *65 '304': *35 @@ -88018,8 +90667,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -88086,7 +90735,7 @@ paths: description: Response content: application/json: - schema: &565 + schema: &564 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -88215,7 +90864,7 @@ paths: milestone: anyOf: - type: 'null' - - *266 + - *265 active_lock_reason: type: - string @@ -88264,7 +90913,7 @@ paths: items: *4 requested_teams: type: array - items: *245 + items: *244 head: type: object properties: @@ -88302,14 +90951,14 @@ paths: _links: type: object properties: - comments: *267 - commits: *267 - statuses: *267 - html: *267 - issue: *267 - review_comments: *267 - review_comment: *267 - self: *267 + comments: *266 + commits: *266 + statuses: *266 + html: *266 + issue: *266 + review_comments: *266 + review_comment: *266 + self: *266 required: - comments - commits @@ -88320,7 +90969,7 @@ paths: - review_comment - self author_association: *78 - auto_merge: *562 + auto_merge: *561 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -88422,7 +91071,7 @@ paths: - merged_by - review_comments examples: - default: &566 + default: &565 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -88949,8 +91598,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: + - *324 - *325 - - *326 - name: sort in: query required: false @@ -88979,9 +91628,9 @@ paths: application/json: schema: type: array - items: *563 + items: *562 examples: - default: &568 + default: &567 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -89058,17 +91707,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: + - *324 - *325 - - *326 - *95 responses: '200': description: Response content: application/json: - schema: *563 + schema: *562 examples: - default: &564 + default: &563 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -89143,8 +91792,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: + - *324 - *325 - - *326 - *95 requestBody: required: true @@ -89167,9 +91816,9 @@ paths: description: Response content: application/json: - schema: *563 + schema: *562 examples: - default: *564 + default: *563 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89185,8 +91834,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: + - *324 - *325 - - *326 - *95 responses: '204': @@ -89208,8 +91857,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: + - *324 - *325 - - *326 - *95 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -89236,9 +91885,9 @@ paths: application/json: schema: type: array - items: *454 + items: *453 examples: - default: *522 + default: *521 headers: Link: *65 '404': *6 @@ -89259,8 +91908,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: + - *324 - *325 - - *326 - *95 requestBody: required: true @@ -89293,16 +91942,16 @@ paths: description: Reaction exists content: application/json: - schema: *454 + schema: *453 examples: - default: *455 + default: *454 '201': description: Reaction created content: application/json: - schema: *454 + schema: *453 examples: - default: *455 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -89324,10 +91973,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: + - *324 - *325 - - *326 - *95 - - *523 + - *522 responses: '204': description: Response @@ -89370,9 +92019,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: + - *324 - *325 - - *326 - - &567 + - &566 name: pull_number description: The number that identifies the pull request. in: path @@ -89385,9 +92034,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *565 + schema: *564 examples: - default: *566 + default: *565 '304': *35 '404': *6 '406': @@ -89422,9 +92071,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 requestBody: required: false content: @@ -89466,9 +92115,9 @@ paths: description: Response content: application/json: - schema: *565 + schema: *564 examples: - default: *566 + default: *565 '422': *15 '403': *27 x-github: @@ -89490,9 +92139,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 requestBody: required: true content: @@ -89553,17 +92202,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '401': *23 '403': *27 '404': *6 @@ -89593,9 +92242,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 - *103 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -89616,9 +92265,9 @@ paths: application/json: schema: type: array - items: *563 + items: *562 examples: - default: *568 + default: *567 headers: Link: *65 x-github: @@ -89651,9 +92300,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 requestBody: required: true content: @@ -89759,7 +92408,7 @@ paths: description: Response content: application/json: - schema: *563 + schema: *562 examples: example-for-a-multi-line-comment: value: @@ -89847,9 +92496,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: + - *324 - *325 - - *326 - - *567 + - *566 - *95 requestBody: required: true @@ -89872,7 +92521,7 @@ paths: description: Response content: application/json: - schema: *563 + schema: *562 examples: default: value: @@ -89958,9 +92607,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 - *17 - *19 responses: @@ -89970,9 +92619,9 @@ paths: application/json: schema: type: array - items: *456 + items: *455 examples: - default: *569 + default: *568 headers: Link: *65 x-github: @@ -90002,9 +92651,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: + - *324 - *325 - - *326 - - *567 + - *566 - *17 - *19 responses: @@ -90014,7 +92663,7 @@ paths: application/json: schema: type: array - items: *467 + items: *466 examples: default: value: @@ -90052,9 +92701,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: + - *324 - *325 - - *326 - - *567 + - *566 responses: '204': description: Response if pull request has been merged @@ -90077,9 +92726,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 requestBody: required: false content: @@ -90191,9 +92840,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 responses: '200': description: Response @@ -90209,7 +92858,7 @@ paths: items: *4 teams: type: array - items: *188 + items: *187 required: - users - teams @@ -90268,9 +92917,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 requestBody: required: false content: @@ -90307,7 +92956,7 @@ paths: description: Response content: application/json: - schema: *460 + schema: *459 examples: default: value: @@ -90843,9 +93492,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 requestBody: required: true content: @@ -90879,7 +93528,7 @@ paths: description: Response content: application/json: - schema: *460 + schema: *459 examples: default: value: @@ -91384,9 +94033,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 - *17 - *19 responses: @@ -91396,7 +94045,7 @@ paths: application/json: schema: type: array - items: &570 + items: &569 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -91552,9 +94201,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 requestBody: required: false content: @@ -91644,9 +94293,9 @@ paths: description: Response content: application/json: - schema: *570 + schema: *569 examples: - default: &572 + default: &571 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -91709,10 +94358,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 - - &571 + - *566 + - &570 name: review_id description: The unique identifier of the review. in: path @@ -91724,9 +94373,9 @@ paths: description: Response content: application/json: - schema: *570 + schema: *569 examples: - default: &573 + default: &572 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -91785,10 +94434,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 - - *571 + - *566 + - *570 requestBody: required: true content: @@ -91811,7 +94460,7 @@ paths: description: Response content: application/json: - schema: *570 + schema: *569 examples: default: value: @@ -91873,18 +94522,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 - - *571 + - *566 + - *570 responses: '200': description: Response content: application/json: - schema: *570 + schema: *569 examples: - default: *572 + default: *571 '422': *7 '404': *6 x-github: @@ -91911,10 +94560,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: + - *324 - *325 - - *326 - - *567 - - *571 + - *566 + - *570 - *17 - *19 responses: @@ -92012,9 +94661,9 @@ paths: _links: type: object properties: - self: *267 - html: *267 - pull_request: *267 + self: *266 + html: *266 + pull_request: *266 required: - self - html @@ -92172,10 +94821,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 - - *571 + - *566 + - *570 requestBody: required: true content: @@ -92204,7 +94853,7 @@ paths: description: Response content: application/json: - schema: *570 + schema: *569 examples: default: value: @@ -92267,10 +94916,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 - - *571 + - *566 + - *570 requestBody: required: true content: @@ -92305,9 +94954,9 @@ paths: description: Response content: application/json: - schema: *570 + schema: *569 examples: - default: *573 + default: *572 '404': *6 '422': *7 '403': *27 @@ -92329,9 +94978,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: + - *324 - *325 - - *326 - - *567 + - *566 requestBody: required: false content: @@ -92395,8 +95044,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: + - *324 - *325 - - *326 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -92409,9 +95058,9 @@ paths: description: Response content: application/json: - schema: *574 + schema: *573 examples: - default: &575 + default: &574 value: type: file encoding: base64 @@ -92453,8 +95102,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: + - *324 - *325 - - *326 - name: dir description: The alternate path to look for a README file in: path @@ -92474,9 +95123,9 @@ paths: description: Response content: application/json: - schema: *574 + schema: *573 examples: - default: *575 + default: *574 '404': *6 '422': *15 x-github: @@ -92498,8 +95147,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -92509,7 +95158,7 @@ paths: application/json: schema: type: array - items: *576 + items: *575 examples: default: value: @@ -92603,8 +95252,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -92680,9 +95329,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *575 examples: - default: &580 + default: &579 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -92787,9 +95436,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: + - *324 - *325 - - *326 - - &578 + - &577 name: asset_id description: The unique identifier of the asset. in: path @@ -92801,9 +95450,9 @@ paths: description: Response content: application/json: - schema: *577 + schema: *576 examples: - default: &579 + default: &578 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 @@ -92838,7 +95487,7 @@ paths: type: User site_admin: false '404': *6 - '302': *469 + '302': *468 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92854,9 +95503,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: + - *324 - *325 - - *326 - - *578 + - *577 requestBody: required: false content: @@ -92885,9 +95534,9 @@ paths: description: Response content: application/json: - schema: *577 + schema: *576 examples: - default: *579 + default: *578 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92903,9 +95552,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: + - *324 - *325 - - *326 - - *578 + - *577 responses: '204': description: Response @@ -92930,8 +95579,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -93017,16 +95666,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *576 + schema: *575 examples: - default: *580 + default: *579 '404': *6 x-github: githubCloudOnly: false @@ -93044,8 +95693,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: + - *324 - *325 - - *326 - name: tag description: tag parameter in: path @@ -93058,9 +95707,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *575 examples: - default: *580 + default: *579 '404': *6 x-github: githubCloudOnly: false @@ -93082,9 +95731,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: + - *324 - *325 - - *326 - - &581 + - &580 name: release_id description: The unique identifier of the release. in: path @@ -93098,9 +95747,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *576 + schema: *575 examples: - default: *580 + default: *579 '401': description: Unauthorized x-github: @@ -93118,9 +95767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: + - *324 - *325 - - *326 - - *581 + - *580 requestBody: required: false content: @@ -93184,9 +95833,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *575 examples: - default: *580 + default: *579 '404': description: Not Found if the discussion category name is invalid content: @@ -93207,9 +95856,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: + - *324 - *325 - - *326 - - *581 + - *580 responses: '204': description: Response @@ -93230,9 +95879,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: + - *324 - *325 - - *326 - - *581 + - *580 - *17 - *19 responses: @@ -93242,7 +95891,7 @@ paths: application/json: schema: type: array - items: *577 + items: *576 examples: default: value: @@ -93323,9 +95972,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: + - *324 - *325 - - *326 - - *581 + - *580 - name: name in: query required: true @@ -93351,7 +96000,7 @@ paths: description: Response for successful upload content: application/json: - schema: *577 + schema: *576 examples: response-for-successful-upload: value: @@ -93406,9 +96055,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: + - *324 - *325 - - *326 - - *581 + - *580 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -93432,9 +96081,9 @@ paths: application/json: schema: type: array - items: *454 + items: *453 examples: - default: *522 + default: *521 headers: Link: *65 '404': *6 @@ -93455,9 +96104,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: + - *324 - *325 - - *326 - - *581 + - *580 requestBody: required: true content: @@ -93487,16 +96136,16 @@ paths: description: Reaction exists content: application/json: - schema: *454 + schema: *453 examples: - default: *455 + default: *454 '201': description: Reaction created content: application/json: - schema: *454 + schema: *453 examples: - default: *455 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -93518,10 +96167,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: + - *324 - *325 - - *326 - - *581 - - *523 + - *580 + - *522 responses: '204': description: Response @@ -93545,9 +96194,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: + - *324 - *325 - - *326 - - *392 + - *391 - *17 - *19 responses: @@ -93563,8 +96212,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *287 - - &582 + - *286 + - &581 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -93583,69 +96232,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. + - allOf: + - *287 + - *581 - allOf: - *288 - - *582 + - *581 - allOf: - *289 - - *582 + - *581 - allOf: - - *290 - *582 + - *581 - allOf: - - *583 - - *582 + - *290 + - *581 - allOf: - *291 - - *582 + - *581 - allOf: - *292 - - *582 + - *581 - allOf: - *293 - - *582 + - *581 - allOf: - *294 - - *582 + - *581 - allOf: - *295 - - *582 + - *581 - allOf: - *296 - - *582 + - *581 - allOf: - *297 - - *582 + - *581 - allOf: - *298 - - *582 + - *581 - allOf: - *299 - - *582 + - *581 - allOf: - *300 - - *582 + - *581 - allOf: - *301 - - *582 + - *581 - allOf: - *302 - - *582 + - *581 - allOf: - *303 - - *582 + - *581 - allOf: - *304 - - *582 + - *581 - allOf: - *305 - - *582 + - *581 - allOf: - *306 - - *582 - - allOf: - - *307 - - *582 + - *581 examples: default: value: @@ -93684,8 +96333,8 @@ paths: category: repos subcategory: rules parameters: + - *324 - *325 - - *326 - *17 - *19 - name: includes_parents @@ -93696,7 +96345,7 @@ paths: schema: type: boolean default: true - - *584 + - *583 responses: '200': description: Response @@ -93704,7 +96353,7 @@ paths: application/json: schema: type: array - items: *308 + items: *307 examples: default: value: @@ -93751,8 +96400,8 @@ paths: category: repos subcategory: rules parameters: + - *324 - *325 - - *326 requestBody: description: Request body required: true @@ -93772,16 +96421,16 @@ paths: - tag - push default: branch - enforcement: *284 + enforcement: *283 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *285 - conditions: *282 + items: *284 + conditions: *281 rules: type: array description: An array of rules within the ruleset. - items: *585 + items: *584 required: - name - enforcement @@ -93812,9 +96461,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *307 examples: - default: &595 + default: &594 value: id: 42 name: super cool ruleset @@ -93862,12 +96511,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: + - *324 - *325 - - *326 + - *585 - *586 - *587 - *588 - - *589 - *17 - *19 responses: @@ -93875,9 +96524,9 @@ paths: description: Response content: application/json: - schema: *590 + schema: *589 examples: - default: *591 + default: *590 '404': *6 '500': *53 x-github: @@ -93898,17 +96547,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: + - *324 - *325 - - *326 - - *592 + - *591 responses: '200': description: Response content: application/json: - schema: *593 + schema: *592 examples: - default: *594 + default: *593 '404': *6 '500': *53 x-github: @@ -93936,8 +96585,8 @@ paths: category: repos subcategory: rules parameters: + - *324 - *325 - - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -93957,9 +96606,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *307 examples: - default: *595 + default: *594 '404': *6 '500': *53 put: @@ -93977,8 +96626,8 @@ paths: category: repos subcategory: rules parameters: + - *324 - *325 - - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -94003,16 +96652,16 @@ paths: - branch - tag - push - enforcement: *284 + enforcement: *283 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *285 - conditions: *282 + items: *284 + conditions: *281 rules: description: An array of rules within the ruleset. type: array - items: *585 + items: *584 examples: default: value: @@ -94040,9 +96689,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *307 examples: - default: *595 + default: *594 '404': *6 '422': *15 '500': *53 @@ -94061,8 +96710,8 @@ paths: category: repos subcategory: rules parameters: + - *324 - *325 - - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -94085,8 +96734,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: + - *324 - *325 - - *326 - *17 - *19 - name: ruleset_id @@ -94102,9 +96751,9 @@ paths: application/json: schema: type: array - items: *311 + items: *310 examples: - default: *596 + default: *595 '404': *6 '500': *53 x-github: @@ -94123,8 +96772,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: + - *324 - *325 - - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -94142,7 +96791,7 @@ paths: description: Response content: application/json: - schema: *597 + schema: *596 examples: default: value: @@ -94197,22 +96846,22 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: + - *324 - *325 - - *326 + - *597 - *598 - *599 - *600 - *601 - - *602 - *59 - *19 - *17 + - *602 - *603 - *604 - *605 - *606 - *607 - - *608 responses: '200': description: Response @@ -94220,24 +96869,24 @@ paths: application/json: schema: type: array - items: &612 + items: &611 type: object properties: - number: *171 - created_at: *172 + number: *170 + created_at: *171 updated_at: anyOf: - type: 'null' - - *173 - url: *174 - html_url: *175 + - *172 + url: *173 + html_url: *174 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *609 - resolution: *610 + state: *608 + resolution: *609 resolved_at: type: - string @@ -94331,7 +96980,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *611 + - *610 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -94476,16 +97125,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: + - *324 - *325 - - *326 - - *422 - - *608 + - *421 + - *607 responses: '200': description: Response content: application/json: - schema: *612 + schema: *611 examples: default: value: @@ -94539,9 +97188,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: + - *324 - *325 - - *326 - - *422 + - *421 requestBody: required: true content: @@ -94549,8 +97198,8 @@ paths: schema: type: object properties: - state: *609 - resolution: *610 + state: *608 + resolution: *609 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -94588,7 +97237,7 @@ paths: description: Response content: application/json: - schema: *612 + schema: *611 examples: default: value: @@ -94683,9 +97332,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: + - *324 - *325 - - *326 - - *422 + - *421 - *19 - *17 responses: @@ -94696,7 +97345,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &762 + items: &761 type: object properties: type: @@ -94723,6 +97372,7 @@ paths: - commit details: oneOf: + - *612 - *613 - *614 - *615 @@ -94735,7 +97385,6 @@ paths: - *622 - *623 - *624 - - *625 examples: default: value: @@ -94821,8 +97470,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -94830,14 +97479,14 @@ paths: schema: type: object properties: - reason: &627 + reason: &626 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *626 + placeholder_id: *625 required: - reason - placeholder_id @@ -94854,7 +97503,7 @@ paths: schema: type: object properties: - reason: *627 + reason: *626 expire_at: type: - string @@ -94901,8 +97550,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: + - *324 - *325 - - *326 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -94917,7 +97566,7 @@ paths: properties: incremental_scans: type: array - items: &628 + items: &627 description: Information on a single scan performed by secret scanning on the repository type: object @@ -94945,15 +97594,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *628 + items: *627 backfill_scans: type: array - items: *628 + items: *627 custom_pattern_backfill_scans: type: array items: allOf: - - *628 + - *627 - type: object properties: pattern_name: @@ -95023,8 +97672,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: + - *324 - *325 - - *326 - *59 - name: sort description: The property to sort the results by. @@ -95068,9 +97717,9 @@ paths: application/json: schema: type: array - items: *629 + items: *628 examples: - default: *630 + default: *629 '400': *14 '404': *6 x-github: @@ -95093,8 +97742,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -95174,7 +97823,7 @@ paths: login: type: string description: The username of the user credited. - type: *314 + type: *313 required: - login - type @@ -95264,9 +97913,9 @@ paths: description: Response content: application/json: - schema: *629 + schema: *628 examples: - default: &632 + default: &631 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -95499,8 +98148,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -95613,7 +98262,7 @@ paths: description: Response content: application/json: - schema: *629 + schema: *628 examples: default: value: @@ -95760,17 +98409,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: + - *324 - *325 - - *326 - - *631 + - *630 responses: '200': description: Response content: application/json: - schema: *629 + schema: *628 examples: - default: *632 + default: *631 '403': *27 '404': *6 x-github: @@ -95794,9 +98443,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: + - *324 - *325 - - *326 - - *631 + - *630 requestBody: required: true content: @@ -95876,7 +98525,7 @@ paths: login: type: string description: The username of the user credited. - type: *314 + type: *313 required: - login - type @@ -95967,10 +98616,10 @@ paths: description: Response content: application/json: - schema: *629 + schema: *628 examples: - default: *632 - add_credit: *632 + default: *631 + add_credit: *631 '403': *27 '404': *6 '422': @@ -96008,9 +98657,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: + - *324 - *325 - - *326 - - *631 + - *630 responses: '202': *37 '400': *14 @@ -96037,17 +98686,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: + - *324 - *325 - - *326 - - *631 + - *630 responses: '202': description: Response content: application/json: - schema: *328 + schema: *327 examples: - default: *330 + default: *329 '400': *14 '422': *15 '403': *27 @@ -96073,8 +98722,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -96170,8 +98819,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: + - *324 - *325 - - *326 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -96180,7 +98829,7 @@ paths: application/json: schema: type: array - items: &633 + items: &632 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -96193,7 +98842,7 @@ paths: - 1124 - -435 '202': *37 - '204': *184 + '204': *183 '422': description: Repository contains more than 10,000 commits x-github: @@ -96213,8 +98862,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -96265,7 +98914,7 @@ paths: total: 89 week: 1336280400 '202': *37 - '204': *184 + '204': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96292,8 +98941,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -96365,7 +99014,7 @@ paths: d: 77 c: 10 '202': *37 - '204': *184 + '204': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96387,8 +99036,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: + - *324 - *325 - - *326 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -96542,8 +99191,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: + - *324 - *325 - - *326 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -96553,7 +99202,7 @@ paths: application/json: schema: type: array - items: *633 + items: *632 examples: default: value: @@ -96566,7 +99215,7 @@ paths: - - 0 - 2 - 21 - '204': *184 + '204': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96586,8 +99235,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: + - *324 - *325 - - *326 - name: sha in: path required: true @@ -96643,7 +99292,7 @@ paths: description: Response content: application/json: - schema: *634 + schema: *633 examples: default: value: @@ -96697,8 +99346,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -96730,14 +99379,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: + - *324 - *325 - - *326 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &635 + schema: &634 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -96810,8 +99459,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: + - *324 - *325 - - *326 requestBody: required: false content: @@ -96837,7 +99486,7 @@ paths: description: Response content: application/json: - schema: *635 + schema: *634 examples: default: value: @@ -96864,8 +99513,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -96885,8 +99534,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -96968,8 +99617,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: + - *324 - *325 - - *326 - name: ref in: path required: true @@ -97005,8 +99654,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -97016,9 +99665,9 @@ paths: application/json: schema: type: array - items: *188 + items: *187 examples: - default: *246 + default: *245 headers: Link: *65 '404': *6 @@ -97038,8 +99687,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: + - *324 - *325 - - *326 - *19 - *17 responses: @@ -97047,7 +99696,7 @@ paths: description: Response content: application/json: - schema: &636 + schema: &635 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -97059,7 +99708,7 @@ paths: required: - names examples: - default: &637 + default: &636 value: names: - octocat @@ -97082,8 +99731,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -97114,9 +99763,9 @@ paths: description: Response content: application/json: - schema: *636 + schema: *635 examples: - default: *637 + default: *636 '404': *6 '422': *7 x-github: @@ -97137,9 +99786,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: + - *324 - *325 - - *326 - - &638 + - &637 name: per description: The time frame to display results for. in: query @@ -97170,7 +99819,7 @@ paths: - 128 clones: type: array - items: &639 + items: &638 title: Traffic type: object properties: @@ -97257,8 +99906,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -97352,8 +100001,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -97416,9 +100065,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: + - *324 - *325 - - *326 - - *638 + - *637 responses: '200': description: Response @@ -97439,7 +100088,7 @@ paths: - 3782 views: type: array - items: *639 + items: *638 required: - uniques - count @@ -97516,8 +100165,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -97553,7 +100202,7 @@ paths: description: Response content: application/json: - schema: *153 + schema: *152 examples: default: value: @@ -97791,8 +100440,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: + - *324 - *325 - - *326 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -97815,8 +100464,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -97838,8 +100487,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -97865,8 +100514,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: + - *324 - *325 - - *326 - name: ref in: path required: true @@ -97958,9 +100607,9 @@ paths: description: Response content: application/json: - schema: *328 + schema: *327 examples: - default: *330 + default: *329 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -98001,7 +100650,7 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: default: value: @@ -98107,8 +100756,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *142 - - *526 + - *141 + - *525 requestBody: required: true content: @@ -98174,9 +100823,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *529 + items: *528 examples: - default: *640 + default: *639 '400': *14 '403': *27 '404': *6 @@ -98212,8 +100861,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *142 - - *526 + - *141 + - *525 requestBody: required: true content: @@ -98280,9 +100929,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *529 + items: *528 examples: - default: *640 + default: *639 '400': *14 '403': *27 '404': *6 @@ -98313,9 +100962,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue parameters: - - *142 - - *526 - - *229 + - *141 + - *525 + - *228 responses: '204': description: Issue field value deleted successfully @@ -98436,7 +101085,7 @@ paths: html_url: type: string format: uri - repository: *153 + repository: *152 score: type: number file_size: @@ -98455,7 +101104,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &641 + text_matches: &640 title: Search Result Text Matches type: array items: @@ -98618,7 +101267,7 @@ paths: enum: - author-date - committer-date - - &642 + - &641 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 @@ -98687,7 +101336,7 @@ paths: committer: anyOf: - type: 'null' - - *390 + - *389 comment_count: type: integer message: @@ -98706,7 +101355,7 @@ paths: url: type: string format: uri - verification: *506 + verification: *505 required: - author - committer @@ -98721,7 +101370,7 @@ paths: committer: anyOf: - type: 'null' - - *390 + - *389 parents: type: array items: @@ -98733,12 +101382,12 @@ paths: type: string sha: type: string - repository: *153 + repository: *152 score: type: number node_id: type: string - text_matches: *641 + text_matches: *640 required: - sha - node_id @@ -98930,7 +101579,7 @@ paths: - interactions - created - updated - - *642 + - *641 - *17 - *19 - name: advanced_search @@ -99044,11 +101693,11 @@ paths: type: - string - 'null' - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: type: string state_reason: @@ -99062,7 +101711,7 @@ paths: milestone: anyOf: - type: 'null' - - *266 + - *265 comments: type: integer created_at: @@ -99076,7 +101725,7 @@ paths: - string - 'null' format: date-time - text_matches: *641 + text_matches: *640 pull_request: type: object properties: @@ -99125,7 +101774,7 @@ paths: timeline_url: type: string format: uri - type: *230 + type: *229 performed_via_github_app: anyOf: - type: 'null' @@ -99342,7 +101991,7 @@ paths: enum: - created - updated - - *642 + - *641 - *17 - *19 responses: @@ -99387,7 +102036,7 @@ paths: - 'null' score: type: number - text_matches: *641 + text_matches: *640 required: - id - node_id @@ -99472,7 +102121,7 @@ paths: - forks - help-wanted-issues - updated - - *642 + - *641 - *17 - *19 responses: @@ -99718,7 +102367,7 @@ paths: - admin - pull - push - text_matches: *641 + text_matches: *640 temp_clone_token: type: string allow_merge_commit: @@ -100026,7 +102675,7 @@ paths: - string - 'null' format: uri - text_matches: *641 + text_matches: *640 related: type: - array @@ -100219,7 +102868,7 @@ paths: - followers - repositories - joined - - *642 + - *641 - *17 - *19 responses: @@ -100329,7 +102978,7 @@ paths: type: - boolean - 'null' - text_matches: *641 + text_matches: *640 blog: type: - string @@ -100411,7 +103060,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &645 + - &644 name: team_id description: The unique identifier of the team. in: path @@ -100423,9 +103072,9 @@ paths: description: Response content: application/json: - schema: *321 + schema: *320 examples: - default: *322 + default: *321 '404': *6 x-github: githubCloudOnly: false @@ -100452,7 +103101,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *645 + - *644 requestBody: required: true content: @@ -100516,16 +103165,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *321 + schema: *320 examples: - default: *322 + default: *321 '201': description: Response content: application/json: - schema: *321 + schema: *320 examples: - default: *322 + default: *321 '404': *6 '422': *15 '403': *27 @@ -100553,7 +103202,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *645 + - *644 responses: '204': description: Response @@ -100582,7 +103231,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *645 + - *644 - *17 - *19 responses: @@ -100592,9 +103241,9 @@ paths: application/json: schema: type: array - items: *224 + items: *223 examples: - default: *225 + default: *224 headers: Link: *65 x-github: @@ -100620,7 +103269,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *645 + - *644 - name: role description: Filters members returned by their role in the team. in: query @@ -100671,7 +103320,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *645 + - *644 - *69 responses: '204': @@ -100708,7 +103357,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *645 + - *644 - *69 responses: '204': @@ -100748,7 +103397,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *645 + - *644 - *69 responses: '204': @@ -100785,16 +103434,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *645 + - *644 - *69 responses: '200': description: Response content: application/json: - schema: *324 + schema: *323 examples: - response-if-user-is-a-team-maintainer: *646 + response-if-user-is-a-team-maintainer: *645 '404': *6 x-github: githubCloudOnly: false @@ -100827,7 +103476,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *645 + - *644 - *69 requestBody: required: false @@ -100853,9 +103502,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *323 examples: - response-if-users-membership-with-team-is-now-pending: *647 + response-if-users-membership-with-team-is-now-pending: *646 '403': description: Forbidden if team synchronization is set up '422': @@ -100889,7 +103538,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *645 + - *644 - *69 responses: '204': @@ -100917,7 +103566,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *645 + - *644 - *17 - *19 responses: @@ -100927,9 +103576,9 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: - default: *253 + default: *252 headers: Link: *65 '404': *6 @@ -100959,15 +103608,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *645 + - *644 + - *324 - *325 - - *326 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *648 + schema: *647 examples: alternative-response-with-extra-repository-information: value: @@ -101118,9 +103767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *645 + - *644 + - *324 - *325 - - *326 requestBody: required: false content: @@ -101170,9 +103819,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *645 + - *644 + - *324 - *325 - - *326 responses: '204': description: Response @@ -101197,7 +103846,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *645 + - *644 - *17 - *19 responses: @@ -101207,9 +103856,9 @@ paths: application/json: schema: type: array - items: *188 + items: *187 examples: - response-if-child-teams-exist: *649 + response-if-child-teams-exist: *648 headers: Link: *65 '404': *6 @@ -101242,7 +103891,7 @@ paths: application/json: schema: oneOf: - - &651 + - &650 title: Private User description: Private User type: object @@ -101492,7 +104141,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *650 + - *649 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -101652,7 +104301,7 @@ paths: description: Response content: application/json: - schema: *651 + schema: *650 examples: default: value: @@ -101855,9 +104504,9 @@ paths: type: integer codespaces: type: array - items: *235 + items: *234 examples: - default: *236 + default: *235 '304': *35 '500': *53 '401': *23 @@ -101996,17 +104645,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '401': *23 '403': *27 '404': *6 @@ -102050,7 +104699,7 @@ paths: type: integer secrets: type: array - items: &652 + items: &651 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -102092,7 +104741,7 @@ paths: - visibility - selected_repositories_url examples: - default: *447 + default: *446 headers: Link: *65 x-github: @@ -102164,13 +104813,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *161 + - *160 responses: '200': description: Response content: application/json: - schema: *652 + schema: *651 examples: default: value: @@ -102200,7 +104849,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *161 + - *160 requestBody: required: true content: @@ -102245,7 +104894,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -102273,7 +104922,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *161 + - *160 responses: '204': description: Response @@ -102298,7 +104947,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *161 + - *160 responses: '200': description: Response @@ -102314,9 +104963,9 @@ paths: type: integer repositories: type: array - items: *153 + items: *152 examples: - default: *189 + default: *188 '401': *23 '403': *27 '404': *6 @@ -102341,7 +104990,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *161 + - *160 requestBody: required: true content: @@ -102395,7 +105044,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *161 + - *160 - name: repository_id in: path required: true @@ -102428,7 +105077,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *161 + - *160 - name: repository_id in: path required: true @@ -102460,15 +105109,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *237 + - *236 responses: '200': description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '304': *35 '500': *53 '401': *23 @@ -102494,7 +105143,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *237 + - *236 requestBody: required: false content: @@ -102524,9 +105173,9 @@ paths: description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '401': *23 '403': *27 '404': *6 @@ -102548,7 +105197,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *237 + - *236 responses: '202': *37 '304': *35 @@ -102577,13 +105226,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *237 + - *236 responses: '202': description: Response content: application/json: - schema: &653 + schema: &652 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -102636,7 +105285,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &654 + default: &653 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -102668,7 +105317,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *237 + - *236 - name: export_id in: path required: true @@ -102681,9 +105330,9 @@ paths: description: Response content: application/json: - schema: *653 + schema: *652 examples: - default: *654 + default: *653 '404': *6 x-github: githubCloudOnly: false @@ -102704,7 +105353,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *237 + - *236 responses: '200': description: Response @@ -102720,9 +105369,9 @@ paths: type: integer machines: type: array - items: *446 + items: *445 examples: - default: *655 + default: *654 '304': *35 '500': *53 '401': *23 @@ -102751,7 +105400,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *237 + - *236 requestBody: required: true content: @@ -102807,11 +105456,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *328 + repository: *327 machine: anyOf: - type: 'null' - - *446 + - *445 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -103608,15 +106257,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *237 + - *236 responses: '200': description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '304': *35 '500': *53 '400': *14 @@ -103648,15 +106297,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *237 + - *236 responses: '200': description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '500': *53 '401': *23 '403': *27 @@ -103686,9 +106335,9 @@ paths: application/json: schema: type: array - items: *247 + items: *246 examples: - default: &666 + default: &665 value: - id: 197 name: hello_docker @@ -103789,7 +106438,7 @@ paths: application/json: schema: type: array - items: &656 + items: &655 title: Email description: Email type: object @@ -103859,9 +106508,9 @@ paths: application/json: schema: type: array - items: *656 + items: *655 examples: - default: &668 + default: &667 value: - email: octocat@github.com verified: true @@ -103938,7 +106587,7 @@ paths: application/json: schema: type: array - items: *656 + items: *655 examples: default: value: @@ -104196,7 +106845,7 @@ paths: application/json: schema: type: array - items: &657 + items: &656 title: GPG Key description: A unique encryption key type: object @@ -104341,7 +106990,7 @@ paths: - subkeys - revoked examples: - default: &684 + default: &683 value: - id: 3 name: Octocat's GPG Key @@ -104426,9 +107075,9 @@ paths: description: Response content: application/json: - schema: *657 + schema: *656 examples: - default: &658 + default: &657 value: id: 3 name: Octocat's GPG Key @@ -104485,7 +107134,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &659 + - &658 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -104497,9 +107146,9 @@ paths: description: Response content: application/json: - schema: *657 + schema: *656 examples: - default: *658 + default: *657 '404': *6 '304': *35 '403': *27 @@ -104522,7 +107171,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *659 + - *658 responses: '204': description: Response @@ -104715,7 +107364,7 @@ paths: allOf: - *77 examples: - default: *145 + default: *144 headers: Link: *65 '404': *6 @@ -104741,7 +107390,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *142 + - *141 responses: '204': description: Response @@ -104767,7 +107416,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *142 + - *141 responses: '204': description: Response @@ -104801,12 +107450,12 @@ paths: application/json: schema: anyOf: - - *222 + - *221 - type: object properties: {} additionalProperties: false examples: - default: *223 + default: *222 '204': description: Response when there are no restrictions x-github: @@ -104830,7 +107479,7 @@ paths: required: true content: application/json: - schema: *517 + schema: *516 examples: default: value: @@ -104841,7 +107490,7 @@ paths: description: Response content: application/json: - schema: *222 + schema: *221 examples: default: value: @@ -104922,7 +107571,7 @@ paths: - closed - all default: open - - *233 + - *232 - name: sort description: What to sort results by. in: query @@ -104947,7 +107596,7 @@ paths: type: array items: *81 examples: - default: *234 + default: *233 headers: Link: *65 '404': *6 @@ -104980,7 +107629,7 @@ paths: application/json: schema: type: array - items: &660 + items: &659 title: Key description: Key type: object @@ -105083,9 +107732,9 @@ paths: description: Response content: application/json: - schema: *660 + schema: *659 examples: - default: &661 + default: &660 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -105118,15 +107767,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *547 + - *546 responses: '200': description: Response content: application/json: - schema: *660 + schema: *659 examples: - default: *661 + default: *660 '404': *6 '304': *35 '403': *27 @@ -105149,7 +107798,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *547 + - *546 responses: '204': description: Response @@ -105182,7 +107831,7 @@ paths: application/json: schema: type: array - items: &662 + items: &661 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -105261,7 +107910,7 @@ paths: - account - plan examples: - default: &663 + default: &662 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -105323,9 +107972,9 @@ paths: application/json: schema: type: array - items: *662 + items: *661 examples: - default: *663 + default: *662 headers: Link: *65 '304': *35 @@ -105365,7 +108014,7 @@ paths: application/json: schema: type: array - items: *239 + items: *238 examples: default: value: @@ -105479,7 +108128,7 @@ paths: description: Response content: application/json: - schema: *239 + schema: *238 examples: default: value: @@ -105566,7 +108215,7 @@ paths: description: Response content: application/json: - schema: *239 + schema: *238 examples: default: value: @@ -105638,7 +108287,7 @@ paths: application/json: schema: type: array - items: *241 + items: *240 examples: default: value: @@ -105900,7 +108549,7 @@ paths: description: Response content: application/json: - schema: *241 + schema: *240 examples: default: value: @@ -106080,7 +108729,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *242 + - *241 - name: exclude in: query required: false @@ -106093,7 +108742,7 @@ paths: description: Response content: application/json: - schema: *241 + schema: *240 examples: default: value: @@ -106287,7 +108936,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *242 + - *241 responses: '302': description: Response @@ -106313,7 +108962,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *242 + - *241 responses: '204': description: Response @@ -106342,8 +108991,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *242 - - *664 + - *241 + - *663 responses: '204': description: Response @@ -106367,7 +109016,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *242 + - *241 - *17 - *19 responses: @@ -106377,9 +109026,9 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: - default: *253 + default: *252 headers: Link: *65 '404': *6 @@ -106458,7 +109107,7 @@ paths: - docker - nuget - container - - *665 + - *664 - *19 - *17 responses: @@ -106468,10 +109117,10 @@ paths: application/json: schema: type: array - items: *247 + items: *246 examples: - default: *666 - '400': *667 + default: *665 + '400': *666 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106491,16 +109140,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: + - *248 - *249 - - *250 responses: '200': description: Response content: application/json: - schema: *247 + schema: *246 examples: - default: &685 + default: &684 value: id: 40201 name: octo-name @@ -106613,8 +109262,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: + - *248 - *249 - - *250 responses: '204': description: Response @@ -106644,8 +109293,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: + - *248 - *249 - - *250 - name: token description: package token schema: @@ -106677,8 +109326,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: + - *248 - *249 - - *250 - *19 - *17 - name: state @@ -106698,7 +109347,7 @@ paths: application/json: schema: type: array - items: *251 + items: *250 examples: default: value: @@ -106747,15 +109396,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: + - *248 - *249 - - *250 - - *252 + - *251 responses: '200': description: Response content: application/json: - schema: *251 + schema: *250 examples: default: value: @@ -106791,9 +109440,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: + - *248 - *249 - - *250 - - *252 + - *251 responses: '204': description: Response @@ -106823,9 +109472,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: + - *248 - *249 - - *250 - - *252 + - *251 responses: '204': description: Response @@ -106862,9 +109511,9 @@ paths: application/json: schema: type: array - items: *656 + items: *655 examples: - default: *668 + default: *667 headers: Link: *65 '304': *35 @@ -106977,7 +109626,7 @@ paths: type: array items: *77 examples: - default: &675 + default: &674 summary: Default response value: - id: 1296269 @@ -107295,9 +109944,9 @@ paths: description: Response content: application/json: - schema: *328 + schema: *327 examples: - default: *330 + default: *329 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -107335,9 +109984,9 @@ paths: application/json: schema: type: array - items: *519 + items: *518 examples: - default: *669 + default: *668 headers: Link: *65 '304': *35 @@ -107360,7 +110009,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *226 + - *225 responses: '204': description: Response @@ -107383,7 +110032,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *226 + - *225 responses: '204': description: Response @@ -107416,7 +110065,7 @@ paths: application/json: schema: type: array - items: &670 + items: &669 title: Social account description: Social media account type: object @@ -107433,7 +110082,7 @@ paths: - provider - url examples: - default: &671 + default: &670 value: - provider: twitter url: https://twitter.com/github @@ -107496,9 +110145,9 @@ paths: application/json: schema: type: array - items: *670 + items: *669 examples: - default: *671 + default: *670 '422': *15 '304': *35 '404': *6 @@ -107586,7 +110235,7 @@ paths: application/json: schema: type: array - items: &672 + items: &671 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -107606,7 +110255,7 @@ paths: - title - created_at examples: - default: &703 + default: &702 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -107671,9 +110320,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *671 examples: - default: &673 + default: &672 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -107703,7 +110352,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: - - &674 + - &673 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -107715,9 +110364,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *671 examples: - default: *673 + default: *672 '404': *6 '304': *35 '403': *27 @@ -107740,7 +110389,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: - - *674 + - *673 responses: '204': description: Response @@ -107769,7 +110418,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &704 + - &703 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 @@ -107794,11 +110443,11 @@ paths: type: array items: *77 examples: - default-response: *675 + default-response: *674 application/vnd.github.v3.star+json: schema: type: array - items: &705 + items: &704 title: Starred Repository description: Starred Repository type: object @@ -107954,8 +110603,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: + - *324 - *325 - - *326 responses: '204': description: Response if this repository is starred by you @@ -107983,8 +110632,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -108008,8 +110657,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -108042,9 +110691,9 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: - default: *253 + default: *252 headers: Link: *65 '304': *35 @@ -108081,7 +110730,7 @@ paths: application/json: schema: type: array - items: *321 + items: *320 examples: default: value: @@ -108167,10 +110816,10 @@ paths: application/json: schema: oneOf: - - *651 - *650 + - *649 examples: - default-response: &679 + default-response: &678 summary: Default response value: login: octocat @@ -108205,7 +110854,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &680 + response-with-git-hub-plan-information: &679 summary: Response with GitHub plan information value: login: octocat @@ -108262,14 +110911,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &677 + - &676 name: user_id description: The unique identifier of the user. in: path required: true schema: type: string - - *265 + - *264 requestBody: required: true description: Details of the draft item to create in the project. @@ -108303,9 +110952,9 @@ paths: description: Response content: application/json: - schema: *270 + schema: *269 examples: - draft_issue: *271 + draft_issue: *270 '304': *35 '403': *27 '401': *23 @@ -108328,7 +110977,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *676 + - *675 - *17 responses: '200': @@ -108363,8 +111012,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *677 - - *265 + - *676 + - *264 requestBody: required: true content: @@ -108438,17 +111087,17 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *678 + schema: *677 examples: table_view: summary: Response for creating a table view - value: *275 + value: *274 board_view: summary: Response for creating a board view with filter - value: *275 + value: *274 roadmap_view: summary: Response for creating a roadmap view - value: *275 + value: *274 '304': *35 '403': *27 '401': *23 @@ -108490,11 +111139,11 @@ paths: application/json: schema: oneOf: - - *651 - *650 + - *649 examples: - default-response: *679 - response-with-git-hub-plan-information: *680 + default-response: *678 + response-with-git-hub-plan-information: *679 '404': *6 x-github: githubCloudOnly: false @@ -108544,8 +111193,8 @@ paths: required: - subject_digests examples: - default: *681 - withPredicateType: *682 + default: *680 + withPredicateType: *681 responses: '200': description: Response @@ -108599,7 +111248,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *683 + default: *682 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108804,12 +111453,12 @@ paths: initiator: type: string examples: - default: *386 + default: *385 '201': description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -108843,9 +111492,9 @@ paths: application/json: schema: type: array - items: *247 + items: *246 examples: - default: *666 + default: *665 '403': *27 '401': *23 x-github: @@ -109229,9 +111878,9 @@ paths: application/json: schema: type: array - items: *657 + items: *656 examples: - default: *684 + default: *683 headers: Link: *65 x-github: @@ -109335,7 +111984,7 @@ paths: application/json: schema: *20 examples: - default: *516 + default: *515 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -109460,7 +112109,7 @@ paths: - docker - nuget - container - - *665 + - *664 - *69 - *19 - *17 @@ -109471,12 +112120,12 @@ paths: application/json: schema: type: array - items: *247 + items: *246 examples: - default: *666 + default: *665 '403': *27 '401': *23 - '400': *667 + '400': *666 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -109496,17 +112145,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: + - *248 - *249 - - *250 - *69 responses: '200': description: Response content: application/json: - schema: *247 + schema: *246 examples: - default: *685 + default: *684 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -109527,8 +112176,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: + - *248 - *249 - - *250 - *69 responses: '204': @@ -109561,8 +112210,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: + - *248 - *249 - - *250 - *69 - name: token description: package token @@ -109595,8 +112244,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: + - *248 - *249 - - *250 - *69 responses: '200': @@ -109605,7 +112254,7 @@ paths: application/json: schema: type: array - items: *251 + items: *250 examples: default: value: @@ -109663,16 +112312,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: + - *248 - *249 - - *250 - - *252 + - *251 - *69 responses: '200': description: Response content: application/json: - schema: *251 + schema: *250 examples: default: value: @@ -109707,10 +112356,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: + - *248 - *249 - - *250 - *69 - - *252 + - *251 responses: '204': description: Response @@ -109742,10 +112391,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: + - *248 - *249 - - *250 - *69 - - *252 + - *251 responses: '204': description: Response @@ -109786,9 +112435,9 @@ paths: application/json: schema: type: array - items: *263 + items: *262 examples: - default: *264 + default: *263 headers: Link: *65 '304': *35 @@ -109810,16 +112459,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *265 + - *264 - *69 responses: '200': description: Response content: application/json: - schema: *263 + schema: *262 examples: - default: *264 + default: *263 headers: Link: *65 '304': *35 @@ -109841,7 +112490,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *265 + - *264 - *69 - *17 - *45 @@ -109853,9 +112502,9 @@ paths: application/json: schema: type: array - items: *268 + items: *267 examples: - default: *686 + default: *685 headers: Link: *65 '304': *35 @@ -109877,7 +112526,7 @@ paths: url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project parameters: - *69 - - *265 + - *264 requestBody: required: true content: @@ -109915,7 +112564,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *687 + items: *686 required: - name - data_type @@ -109931,7 +112580,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *688 + iteration_configuration: *687 required: - name - data_type @@ -109953,20 +112602,20 @@ paths: value: name: Due date data_type: date - single_select_field: *689 - iteration_field: *690 + single_select_field: *688 + iteration_field: *689 responses: '201': description: Response content: application/json: - schema: *268 + schema: *267 examples: - text_field: *691 - number_field: *692 - date_field: *693 - single_select_field: *694 - iteration_field: *695 + text_field: *690 + number_field: *691 + date_field: *692 + single_select_field: *693 + iteration_field: *694 '304': *35 '403': *27 '401': *23 @@ -109987,17 +112636,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *265 - - *696 + - *264 + - *695 - *69 responses: '200': description: Response content: application/json: - schema: *268 + schema: *267 examples: - default: *697 + default: *696 headers: Link: *65 '304': *35 @@ -110020,7 +112669,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *265 + - *264 - *69 - *45 - *46 @@ -110053,9 +112702,9 @@ paths: application/json: schema: type: array - items: *272 + items: *271 examples: - default: *273 + default: *272 headers: Link: *65 '304': *35 @@ -110077,7 +112726,7 @@ paths: url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - *69 - - *265 + - *264 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -110147,22 +112796,22 @@ paths: description: Response content: application/json: - schema: *270 + schema: *269 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *271 + value: *270 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *271 + value: *270 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *271 + value: *270 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *271 + value: *270 '304': *35 '403': *27 '401': *23 @@ -110182,9 +112831,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *265 + - *264 - *69 - - *274 + - *273 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -110204,9 +112853,9 @@ paths: description: Response content: application/json: - schema: *272 + schema: *271 examples: - default: *273 + default: *272 headers: Link: *65 '304': *35 @@ -110227,9 +112876,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *265 + - *264 - *69 - - *274 + - *273 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -110302,13 +112951,13 @@ paths: description: Response content: application/json: - schema: *272 + schema: *271 examples: - text_field: *273 - number_field: *273 - date_field: *273 - single_select_field: *273 - iteration_field: *273 + text_field: *272 + number_field: *272 + date_field: *272 + single_select_field: *272 + iteration_field: *272 '401': *23 '403': *27 '404': *6 @@ -110328,9 +112977,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *265 + - *264 - *69 - - *274 + - *273 responses: '204': description: Response @@ -110352,9 +113001,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-project-view parameters: - - *265 + - *264 - *69 - - *698 + - *697 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -110380,9 +113029,9 @@ paths: application/json: schema: type: array - items: *272 + items: *271 examples: - default: *273 + default: *272 headers: Link: *65 '304': *35 @@ -110601,9 +113250,9 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: - default: *253 + default: *252 headers: Link: *65 x-github: @@ -110629,7 +113278,7 @@ paths: - *115 - *117 - *116 - - *699 + - *698 - *118 responses: '200': @@ -110760,7 +113409,7 @@ paths: parameters: - *69 - *115 - - *700 + - *699 - *116 responses: '200': @@ -110859,9 +113508,9 @@ paths: - *115 - *117 - *116 - - *701 + - *700 - *118 - - *702 + - *701 responses: '200': description: Response when getting a billing usage summary @@ -110995,9 +113644,9 @@ paths: application/json: schema: type: array - items: *670 + items: *669 examples: - default: *671 + default: *670 headers: Link: *65 x-github: @@ -111027,9 +113676,9 @@ paths: application/json: schema: type: array - items: *672 + items: *671 examples: - default: *703 + default: *702 headers: Link: *65 x-github: @@ -111054,7 +113703,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *69 - - *704 + - *703 - *59 - *17 - *19 @@ -111066,11 +113715,11 @@ paths: schema: anyOf: - type: array - items: *705 + items: *704 - type: array items: *77 examples: - default-response: *675 + default-response: *674 headers: Link: *65 x-github: @@ -111099,9 +113748,9 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: - default: *253 + default: *252 headers: Link: *65 x-github: @@ -111230,7 +113879,7 @@ webhooks: type: string enum: - disabled - enterprise: &706 + enterprise: &705 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -111299,7 +113948,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &707 + installation: &706 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -111320,7 +113969,7 @@ webhooks: required: - id - node_id - organization: &708 + organization: &707 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -111393,7 +114042,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &709 + repository: &708 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -112319,10 +114968,10 @@ webhooks: type: string enum: - enabled - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -112398,11 +115047,11 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - rule: &710 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + rule: &709 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) @@ -112625,11 +115274,11 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - rule: *710 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + rule: *709 sender: *4 required: - action @@ -112817,11 +115466,11 @@ webhooks: - everyone required: - from - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - rule: *710 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + rule: *709 sender: *4 required: - action @@ -112905,7 +115554,7 @@ webhooks: type: string enum: - completed - check_run: &712 + check_run: &711 title: CheckRun description: A check performed on the code of a given code change type: object @@ -112971,7 +115620,7 @@ webhooks: pull_requests: type: array items: *84 - repository: *153 + repository: *152 status: type: string enum: @@ -113015,7 +115664,7 @@ webhooks: - examples: - neutral - deployment: *711 + deployment: *710 details_url: type: string examples: @@ -113113,10 +115762,10 @@ webhooks: - output - app - pull_requests - installation: *707 - enterprise: *706 - organization: *708 - repository: *709 + installation: *706 + enterprise: *705 + organization: *707 + repository: *708 sender: *4 required: - check_run @@ -113507,11 +116156,11 @@ webhooks: type: string enum: - created - check_run: *712 - installation: *707 - enterprise: *706 - organization: *708 - repository: *709 + check_run: *711 + installation: *706 + enterprise: *705 + organization: *707 + repository: *708 sender: *4 required: - check_run @@ -113905,11 +116554,11 @@ webhooks: type: string enum: - requested_action - check_run: *712 - installation: *707 - enterprise: *706 - organization: *708 - repository: *709 + check_run: *711 + installation: *706 + enterprise: *705 + organization: *707 + repository: *708 requested_action: description: The action requested by the user. type: object @@ -114312,11 +116961,11 @@ webhooks: type: string enum: - rerequested - check_run: *712 - installation: *707 - enterprise: *706 - organization: *708 - repository: *709 + check_run: *711 + installation: *706 + enterprise: *705 + organization: *707 + repository: *708 sender: *4 required: - check_run @@ -115301,10 +117950,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -116008,10 +118657,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -116709,10 +119358,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -116881,7 +119530,7 @@ webhooks: required: - login - id - dismissed_comment: *417 + dismissed_comment: *416 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -117033,20 +119682,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &713 + commit_oid: &712 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: *706 - installation: *707 - organization: *708 - ref: &714 + enterprise: *705 + installation: *706 + organization: *707 + ref: &713 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: *709 + repository: *708 sender: *4 required: - action @@ -117213,7 +119862,7 @@ webhooks: required: - login - id - dismissed_comment: *417 + dismissed_comment: *416 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -117454,12 +120103,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *713 - enterprise: *706 - installation: *707 - organization: *708 - ref: *714 - repository: *709 + commit_oid: *712 + enterprise: *705 + installation: *706 + organization: *707 + ref: *713 + repository: *708 sender: *4 required: - action @@ -117557,7 +120206,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *417 + dismissed_comment: *416 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -117742,12 +120391,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *713 - enterprise: *706 - installation: *707 - organization: *708 - ref: *714 - repository: *709 + commit_oid: *712 + enterprise: *705 + installation: *706 + organization: *707 + ref: *713 + repository: *708 sender: *4 required: - action @@ -117916,7 +120565,7 @@ webhooks: required: - login - id - dismissed_comment: *417 + dismissed_comment: *416 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -118093,12 +120742,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *713 - enterprise: *706 - installation: *707 - organization: *708 - ref: *714 - repository: *709 + commit_oid: *712 + enterprise: *705 + installation: *706 + organization: *707 + ref: *713 + repository: *708 sender: *4 required: - action @@ -118199,7 +120848,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *417 + dismissed_comment: *416 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -118388,9 +121037,9 @@ webhooks: type: - string - 'null' - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -118398,7 +121047,7 @@ webhooks: type: - string - 'null' - repository: *709 + repository: *708 sender: *4 required: - action @@ -118497,7 +121146,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *417 + dismissed_comment: *416 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -118644,12 +121293,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *713 - enterprise: *706 - installation: *707 - organization: *708 - ref: *714 - repository: *709 + commit_oid: *712 + enterprise: *705 + installation: *706 + organization: *707 + ref: *713 + repository: *708 sender: *4 required: - action @@ -118818,7 +121467,7 @@ webhooks: required: - login - id - dismissed_comment: *417 + dismissed_comment: *416 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -118970,10 +121619,10 @@ webhooks: - dismissed_reason - rule - tool - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -119233,10 +121882,10 @@ webhooks: - updated_at - author_association - body - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -119317,18 +121966,18 @@ webhooks: type: - string - 'null' - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *708 - pusher_type: &715 + organization: *707 + pusher_type: &714 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &716 + ref: &715 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -119338,7 +121987,7 @@ webhooks: enum: - tag - branch - repository: *709 + repository: *708 sender: *4 required: - ref @@ -119420,10 +122069,10 @@ webhooks: type: string enum: - created - definition: *276 - enterprise: *706 - installation: *707 - organization: *708 + definition: *275 + enterprise: *705 + installation: *706 + organization: *707 sender: *4 required: - action @@ -119508,9 +122157,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 sender: *4 required: - action @@ -119587,10 +122236,10 @@ webhooks: type: string enum: - promote_to_enterprise - definition: *276 - enterprise: *706 - installation: *707 - organization: *708 + definition: *275 + enterprise: *705 + installation: *706 + organization: *707 sender: *4 required: - action @@ -119667,10 +122316,10 @@ webhooks: type: string enum: - updated - definition: *276 - enterprise: *706 - installation: *707 - organization: *708 + definition: *275 + enterprise: *705 + installation: *706 + organization: *707 sender: *4 required: - action @@ -119747,19 +122396,19 @@ webhooks: type: string enum: - updated - enterprise: *706 - installation: *707 - repository: *709 - organization: *708 + enterprise: *705 + installation: *706 + repository: *708 + organization: *707 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *280 + items: *279 old_property_values: type: array description: The old custom property values for the repository. - items: *280 + items: *279 required: - action - repository @@ -119835,18 +122484,18 @@ webhooks: title: delete event type: object properties: - enterprise: *706 - installation: *707 - organization: *708 - pusher_type: *715 - ref: *716 + enterprise: *705 + installation: *706 + organization: *707 + pusher_type: *714 + ref: *715 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *709 + repository: *708 sender: *4 required: - ref @@ -119926,11 +122575,11 @@ webhooks: type: string enum: - assignees_changed - alert: *475 - installation: *707 - organization: *708 - enterprise: *706 - repository: *709 + alert: *474 + installation: *706 + organization: *707 + enterprise: *705 + repository: *708 sender: *4 required: - action @@ -120010,11 +122659,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *475 - installation: *707 - organization: *708 - enterprise: *706 - repository: *709 + alert: *474 + installation: *706 + organization: *707 + enterprise: *705 + repository: *708 sender: *4 required: - action @@ -120095,11 +122744,11 @@ webhooks: type: string enum: - auto_reopened - alert: *475 - installation: *707 - organization: *708 - enterprise: *706 - repository: *709 + alert: *474 + installation: *706 + organization: *707 + enterprise: *705 + repository: *708 sender: *4 required: - action @@ -120180,11 +122829,11 @@ webhooks: type: string enum: - created - alert: *475 - installation: *707 - organization: *708 - enterprise: *706 - repository: *709 + alert: *474 + installation: *706 + organization: *707 + enterprise: *705 + repository: *708 sender: *4 required: - action @@ -120263,11 +122912,11 @@ webhooks: type: string enum: - dismissed - alert: *475 - installation: *707 - organization: *708 - enterprise: *706 - repository: *709 + alert: *474 + installation: *706 + organization: *707 + enterprise: *705 + repository: *708 sender: *4 required: - action @@ -120346,11 +122995,11 @@ webhooks: type: string enum: - fixed - alert: *475 - installation: *707 - organization: *708 - enterprise: *706 - repository: *709 + alert: *474 + installation: *706 + organization: *707 + enterprise: *705 + repository: *708 sender: *4 required: - action @@ -120430,11 +123079,11 @@ webhooks: type: string enum: - reintroduced - alert: *475 - installation: *707 - organization: *708 - enterprise: *706 - repository: *709 + alert: *474 + installation: *706 + organization: *707 + enterprise: *705 + repository: *708 sender: *4 required: - action @@ -120513,11 +123162,11 @@ webhooks: type: string enum: - reopened - alert: *475 - installation: *707 - organization: *708 - enterprise: *706 - repository: *709 + alert: *474 + installation: *706 + organization: *707 + enterprise: *705 + repository: *708 sender: *4 required: - action @@ -120594,9 +123243,9 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - key: &717 + enterprise: *705 + installation: *706 + key: &716 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -120634,8 +123283,8 @@ webhooks: - verified - created_at - read_only - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -120712,11 +123361,11 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - key: *717 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + key: *716 + organization: *707 + repository: *708 sender: *4 required: - action @@ -121283,12 +123932,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - workflow: &721 + workflow: &720 title: Workflow type: - object @@ -122039,13 +124688,13 @@ webhooks: deployment: anyOf: - type: 'null' - - *481 + - *480 pull_requests: type: array - items: *565 - repository: *709 - organization: *708 - installation: *707 + items: *564 + repository: *708 + organization: *707 + installation: *706 sender: *4 responses: '200': @@ -122116,7 +124765,7 @@ webhooks: type: string enum: - approved - approver: &718 + approver: &717 type: object properties: avatar_url: @@ -122159,11 +124808,11 @@ webhooks: type: string comment: type: string - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - reviewers: &719 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + reviewers: &718 type: array items: type: object @@ -122244,7 +124893,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &720 + workflow_job_run: &719 type: object properties: conclusion: @@ -122990,18 +125639,18 @@ webhooks: type: string enum: - rejected - approver: *718 + approver: *717 comment: type: string - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - reviewers: *719 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + reviewers: *718 sender: *4 since: type: string - workflow_job_run: *720 + workflow_job_run: *719 workflow_job_runs: type: array items: @@ -123718,13 +126367,13 @@ webhooks: type: string enum: - requested - enterprise: *706 + enterprise: *705 environment: type: string - installation: *707 - organization: *708 - repository: *709 - requestor: &726 + installation: *706 + organization: *707 + repository: *708 + requestor: &725 title: User type: - object @@ -125657,12 +128306,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - workflow: *721 + workflow: *720 workflow_run: title: Deployment Workflow Run type: @@ -126353,7 +129002,7 @@ webhooks: type: string enum: - answered - answer: &724 + answer: &723 type: object properties: author_association: @@ -126513,11 +129162,11 @@ webhooks: - created_at - updated_at - body - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -126644,11 +129293,11 @@ webhooks: - from required: - category - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -126731,11 +129380,11 @@ webhooks: type: string enum: - closed - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -126817,7 +129466,7 @@ webhooks: type: string enum: - created - comment: &723 + comment: &722 type: object properties: author_association: @@ -126977,11 +129626,11 @@ webhooks: - updated_at - body - reactions - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127064,12 +129713,12 @@ webhooks: type: string enum: - deleted - comment: *723 - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + comment: *722 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127164,12 +129813,12 @@ webhooks: - from required: - body - comment: *723 - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + comment: *722 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127253,11 +129902,11 @@ webhooks: type: string enum: - created - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127339,11 +129988,11 @@ webhooks: type: string enum: - deleted - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127443,11 +130092,11 @@ webhooks: type: string required: - from - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127529,10 +130178,10 @@ webhooks: type: string enum: - labeled - discussion: *722 - enterprise: *706 - installation: *707 - label: &725 + discussion: *721 + enterprise: *705 + installation: *706 + label: &724 title: Label type: object properties: @@ -127565,8 +130214,8 @@ webhooks: - color - default - description - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127649,11 +130298,11 @@ webhooks: type: string enum: - locked - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127735,11 +130384,11 @@ webhooks: type: string enum: - pinned - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127821,11 +130470,11 @@ webhooks: type: string enum: - reopened - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127910,16 +130559,16 @@ webhooks: changes: type: object properties: - new_discussion: *722 - new_repository: *709 + new_discussion: *721 + new_repository: *708 required: - new_discussion - new_repository - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -128002,10 +130651,10 @@ webhooks: type: string enum: - unanswered - discussion: *722 - old_answer: *724 - organization: *708 - repository: *709 + discussion: *721 + old_answer: *723 + organization: *707 + repository: *708 sender: *4 required: - action @@ -128087,12 +130736,12 @@ webhooks: type: string enum: - unlabeled - discussion: *722 - enterprise: *706 - installation: *707 - label: *725 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + label: *724 + organization: *707 + repository: *708 sender: *4 required: - action @@ -128175,11 +130824,11 @@ webhooks: type: string enum: - unlocked - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -128261,11 +130910,11 @@ webhooks: type: string enum: - unpinned - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -128338,7 +130987,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *706 + enterprise: *705 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -129016,9 +131665,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - forkee @@ -129164,9 +131813,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 pages: description: The pages that were updated. type: array @@ -129204,7 +131853,7 @@ webhooks: - action - sha - html_url - repository: *709 + repository: *708 sender: *4 required: - pages @@ -129280,10 +131929,10 @@ webhooks: type: string enum: - created - enterprise: *706 + enterprise: *705 installation: *20 - organization: *708 - repositories: &727 + organization: *707 + repositories: &726 description: An array of repository objects that the installation can access. type: array @@ -129309,8 +131958,8 @@ webhooks: - name - full_name - private - repository: *709 - requester: *726 + repository: *708 + requester: *725 sender: *4 required: - action @@ -129385,11 +132034,11 @@ webhooks: type: string enum: - deleted - enterprise: *706 + enterprise: *705 installation: *20 - organization: *708 - repositories: *727 - repository: *709 + organization: *707 + repositories: *726 + repository: *708 requester: type: - 'null' @@ -129466,11 +132115,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *706 + enterprise: *705 installation: *20 - organization: *708 - repositories: *727 - repository: *709 + organization: *707 + repositories: *726 + repository: *708 requester: type: - 'null' @@ -129547,10 +132196,10 @@ webhooks: type: string enum: - added - enterprise: *706 + enterprise: *705 installation: *20 - organization: *708 - repositories_added: &728 + organization: *707 + repositories_added: &727 description: An array of repository objects, which were added to the installation. type: array @@ -129596,15 +132245,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *709 - repository_selection: &729 + repository: *708 + repository_selection: &728 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *726 + requester: *725 sender: *4 required: - action @@ -129683,10 +132332,10 @@ webhooks: type: string enum: - removed - enterprise: *706 + enterprise: *705 installation: *20 - organization: *708 - repositories_added: *728 + organization: *707 + repositories_added: *727 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -129713,9 +132362,9 @@ webhooks: - name - full_name - private - repository: *709 - repository_selection: *729 - requester: *726 + repository: *708 + repository_selection: *728 + requester: *725 sender: *4 required: - action @@ -129794,11 +132443,11 @@ webhooks: type: string enum: - suspend - enterprise: *706 + enterprise: *705 installation: *20 - organization: *708 - repositories: *727 - repository: *709 + organization: *707 + repositories: *726 + repository: *708 requester: type: - 'null' @@ -129980,10 +132629,10 @@ webhooks: type: string required: - from - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 target_type: type: string @@ -130062,11 +132711,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *706 + enterprise: *705 installation: *20 - organization: *708 - repositories: *727 - repository: *709 + organization: *707 + repositories: *726 + repository: *708 requester: type: - 'null' @@ -130232,7 +132881,7 @@ webhooks: pin: anyOf: - type: 'null' - - *544 + - *543 user: title: User type: @@ -130318,8 +132967,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -131131,8 +133780,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131149,7 +133798,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -131493,8 +134142,8 @@ webhooks: - state - locked - assignee - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -131574,7 +134223,7 @@ webhooks: type: string enum: - deleted - comment: &730 + comment: &729 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -131731,7 +134380,7 @@ webhooks: pin: anyOf: - type: 'null' - - *544 + - *543 required: - url - html_url @@ -131745,8 +134394,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -132554,8 +135203,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132572,7 +135221,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -132918,8 +135567,8 @@ webhooks: - state - locked - assignee - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -132999,7 +135648,7 @@ webhooks: type: string enum: - edited - changes: &754 + changes: &753 description: The changes to the comment. type: object properties: @@ -133011,9 +135660,9 @@ webhooks: type: string required: - from - comment: *730 - enterprise: *706 - installation: *707 + comment: *729 + enterprise: *705 + installation: *706 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -133824,8 +136473,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133842,7 +136491,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -134186,8 +136835,8 @@ webhooks: - state - locked - assignee - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -134268,9 +136917,9 @@ webhooks: type: string enum: - pinned - comment: *730 - enterprise: *706 - installation: *707 + comment: *729 + enterprise: *705 + installation: *706 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -135083,8 +137732,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135101,7 +137750,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -135447,8 +138096,8 @@ webhooks: - state - locked - assignee - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -135528,9 +138177,9 @@ webhooks: type: string enum: - unpinned - comment: *730 - enterprise: *706 - installation: *707 + comment: *729 + enterprise: *705 + installation: *706 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -136343,8 +138992,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136361,7 +139010,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -136707,8 +139356,8 @@ webhooks: - state - locked - assignee - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -136797,9 +139446,9 @@ webhooks: type: number blocking_issue: *81 blocking_issue_repo: *77 - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -136888,9 +139537,9 @@ webhooks: type: number blocking_issue: *81 blocking_issue_repo: *77 - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -136978,9 +139627,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *81 - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -137069,9 +139718,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *81 - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -137151,10 +139800,10 @@ webhooks: type: string enum: - assigned - assignee: *726 - enterprise: *706 - installation: *707 - issue: &733 + assignee: *725 + enterprise: *705 + installation: *706 + issue: &732 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -137965,11 +140614,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137986,7 +140635,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -138089,8 +140738,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -138170,8 +140819,8 @@ webhooks: type: string enum: - closed - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -138987,11 +141636,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139008,7 +141657,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -139254,8 +141903,8 @@ webhooks: required: - state - closed_at - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -139334,8 +141983,8 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -140142,11 +142791,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140163,7 +142812,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -140265,8 +142914,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -140345,8 +142994,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141176,11 +143825,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141197,7 +143846,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -141278,7 +143927,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &731 + milestone: &730 title: Milestone description: A collection of related issues and pull requests. type: object @@ -141421,8 +144070,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -141521,8 +144170,8 @@ webhooks: type: string required: - from - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142333,11 +144982,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142351,7 +145000,7 @@ webhooks: timeline_url: type: string format: uri - type: *230 + type: *229 title: description: Title of the issue type: string @@ -142457,9 +145106,9 @@ webhooks: - active_lock_reason - body - reactions - label: *725 - organization: *708 - repository: *709 + label: *724 + organization: *707 + repository: *708 sender: *4 required: - action @@ -142539,8 +145188,8 @@ webhooks: type: string enum: - labeled - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -143350,11 +145999,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143368,7 +146017,7 @@ webhooks: timeline_url: type: string format: uri - type: *230 + type: *229 title: description: Title of the issue type: string @@ -143474,9 +146123,9 @@ webhooks: - active_lock_reason - body - reactions - label: *725 - organization: *708 - repository: *709 + label: *724 + organization: *707 + repository: *708 sender: *4 required: - action @@ -143556,8 +146205,8 @@ webhooks: type: string enum: - locked - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144392,11 +147041,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144410,7 +147059,7 @@ webhooks: timeline_url: type: string format: uri - type: *230 + type: *229 title: description: Title of the issue type: string @@ -144493,8 +147142,8 @@ webhooks: format: uri user_view_type: type: string - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -144573,8 +147222,8 @@ webhooks: type: string enum: - milestoned - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -145403,11 +148052,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145424,7 +148073,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -145504,9 +148153,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *731 - organization: *708 - repository: *709 + milestone: *730 + organization: *707 + repository: *708 sender: *4 required: - action @@ -146393,11 +149042,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146497,7 +149146,7 @@ webhooks: required: - login - id - type: *230 + type: *229 required: - id - number @@ -146989,8 +149638,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147797,11 +150446,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147818,7 +150467,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -147924,8 +150573,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -148005,9 +150654,9 @@ webhooks: type: string enum: - pinned - enterprise: *706 - installation: *707 - issue: &732 + enterprise: *705 + installation: *706 + issue: &731 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -148812,11 +151461,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148833,7 +151482,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -148935,8 +151584,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -149015,8 +151664,8 @@ webhooks: type: string enum: - reopened - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -149849,11 +152498,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149950,9 +152599,9 @@ webhooks: format: uri user_view_type: type: string - type: *230 - organization: *708 - repository: *709 + type: *229 + organization: *707 + repository: *708 sender: *4 required: - action @@ -150840,11 +153489,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150861,7 +153510,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -151454,11 +154103,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *706 - installation: *707 - issue: *732 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + issue: *731 + organization: *707 + repository: *708 sender: *4 required: - action @@ -151538,12 +154187,12 @@ webhooks: type: string enum: - typed - enterprise: *706 - installation: *707 - issue: *733 - type: *230 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + issue: *732 + type: *229 + organization: *707 + repository: *708 sender: *4 required: - action @@ -151624,7 +154273,7 @@ webhooks: type: string enum: - unassigned - assignee: &757 + assignee: &756 title: User type: - object @@ -151696,11 +154345,11 @@ webhooks: required: - login - id - enterprise: *706 - installation: *707 - issue: *733 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + issue: *732 + organization: *707 + repository: *708 sender: *4 required: - action @@ -151779,12 +154428,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *706 - installation: *707 - issue: *733 - label: *725 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + issue: *732 + label: *724 + organization: *707 + repository: *708 sender: *4 required: - action @@ -151864,8 +154513,8 @@ webhooks: type: string enum: - unlocked - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -152698,11 +155347,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152719,7 +155368,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -152799,8 +155448,8 @@ webhooks: format: uri user_view_type: type: string - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -152880,11 +155529,11 @@ webhooks: type: string enum: - unpinned - enterprise: *706 - installation: *707 - issue: *732 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + issue: *731 + organization: *707 + repository: *708 sender: *4 required: - action @@ -152963,12 +155612,12 @@ webhooks: type: string enum: - untyped - enterprise: *706 - installation: *707 - issue: *733 - type: *230 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + issue: *732 + type: *229 + organization: *707 + repository: *708 sender: *4 required: - action @@ -153048,11 +155697,11 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - label: *725 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + label: *724 + organization: *707 + repository: *708 sender: *4 required: - action @@ -153130,11 +155779,11 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - label: *725 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + label: *724 + organization: *707 + repository: *708 sender: *4 required: - action @@ -153244,11 +155893,11 @@ webhooks: type: string required: - from - enterprise: *706 - installation: *707 - label: *725 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + label: *724 + organization: *707 + repository: *708 sender: *4 required: - action @@ -153330,9 +155979,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *706 - installation: *707 - marketplace_purchase: &734 + enterprise: *705 + installation: *706 + marketplace_purchase: &733 title: Marketplace Purchase type: object required: @@ -153420,8 +156069,8 @@ webhooks: type: integer unit_count: type: integer - organization: *708 - previous_marketplace_purchase: &735 + organization: *707 + previous_marketplace_purchase: &734 title: Marketplace Purchase type: object properties: @@ -153505,7 +156154,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *709 + repository: *708 sender: *4 required: - action @@ -153585,10 +156234,10 @@ webhooks: - changed effective_date: type: string - enterprise: *706 - installation: *707 - marketplace_purchase: *734 - organization: *708 + enterprise: *705 + installation: *706 + marketplace_purchase: *733 + organization: *707 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -153676,7 +156325,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *709 + repository: *708 sender: *4 required: - action @@ -153758,10 +156407,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *706 - installation: *707 - marketplace_purchase: *734 - organization: *708 + enterprise: *705 + installation: *706 + marketplace_purchase: *733 + organization: *707 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -153847,7 +156496,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *709 + repository: *708 sender: *4 required: - action @@ -153928,8 +156577,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 marketplace_purchase: title: Marketplace Purchase type: object @@ -154015,9 +156664,9 @@ webhooks: type: integer unit_count: type: integer - organization: *708 - previous_marketplace_purchase: *735 - repository: *709 + organization: *707 + previous_marketplace_purchase: *734 + repository: *708 sender: *4 required: - action @@ -154097,12 +156746,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *706 - installation: *707 - marketplace_purchase: *734 - organization: *708 - previous_marketplace_purchase: *735 - repository: *709 + enterprise: *705 + installation: *706 + marketplace_purchase: *733 + organization: *707 + previous_marketplace_purchase: *734 + repository: *708 sender: *4 required: - action @@ -154204,11 +156853,11 @@ webhooks: type: string required: - to - enterprise: *706 - installation: *707 - member: *726 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + member: *725 + organization: *707 + repository: *708 sender: *4 required: - action @@ -154310,11 +156959,11 @@ webhooks: type: - string - 'null' - enterprise: *706 - installation: *707 - member: *726 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + member: *725 + organization: *707 + repository: *708 sender: *4 required: - action @@ -154393,11 +157042,11 @@ webhooks: type: string enum: - removed - enterprise: *706 - installation: *707 - member: *726 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + member: *725 + organization: *707 + repository: *708 sender: *4 required: - action @@ -154475,11 +157124,11 @@ webhooks: type: string enum: - added - enterprise: *706 - installation: *707 - member: *726 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + member: *725 + organization: *707 + repository: *708 scope: description: The scope of the membership. Currently, can only be `team`. @@ -154557,7 +157206,7 @@ webhooks: required: - login - id - team: &736 + team: &735 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -154787,11 +157436,11 @@ webhooks: type: string enum: - removed - enterprise: *706 - installation: *707 - member: *726 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + member: *725 + organization: *707 + repository: *708 scope: description: The scope of the membership. Currently, can only be `team`. @@ -154870,7 +157519,7 @@ webhooks: required: - login - id - team: *736 + team: *735 required: - action - scope @@ -154952,8 +157601,8 @@ webhooks: type: string enum: - checks_requested - installation: *707 - merge_group: &737 + installation: *706 + merge_group: &736 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -154972,15 +157621,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *406 + head_commit: *405 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -155066,10 +157715,10 @@ webhooks: - merged - invalidated - dequeued - installation: *707 - merge_group: *737 - organization: *708 - repository: *709 + installation: *706 + merge_group: *736 + organization: *707 + repository: *708 sender: *4 required: - action @@ -155142,7 +157791,7 @@ webhooks: type: string enum: - deleted - enterprise: *706 + enterprise: *705 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -155251,12 +157900,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *707 - organization: *708 + installation: *706 + organization: *707 repository: anyOf: - type: 'null' - - *709 + - *708 sender: *4 required: - action @@ -155336,11 +157985,11 @@ webhooks: type: string enum: - closed - enterprise: *706 - installation: *707 - milestone: *731 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + milestone: *730 + organization: *707 + repository: *708 sender: *4 required: - action @@ -155419,9 +158068,9 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - milestone: &738 + enterprise: *705 + installation: *706 + milestone: &737 title: Milestone description: A collection of related issues and pull requests. type: object @@ -155563,8 +158212,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -155643,11 +158292,11 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - milestone: *731 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + milestone: *730 + organization: *707 + repository: *708 sender: *4 required: - action @@ -155757,11 +158406,11 @@ webhooks: type: string required: - from - enterprise: *706 - installation: *707 - milestone: *731 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + milestone: *730 + organization: *707 + repository: *708 sender: *4 required: - action @@ -155841,11 +158490,11 @@ webhooks: type: string enum: - opened - enterprise: *706 - installation: *707 - milestone: *738 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + milestone: *737 + organization: *707 + repository: *708 sender: *4 required: - action @@ -155924,11 +158573,11 @@ webhooks: type: string enum: - blocked - blocked_user: *726 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + blocked_user: *725 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -156007,11 +158656,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *726 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + blocked_user: *725 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -156090,9 +158739,9 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - membership: &739 + enterprise: *705 + installation: *706 + membership: &738 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -156202,8 +158851,8 @@ webhooks: - role - organization_url - user - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -156281,11 +158930,11 @@ webhooks: type: string enum: - member_added - enterprise: *706 - installation: *707 - membership: *739 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + membership: *738 + organization: *707 + repository: *708 sender: *4 required: - action @@ -156364,8 +159013,8 @@ webhooks: type: string enum: - member_invited - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -156487,10 +159136,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 - user: *726 + user: *725 required: - action - invitation @@ -156568,11 +159217,11 @@ webhooks: type: string enum: - member_removed - enterprise: *706 - installation: *707 - membership: *739 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + membership: *738 + organization: *707 + repository: *708 sender: *4 required: - action @@ -156659,11 +159308,11 @@ webhooks: properties: from: type: string - enterprise: *706 - installation: *707 - membership: *739 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + membership: *738 + organization: *707 + repository: *708 sender: *4 required: - action @@ -156740,9 +159389,9 @@ webhooks: type: string enum: - published - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 package: description: Information about the package. type: object @@ -157265,7 +159914,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &740 + items: &739 title: Ruby Gems metadata type: object properties: @@ -157362,7 +160011,7 @@ webhooks: - owner - package_version - registry - repository: *709 + repository: *708 sender: *4 required: - action @@ -157438,9 +160087,9 @@ webhooks: type: string enum: - updated - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 package: description: Information about the package. type: object @@ -157802,7 +160451,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *740 + items: *739 source_url: type: string format: uri @@ -157873,7 +160522,7 @@ webhooks: - owner - package_version - registry - repository: *709 + repository: *708 sender: *4 required: - action @@ -158053,12 +160702,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *706 + enterprise: *705 id: type: integer - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - id @@ -158135,7 +160784,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &741 + personal_access_token_request: &740 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -158285,10 +160934,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *706 - organization: *708 + enterprise: *705 + organization: *707 sender: *4 - installation: *707 + installation: *706 required: - action - personal_access_token_request @@ -158365,11 +161014,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *741 - enterprise: *706 - organization: *708 + personal_access_token_request: *740 + enterprise: *705 + organization: *707 sender: *4 - installation: *707 + installation: *706 required: - action - personal_access_token_request @@ -158445,11 +161094,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *741 - enterprise: *706 - organization: *708 + personal_access_token_request: *740 + enterprise: *705 + organization: *707 sender: *4 - installation: *707 + installation: *706 required: - action - personal_access_token_request @@ -158524,11 +161173,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *741 - organization: *708 - enterprise: *706 + personal_access_token_request: *740 + organization: *707 + enterprise: *705 sender: *4 - installation: *707 + installation: *706 required: - action - personal_access_token_request @@ -158633,7 +161282,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *742 + last_response: *741 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -158665,8 +161314,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 zen: description: Random string of GitHub zen. @@ -158911,10 +161560,10 @@ webhooks: - from required: - note - enterprise: *706 - installation: *707 - organization: *708 - project_card: &743 + enterprise: *705 + installation: *706 + organization: *707 + project_card: &742 title: Project Card type: object properties: @@ -159037,7 +161686,7 @@ webhooks: - creator - created_at - updated_at - repository: *709 + repository: *708 sender: *4 required: - action @@ -159118,11 +161767,11 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 - project_card: *743 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + project_card: *742 + repository: *708 sender: *4 required: - action @@ -159202,9 +161851,9 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 project_card: title: Project Card type: object @@ -159334,7 +161983,7 @@ webhooks: repository: anyOf: - type: 'null' - - *709 + - *708 sender: *4 required: - action @@ -159428,11 +162077,11 @@ webhooks: - from required: - note - enterprise: *706 - installation: *707 - organization: *708 - project_card: *743 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + project_card: *742 + repository: *708 sender: *4 required: - action @@ -159526,9 +162175,9 @@ webhooks: - from required: - column_id - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 project_card: allOf: - title: Project Card @@ -159725,7 +162374,7 @@ webhooks: type: string required: - after_id - repository: *709 + repository: *708 sender: *4 required: - action @@ -159805,10 +162454,10 @@ webhooks: type: string enum: - closed - enterprise: *706 - installation: *707 - organization: *708 - project: &745 + enterprise: *705 + installation: *706 + organization: *707 + project: &744 title: Project type: object properties: @@ -159935,7 +162584,7 @@ webhooks: - creator - created_at - updated_at - repository: *709 + repository: *708 sender: *4 required: - action @@ -160015,10 +162664,10 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 - project_column: &744 + enterprise: *705 + installation: *706 + organization: *707 + project_column: &743 title: Project Column type: object properties: @@ -160058,7 +162707,7 @@ webhooks: - name - created_at - updated_at - repository: *709 + repository: *708 sender: *4 required: - action @@ -160137,14 +162786,14 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - organization: *708 - project_column: *744 + enterprise: *705 + installation: *706 + organization: *707 + project_column: *743 repository: anyOf: - type: 'null' - - *709 + - *708 sender: *4 required: - action @@ -160233,11 +162882,11 @@ webhooks: type: string required: - from - enterprise: *706 - installation: *707 - organization: *708 - project_column: *744 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + project_column: *743 + repository: *708 sender: *4 required: - action @@ -160317,11 +162966,11 @@ webhooks: type: string enum: - moved - enterprise: *706 - installation: *707 - organization: *708 - project_column: *744 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + project_column: *743 + repository: *708 sender: *4 required: - action @@ -160401,11 +163050,11 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 - project: *745 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + project: *744 + repository: *708 sender: *4 required: - action @@ -160485,14 +163134,14 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - organization: *708 - project: *745 + enterprise: *705 + installation: *706 + organization: *707 + project: *744 repository: anyOf: - type: 'null' - - *709 + - *708 sender: *4 required: - action @@ -160593,11 +163242,11 @@ webhooks: type: string required: - from - enterprise: *706 - installation: *707 - organization: *708 - project: *745 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + project: *744 + repository: *708 sender: *4 required: - action @@ -160676,11 +163325,11 @@ webhooks: type: string enum: - reopened - enterprise: *706 - installation: *707 - organization: *708 - project: *745 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + project: *744 + repository: *708 sender: *4 required: - action @@ -160761,9 +163410,9 @@ webhooks: type: string enum: - closed - installation: *707 - organization: *708 - projects_v2: *263 + installation: *706 + organization: *707 + projects_v2: *262 sender: *4 required: - action @@ -160844,9 +163493,9 @@ webhooks: type: string enum: - created - installation: *707 - organization: *708 - projects_v2: *263 + installation: *706 + organization: *707 + projects_v2: *262 sender: *4 required: - action @@ -160927,9 +163576,9 @@ webhooks: type: string enum: - deleted - installation: *707 - organization: *708 - projects_v2: *263 + installation: *706 + organization: *707 + projects_v2: *262 sender: *4 required: - action @@ -161050,9 +163699,9 @@ webhooks: type: string to: type: string - installation: *707 - organization: *708 - projects_v2: *263 + installation: *706 + organization: *707 + projects_v2: *262 sender: *4 required: - action @@ -161135,7 +163784,7 @@ webhooks: type: string enum: - archived - changes: &749 + changes: &748 type: object properties: archived_at: @@ -161151,9 +163800,9 @@ webhooks: - string - 'null' format: date-time - installation: *707 - organization: *708 - projects_v2_item: &746 + installation: *706 + organization: *707 + projects_v2_item: &745 title: Projects v2 Item description: An item belonging to a project type: object @@ -161171,7 +163820,7 @@ webhooks: type: string description: The node ID of the content represented by this item. - content_type: *269 + content_type: *268 creator: *4 created_at: type: string @@ -161293,9 +163942,9 @@ webhooks: - 'null' to: type: string - installation: *707 - organization: *708 - projects_v2_item: *746 + installation: *706 + organization: *707 + projects_v2_item: *745 sender: *4 required: - action @@ -161377,9 +164026,9 @@ webhooks: type: string enum: - created - installation: *707 - organization: *708 - projects_v2_item: *746 + installation: *706 + organization: *707 + projects_v2_item: *745 sender: *4 required: - action @@ -161460,9 +164109,9 @@ webhooks: type: string enum: - deleted - installation: *707 - organization: *708 - projects_v2_item: *746 + installation: *706 + organization: *707 + projects_v2_item: *745 sender: *4 required: - action @@ -161567,7 +164216,7 @@ webhooks: oneOf: - type: string - type: integer - - &747 + - &746 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -161591,7 +164240,7 @@ webhooks: required: - id - name - - &748 + - &747 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -161631,8 +164280,8 @@ webhooks: oneOf: - type: string - type: integer + - *746 - *747 - - *748 type: - 'null' - string @@ -161655,9 +164304,9 @@ webhooks: - 'null' required: - body - installation: *707 - organization: *708 - projects_v2_item: *746 + installation: *706 + organization: *707 + projects_v2_item: *745 sender: *4 required: - action @@ -161754,9 +164403,9 @@ webhooks: type: - string - 'null' - installation: *707 - organization: *708 - projects_v2_item: *746 + installation: *706 + organization: *707 + projects_v2_item: *745 sender: *4 required: - action @@ -161839,10 +164488,10 @@ webhooks: type: string enum: - restored - changes: *749 - installation: *707 - organization: *708 - projects_v2_item: *746 + changes: *748 + installation: *706 + organization: *707 + projects_v2_item: *745 sender: *4 required: - action @@ -161924,9 +164573,9 @@ webhooks: type: string enum: - reopened - installation: *707 - organization: *708 - projects_v2: *263 + installation: *706 + organization: *707 + projects_v2: *262 sender: *4 required: - action @@ -162007,9 +164656,9 @@ webhooks: type: string enum: - created - installation: *707 - organization: *708 - projects_v2_status_update: *750 + installation: *706 + organization: *707 + projects_v2_status_update: *749 sender: *4 required: - action @@ -162090,9 +164739,9 @@ webhooks: type: string enum: - deleted - installation: *707 - organization: *708 - projects_v2_status_update: *750 + installation: *706 + organization: *707 + projects_v2_status_update: *749 sender: *4 required: - action @@ -162238,9 +164887,9 @@ webhooks: - string - 'null' format: date - installation: *707 - organization: *708 - projects_v2_status_update: *750 + installation: *706 + organization: *707 + projects_v2_status_update: *749 sender: *4 required: - action @@ -162311,10 +164960,10 @@ webhooks: title: public event type: object properties: - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - repository @@ -162391,13 +165040,13 @@ webhooks: type: string enum: - assigned - assignee: *726 - enterprise: *706 - installation: *707 - number: &751 + assignee: *725 + enterprise: *705 + installation: *706 + number: &750 description: The pull request number. type: integer - organization: *708 + organization: *707 pull_request: title: Pull Request type: object @@ -164768,7 +167417,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 sender: *4 required: - action @@ -164850,11 +167499,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 number: type: integer - organization: *708 + organization: *707 pull_request: title: Pull Request type: object @@ -167218,7 +169867,7 @@ webhooks: - draft reason: type: string - repository: *709 + repository: *708 sender: *4 required: - action @@ -167300,11 +169949,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 number: type: integer - organization: *708 + organization: *707 pull_request: title: Pull Request type: object @@ -169668,7 +172317,7 @@ webhooks: - draft reason: type: string - repository: *709 + repository: *708 sender: *4 required: - action @@ -169750,13 +172399,13 @@ webhooks: type: string enum: - closed - enterprise: *706 - installation: *707 - number: *751 - organization: *708 - pull_request: &752 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 + pull_request: &751 allOf: - - *565 + - *564 - type: object properties: allow_auto_merge: @@ -169818,7 +172467,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *709 + repository: *708 sender: *4 required: - action @@ -169899,12 +172548,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *706 - installation: *707 - number: *751 - organization: *708 - pull_request: *752 - repository: *709 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 + pull_request: *751 + repository: *708 sender: *4 required: - action @@ -169984,11 +172633,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *706 - milestone: *266 - number: *751 - organization: *708 - pull_request: &753 + enterprise: *705 + milestone: *265 + number: *750 + organization: *707 + pull_request: &752 title: Pull Request type: object properties: @@ -172337,7 +174986,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 sender: *4 required: - action @@ -172416,11 +175065,11 @@ webhooks: type: string enum: - dequeued - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 number: type: integer - organization: *708 + organization: *707 pull_request: title: Pull Request type: object @@ -174788,7 +177437,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *709 + repository: *708 sender: *4 required: - action @@ -174912,12 +177561,12 @@ webhooks: type: string required: - from - enterprise: *706 - installation: *707 - number: *751 - organization: *708 - pull_request: *752 - repository: *709 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 + pull_request: *751 + repository: *708 sender: *4 required: - action @@ -174997,11 +177646,11 @@ webhooks: type: string enum: - enqueued - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 number: type: integer - organization: *708 + organization: *707 pull_request: title: Pull Request type: object @@ -177354,7 +180003,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 sender: *4 required: - action @@ -177434,11 +180083,11 @@ webhooks: type: string enum: - labeled - enterprise: *706 - installation: *707 - label: *725 - number: *751 - organization: *708 + enterprise: *705 + installation: *706 + label: *724 + number: *750 + organization: *707 pull_request: title: Pull Request type: object @@ -179808,7 +182457,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 sender: *4 required: - action @@ -179889,10 +182538,10 @@ webhooks: type: string enum: - locked - enterprise: *706 - installation: *707 - number: *751 - organization: *708 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 pull_request: title: Pull Request type: object @@ -182260,7 +184909,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 sender: *4 required: - action @@ -182340,12 +184989,12 @@ webhooks: type: string enum: - milestoned - enterprise: *706 - milestone: *266 - number: *751 - organization: *708 - pull_request: *753 - repository: *709 + enterprise: *705 + milestone: *265 + number: *750 + organization: *707 + pull_request: *752 + repository: *708 sender: *4 required: - action @@ -182424,12 +185073,12 @@ webhooks: type: string enum: - opened - enterprise: *706 - installation: *707 - number: *751 - organization: *708 - pull_request: *752 - repository: *709 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 + pull_request: *751 + repository: *708 sender: *4 required: - action @@ -182510,12 +185159,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *706 - installation: *707 - number: *751 - organization: *708 - pull_request: *752 - repository: *709 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 + pull_request: *751 + repository: *708 sender: *4 required: - action @@ -182595,12 +185244,12 @@ webhooks: type: string enum: - reopened - enterprise: *706 - installation: *707 - number: *751 - organization: *708 - pull_request: *752 - repository: *709 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 + pull_request: *751 + repository: *708 sender: *4 required: - action @@ -182975,9 +185624,9 @@ webhooks: - start_side - side - reactions - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 pull_request: type: object properties: @@ -185229,7 +187878,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *709 + repository: *708 sender: *4 required: - action @@ -185309,7 +187958,7 @@ webhooks: type: string enum: - deleted - comment: &755 + comment: &754 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -185602,9 +188251,9 @@ webhooks: - start_side - side - reactions - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 pull_request: type: object properties: @@ -187844,7 +190493,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *709 + repository: *708 sender: *4 required: - action @@ -187924,11 +190573,11 @@ webhooks: type: string enum: - edited - changes: *754 - comment: *755 - enterprise: *706 - installation: *707 - organization: *708 + changes: *753 + comment: *754 + enterprise: *705 + installation: *706 + organization: *707 pull_request: type: object properties: @@ -190171,7 +192820,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *709 + repository: *708 sender: *4 required: - action @@ -190252,9 +192901,9 @@ webhooks: type: string enum: - dismissed - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 pull_request: title: Simple Pull Request type: object @@ -192509,7 +195158,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *709 + repository: *708 review: description: The review that was affected. type: object @@ -192760,9 +195409,9 @@ webhooks: type: string required: - from - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 pull_request: title: Simple Pull Request type: object @@ -194876,8 +197525,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *709 - review: &756 + repository: *708 + review: &755 description: The review that was affected. type: object properties: @@ -195115,12 +197764,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 number: description: The pull request number. type: integer - organization: *708 + organization: *707 pull_request: title: Pull Request type: object @@ -197489,7 +200138,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 requested_reviewer: title: User type: @@ -197575,12 +200224,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 number: description: The pull request number. type: integer - organization: *708 + organization: *707 pull_request: title: Pull Request type: object @@ -199956,7 +202605,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 requested_team: title: Team description: Groups of organization members that gives permissions @@ -200151,12 +202800,12 @@ webhooks: type: string enum: - review_requested - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 number: description: The pull request number. type: integer - organization: *708 + organization: *707 pull_request: title: Pull Request type: object @@ -202527,7 +205176,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 requested_reviewer: title: User type: @@ -202614,12 +205263,12 @@ webhooks: type: string enum: - review_requested - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 number: description: The pull request number. type: integer - organization: *708 + organization: *707 pull_request: title: Pull Request type: object @@ -204981,7 +207630,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 requested_team: title: Team description: Groups of organization members that gives permissions @@ -205165,9 +207814,9 @@ webhooks: type: string enum: - submitted - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 pull_request: title: Simple Pull Request type: object @@ -207425,8 +210074,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *709 - review: *756 + repository: *708 + review: *755 sender: *4 required: - action @@ -207506,9 +210155,9 @@ webhooks: type: string enum: - resolved - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 pull_request: title: Simple Pull Request type: object @@ -209661,7 +212310,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *709 + repository: *708 sender: *4 thread: type: object @@ -210058,9 +212707,9 @@ webhooks: type: string enum: - unresolved - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 pull_request: title: Simple Pull Request type: object @@ -212196,7 +214845,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *709 + repository: *708 sender: *4 thread: type: object @@ -212595,10 +215244,10 @@ webhooks: type: string before: type: string - enterprise: *706 - installation: *707 - number: *751 - organization: *708 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 pull_request: title: Pull Request type: object @@ -214955,7 +217604,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 sender: *4 required: - action @@ -215037,11 +217686,11 @@ webhooks: type: string enum: - unassigned - assignee: *757 - enterprise: *706 - installation: *707 - number: *751 - organization: *708 + assignee: *756 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 pull_request: title: Pull Request type: object @@ -217413,7 +220062,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 sender: *4 required: - action @@ -217492,11 +220141,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *706 - installation: *707 - label: *725 - number: *751 - organization: *708 + enterprise: *705 + installation: *706 + label: *724 + number: *750 + organization: *707 pull_request: title: Pull Request type: object @@ -219857,7 +222506,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 sender: *4 required: - action @@ -219938,10 +222587,10 @@ webhooks: type: string enum: - unlocked - enterprise: *706 - installation: *707 - number: *751 - organization: *708 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 pull_request: title: Pull Request type: object @@ -222292,7 +224941,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 sender: *4 required: - action @@ -222495,7 +225144,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *706 + enterprise: *705 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -222590,8 +225239,8 @@ webhooks: - url - author - committer - installation: *707 - organization: *708 + installation: *706 + organization: *707 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -223190,9 +225839,9 @@ webhooks: type: string enum: - published - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 registry_package: type: object properties: @@ -223669,7 +226318,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *740 + items: *739 summary: type: string tag_name: @@ -223725,7 +226374,7 @@ webhooks: - owner - package_version - registry - repository: *709 + repository: *708 sender: *4 required: - action @@ -223803,9 +226452,9 @@ webhooks: type: string enum: - updated - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 registry_package: type: object properties: @@ -224117,7 +226766,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *740 + items: *739 summary: type: string tag_name: @@ -224167,7 +226816,7 @@ webhooks: - owner - package_version - registry - repository: *709 + repository: *708 sender: *4 required: - action @@ -224244,10 +226893,10 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 - release: &758 + enterprise: *705 + installation: *706 + organization: *707 + release: &757 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -224578,7 +227227,7 @@ webhooks: - updated_at - zipball_url - body - repository: *709 + repository: *708 sender: *4 required: - action @@ -224655,11 +227304,11 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - organization: *708 - release: *758 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + release: *757 + repository: *708 sender: *4 required: - action @@ -224776,11 +227425,11 @@ webhooks: type: boolean required: - to - enterprise: *706 - installation: *707 - organization: *708 - release: *758 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + release: *757 + repository: *708 sender: *4 required: - action @@ -224858,9 +227507,9 @@ webhooks: type: string enum: - prereleased - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -225196,7 +227845,7 @@ webhooks: - string - 'null' format: uri - repository: *709 + repository: *708 sender: *4 required: - action @@ -225272,10 +227921,10 @@ webhooks: type: string enum: - published - enterprise: *706 - installation: *707 - organization: *708 - release: &759 + enterprise: *705 + installation: *706 + organization: *707 + release: &758 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -225608,7 +228257,7 @@ webhooks: - string - 'null' format: uri - repository: *709 + repository: *708 sender: *4 required: - action @@ -225684,11 +228333,11 @@ webhooks: type: string enum: - released - enterprise: *706 - installation: *707 - organization: *708 - release: *758 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + release: *757 + repository: *708 sender: *4 required: - action @@ -225764,11 +228413,11 @@ webhooks: type: string enum: - unpublished - enterprise: *706 - installation: *707 - organization: *708 - release: *759 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + release: *758 + repository: *708 sender: *4 required: - action @@ -225844,11 +228493,11 @@ webhooks: type: string enum: - published - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - repository_advisory: *629 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + repository_advisory: *628 sender: *4 required: - action @@ -225924,11 +228573,11 @@ webhooks: type: string enum: - reported - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - repository_advisory: *629 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + repository_advisory: *628 sender: *4 required: - action @@ -226004,10 +228653,10 @@ webhooks: type: string enum: - archived - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -226084,10 +228733,10 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -226165,10 +228814,10 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -226253,10 +228902,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -226371,10 +229020,10 @@ webhooks: - 'null' items: type: string - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -226446,10 +229095,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 status: type: string @@ -226530,10 +229179,10 @@ webhooks: type: string enum: - privatized - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -226610,10 +229259,10 @@ webhooks: type: string enum: - publicized - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -226707,10 +229356,10 @@ webhooks: - name required: - repository - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -226790,11 +229439,11 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - repository_ruleset: *308 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + repository_ruleset: *307 sender: *4 required: - action @@ -226872,11 +229521,11 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - repository_ruleset: *308 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + repository_ruleset: *307 sender: *4 required: - action @@ -226954,11 +229603,11 @@ webhooks: type: string enum: - edited - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - repository_ruleset: *308 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + repository_ruleset: *307 changes: type: object properties: @@ -226977,16 +229626,16 @@ webhooks: properties: added: type: array - items: *282 + items: *281 deleted: type: array - items: *282 + items: *281 updated: type: array items: type: object properties: - condition: *282 + condition: *281 changes: type: object properties: @@ -227019,16 +229668,16 @@ webhooks: properties: added: type: array - items: *585 + items: *584 deleted: type: array - items: *585 + items: *584 updated: type: array items: type: object properties: - rule: *585 + rule: *584 changes: type: object properties: @@ -227265,10 +229914,10 @@ webhooks: - from required: - owner - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -227346,10 +229995,10 @@ webhooks: type: string enum: - unarchived - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -227427,7 +230076,7 @@ webhooks: type: string enum: - create - alert: &760 + alert: &759 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -227552,10 +230201,10 @@ webhooks: enum: - auto_dismissed - open - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -227765,10 +230414,10 @@ webhooks: type: string enum: - dismissed - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -227846,11 +230495,11 @@ webhooks: type: string enum: - reopen - alert: *760 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + alert: *759 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -228052,10 +230701,10 @@ webhooks: enum: - fixed - open - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -228133,17 +230782,17 @@ webhooks: type: string enum: - assigned - alert: &761 + alert: &760 type: object properties: - number: *171 - created_at: *172 + number: *170 + created_at: *171 updated_at: anyOf: - type: 'null' - - *173 - url: *174 - html_url: *175 + - *172 + url: *173 + html_url: *174 locations_url: type: string format: uri @@ -228248,10 +230897,10 @@ webhooks: - type: 'null' - *4 assignee: *4 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -228329,11 +230978,11 @@ webhooks: type: string enum: - created - alert: *761 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + alert: *760 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -228414,11 +231063,11 @@ webhooks: type: string enum: - created - alert: *761 - installation: *707 - location: *762 - organization: *708 - repository: *709 + alert: *760 + installation: *706 + location: *761 + organization: *707 + repository: *708 sender: *4 required: - location @@ -228656,11 +231305,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *761 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + alert: *760 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -228738,11 +231387,11 @@ webhooks: type: string enum: - reopened - alert: *761 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + alert: *760 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -228820,11 +231469,11 @@ webhooks: type: string enum: - resolved - alert: *761 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + alert: *760 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -228902,12 +231551,12 @@ webhooks: type: string enum: - unassigned - alert: *761 + alert: *760 assignee: *4 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -228985,11 +231634,11 @@ webhooks: type: string enum: - validated - alert: *761 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + alert: *760 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -229119,10 +231768,10 @@ webhooks: - organization - enterprise - - repository: *709 - enterprise: *706 - installation: *707 - organization: *708 + repository: *708 + enterprise: *705 + installation: *706 + organization: *707 sender: *4 required: - action @@ -229200,11 +231849,11 @@ webhooks: type: string enum: - published - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - security_advisory: &763 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + security_advisory: &762 description: The details of the security advisory, including summary, description, and severity. type: object @@ -229390,11 +232039,11 @@ webhooks: type: string enum: - updated - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - security_advisory: *763 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + security_advisory: *762 sender: *4 required: - action @@ -229467,10 +232116,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -229656,11 +232305,11 @@ webhooks: from: type: object properties: - security_and_analysis: *281 - enterprise: *706 - installation: *707 - organization: *708 - repository: *328 + security_and_analysis: *280 + enterprise: *705 + installation: *706 + organization: *707 + repository: *327 sender: *4 required: - changes @@ -229738,12 +232387,12 @@ webhooks: type: string enum: - cancelled - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - sponsorship: &764 + sponsorship: &763 type: object properties: created_at: @@ -230048,12 +232697,12 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - sponsorship: *764 + sponsorship: *763 required: - action - sponsorship @@ -230141,12 +232790,12 @@ webhooks: type: string required: - from - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - sponsorship: *764 + sponsorship: *763 required: - action - changes @@ -230223,17 +232872,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &765 + effective_date: &764 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: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - sponsorship: *764 + sponsorship: *763 required: - action - sponsorship @@ -230307,7 +232956,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &766 + changes: &765 type: object properties: tier: @@ -230351,13 +233000,13 @@ webhooks: - from required: - tier - effective_date: *765 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + effective_date: *764 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - sponsorship: *764 + sponsorship: *763 required: - action - changes @@ -230434,13 +233083,13 @@ webhooks: type: string enum: - tier_changed - changes: *766 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + changes: *765 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - sponsorship: *764 + sponsorship: *763 required: - action - changes @@ -230514,10 +233163,10 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -230601,10 +233250,10 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -231038,15 +233687,15 @@ webhooks: type: - string - 'null' - enterprise: *706 + enterprise: *705 id: description: The unique identifier of the status. type: integer - installation: *707 + installation: *706 name: type: string - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 sha: description: The Commit SHA. @@ -231162,9 +233811,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *81 - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -231254,9 +233903,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *81 - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -231346,9 +233995,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *81 - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -231438,9 +234087,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *81 - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -231517,12 +234166,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - team: &767 + team: &766 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -231752,9 +234401,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 repository: title: Repository description: A git repository @@ -232224,7 +234873,7 @@ webhooks: - topics - visibility sender: *4 - team: *767 + team: *766 required: - action - team @@ -232300,9 +234949,9 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 repository: title: Repository description: A git repository @@ -232772,7 +235421,7 @@ webhooks: - topics - visibility sender: *4 - team: *767 + team: *766 required: - action - team @@ -232849,9 +235498,9 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 repository: title: Repository description: A git repository @@ -233321,7 +235970,7 @@ webhooks: - topics - visibility sender: *4 - team: *767 + team: *766 required: - action - team @@ -233465,9 +236114,9 @@ webhooks: - from required: - permissions - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 repository: title: Repository description: A git repository @@ -233937,7 +236586,7 @@ webhooks: - topics - visibility sender: *4 - team: *767 + team: *766 required: - action - changes @@ -234015,9 +236664,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 repository: title: Repository description: A git repository @@ -234487,7 +237136,7 @@ webhooks: - topics - visibility sender: *4 - team: *767 + team: *766 required: - action - team @@ -234563,10 +237212,10 @@ webhooks: type: string enum: - started - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -234639,17 +237288,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *706 + enterprise: *705 inputs: type: - object - 'null' additionalProperties: true - installation: *707 - organization: *708 + installation: *706 + organization: *707 ref: type: string - repository: *709 + repository: *708 sender: *4 workflow: type: string @@ -234731,10 +237380,10 @@ webhooks: type: string enum: - completed - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 workflow_job: allOf: @@ -234990,7 +237639,7 @@ webhooks: type: string required: - conclusion - deployment: *481 + deployment: *480 required: - action - repository @@ -235069,10 +237718,10 @@ webhooks: type: string enum: - in_progress - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 workflow_job: allOf: @@ -235354,7 +238003,7 @@ webhooks: required: - status - steps - deployment: *481 + deployment: *480 required: - action - repository @@ -235433,10 +238082,10 @@ webhooks: type: string enum: - queued - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 workflow_job: type: object @@ -235582,7 +238231,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *481 + deployment: *480 required: - action - repository @@ -235661,10 +238310,10 @@ webhooks: type: string enum: - waiting - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 workflow_job: type: object @@ -235811,7 +238460,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *481 + deployment: *480 required: - action - repository @@ -235891,12 +238540,12 @@ webhooks: type: string enum: - completed - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - workflow: *721 + workflow: *720 workflow_run: title: Workflow Run type: object @@ -236915,12 +239564,12 @@ webhooks: type: string enum: - in_progress - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - workflow: *721 + workflow: *720 workflow_run: title: Workflow Run type: object @@ -237924,12 +240573,12 @@ webhooks: type: string enum: - requested - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - workflow: *721 + workflow: *720 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index 536b5e0266..7d392b42c7 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -195,6 +195,10 @@ { "name": "projects", "description": "Endpoints to manage Projects using the REST API." + }, + { + "name": "agent-tasks", + "description": "Endpoints to manage and interact with agent tasks." } ], "servers": [ @@ -1310,12 +1314,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { @@ -2146,6 +2148,3301 @@ } } }, + "/agents/repos/{owner}/{repo}/tasks": { + "get": { + "summary": "List tasks for repository", + "description": "Returns a list of tasks for a specific repository", + "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" + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false`, returns only non-archived tasks." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID" + } + ], + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "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": "Create a task", + "description": "Creates a new task for a repository", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/create-task", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#create-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, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "event_content" + ], + "properties": { + "agent_id": { + "type": "integer", + "format": "int64", + "description": "Agent ID (optional, defaults to coding agent)" + }, + "problem_statement": { + "type": "string", + "description": "Additional prompting for the agent" + }, + "event_content": { + "type": "string", + "description": "User's written prompt" + }, + "model": { + "type": "string", + "description": "Model identifier" + }, + "custom_agent": { + "type": "string", + "description": "Custom agent identifier" + }, + "create_pull_request": { + "type": "boolean", + "description": "Whether to create a PR" + }, + "base_ref": { + "type": "string", + "description": "Base ref for new branch/PR" + }, + "event_type": { + "type": "string", + "description": "Type of event" + }, + "event_url": { + "type": "string", + "description": "URL of the triggering event" + }, + "event_identifiers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Identifiers for tracking" + } + } + }, + "examples": { + "default": { + "value": { + "event_content": "Fix the login button on the homepage", + "create_pull_request": true, + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + "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": "Returns a task by ID scoped to an owner/repo path", + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "agent_id": { + "type": "integer", + "format": "int64", + "description": "Agent ID" + }, + "agent_task_id": { + "type": "string", + "description": "Agent internal task ID" + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "event_type": { + "type": "string", + "description": "Type of event that triggered this session" + }, + "event_url": { + "type": "string", + "description": "URL of the triggering event" + }, + "event_content": { + "type": "string", + "description": "Content of the triggering event" + }, + "event_identifiers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Identifiers for tracking" + }, + "resource_type": { + "type": "string", + "description": "Type of resource associated with this session" + }, + "resource_id": { + "type": "integer", + "format": "int64", + "description": "Resource ID" + }, + "resource_number": { + "type": "integer", + "format": "int32", + "description": "Resource number (e.g., PR number)" + }, + "resource_global_id": { + "type": "string", + "description": "GraphQL global ID of the resource" + }, + "resource_state": { + "type": "string", + "description": "State of the associated resource" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "workflow_run_id": { + "type": "integer", + "format": "int64", + "description": "GitHub Actions workflow run ID" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "premium_requests": { + "type": "number", + "format": "double", + "description": "Premium request count" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether this session supports remote steering via Mission Control" + }, + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "event_content": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main" + } + ] + } + } + } + } + } + }, + "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": "Returns a list of tasks for the authenticated user", + "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" + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false`, returns only non-archived tasks." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + } + ], + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "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": "Returns a task by ID with its associated sessions", + "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": { + "description": "The entity who created this task", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "github_resource", + "branch" + ], + "description": "Discriminator for data shape" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "type": { + "type": "string", + "description": "Resource type (e.g., pull_request, issue)" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether the latest session in this task supports remote steering via Mission Control" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "agent_id": { + "type": "integer", + "format": "int64", + "description": "Agent ID" + }, + "agent_task_id": { + "type": "string", + "description": "Agent internal task ID" + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "event_type": { + "type": "string", + "description": "Type of event that triggered this session" + }, + "event_url": { + "type": "string", + "description": "URL of the triggering event" + }, + "event_content": { + "type": "string", + "description": "Content of the triggering event" + }, + "event_identifiers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Identifiers for tracking" + }, + "resource_type": { + "type": "string", + "description": "Type of resource associated with this session" + }, + "resource_id": { + "type": "integer", + "format": "int64", + "description": "Resource ID" + }, + "resource_number": { + "type": "integer", + "format": "int32", + "description": "Resource number (e.g., PR number)" + }, + "resource_global_id": { + "type": "string", + "description": "GraphQL global ID of the resource" + }, + "resource_state": { + "type": "string", + "description": "State of the associated resource" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "workflow_run_id": { + "type": "integer", + "format": "int64", + "description": "GitHub Actions workflow run ID" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "premium_requests": { + "type": "number", + "format": "double", + "description": "Premium request count" + }, + "remote_steerable": { + "type": "boolean", + "description": "Whether this session supports remote steering via Mission Control" + }, + "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": "github_resource", + "data": { + "id": 42, + "type": "pull_request" + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "event_content": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main" + } + ] + } + } + } + } + } + }, + "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", @@ -24830,6 +28127,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -26326,12 +29624,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -86834,10 +90130,7 @@ "type": "string" } } - }, - "required": [ - "include_claim_keys" - ] + } }, "examples": { "default": { @@ -102485,332 +105778,345 @@ "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": "orgs", - "subcategory": "artifact-metadata" - } - } - }, - "/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.", - "tags": [ - "orgs" - ], - "operationId": "orgs/set-cluster-deployment-records", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cluster", - "in": "path", - "description": "The cluster name.", - "required": true, - "schema": { - "type": "string", - "minLength": 1, - "maxLength": 128, - "pattern": "^[a-zA-Z0-9._-]+$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "logical_environment": { - "type": "string", - "description": "The stage of the deployment.", - "minLength": 1, - "maxLength": 128 - }, - "physical_environment": { - "type": "string", - "description": "The physical region of the deployment.", - "maxLength": 128 - }, - "deployments": { - "type": "array", - "description": "The list of deployments to record.", - "maxItems": 1000, - "items": { - "type": "object", - "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", - "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", - "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", - "maxLength": 100, - "x-multi-segment": true, - "examples": [ - "1.2.3" - ] - }, - "status": { - "type": "string", - "description": "The deployment status of the artifact.", - "default": "deployed", - "enum": [ - "deployed", - "decommissioned" - ] - }, - "deployment_name": { - "type": "string", - "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", - "minLength": 1, - "maxLength": 256 - }, - "github_repository": { - "type": "string", - "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", - "maxLength": 100, - "pattern": "^[A-Za-z0-9.\\-_]+$", - "examples": [ - "my-github-repo" - ] - }, - "tags": { - "type": "object", - "description": "Key-value pairs to tag the deployment record.", - "additionalProperties": { - "type": "string" - } - }, - "runtime_risks": { - "type": "array", - "description": "A list of runtime risks associated with the deployment.", - "maxItems": 4, - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "critical-resource", - "internet-exposed", - "lateral-movement", - "sensitive-data" - ] - } - } - }, - "required": [ - "name", - "deployment_name", - "digest" - ] - } - } - }, - "required": [ - "logical_environment", - "deployments" - ] - }, - "examples": { - "default": { - "value": { - "logical_environment": "prod", - "physical_environment": "pacific-east", - "deployments": [ - { - "name": "awesome-image", - "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", - "version": "2.1.0", - "status": "deployed", - "deployment_name": "deployment-pod", - "tags": { - "runtime-risk": "sensitive-data" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Deployment records created or updated successfully.\n", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "total_count": { - "description": "The number of deployment records created", - "type": "integer" - }, - "deployment_records": { - "type": "array", - "items": { - "title": "Artifact Deployment Record", - "description": "Artifact Metadata Deployment Record", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "digest": { - "type": "string" - }, - "logical_environment": { - "type": "string" - }, - "physical_environment": { - "type": "string" - }, - "cluster": { - "type": "string" - }, - "deployment_name": { - "type": "string" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "runtime_risks": { - "type": "array", - "description": "A list of runtime risks associated with the deployment.", - "maxItems": 4, - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "critical-resource", - "internet-exposed", - "lateral-movement", - "sensitive-data" - ] - } - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "attestation_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the provenance attestation associated with the deployment record." - } - } - } - } - } + } + } + } + }, + "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": "orgs", + "subcategory": "artifact-metadata" + } + } + }, + "/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.", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-cluster-deployment-records", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "path", + "description": "The cluster name.", + "required": true, + "schema": { + "type": "string", + "minLength": 1, + "maxLength": 128, + "pattern": "^[a-zA-Z0-9._-]+$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "logical_environment": { + "type": "string", + "description": "The stage of the deployment.", + "minLength": 1, + "maxLength": 128 + }, + "physical_environment": { + "type": "string", + "description": "The physical region of the deployment.", + "maxLength": 128 + }, + "deployments": { + "type": "array", + "description": "The list of deployments to record.", + "maxItems": 1000, + "items": { + "type": "object", + "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", + "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", + "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", + "maxLength": 100, + "x-multi-segment": true, + "examples": [ + "1.2.3" + ] + }, + "status": { + "type": "string", + "description": "The deployment status of the artifact.", + "default": "deployed", + "enum": [ + "deployed", + "decommissioned" + ] + }, + "deployment_name": { + "type": "string", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", + "minLength": 1, + "maxLength": 256 + }, + "github_repository": { + "type": "string", + "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", + "maxLength": 100, + "pattern": "^[A-Za-z0-9.\\-_]+$", + "examples": [ + "my-github-repo" + ] + }, + "tags": { + "type": "object", + "description": "Key-value pairs to tag the deployment record.", + "additionalProperties": { + "type": "string" + } + }, + "runtime_risks": { + "type": "array", + "description": "A list of runtime risks associated with the deployment.", + "maxItems": 4, + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "critical-resource", + "internet-exposed", + "lateral-movement", + "sensitive-data" + ] + } + } + }, + "required": [ + "name", + "deployment_name", + "digest" + ] + } + } + }, + "required": [ + "logical_environment", + "deployments" + ] + }, + "examples": { + "default": { + "value": { + "logical_environment": "prod", + "physical_environment": "pacific-east", + "deployments": [ + { + "name": "awesome-image", + "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", + "version": "2.1.0", + "status": "deployed", + "deployment_name": "deployment-pod", + "tags": { + "runtime-risk": "sensitive-data" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Deployment records created or updated successfully.\n", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of deployment records created", + "type": "integer" + }, + "deployment_records": { + "type": "array", + "items": { + "title": "Artifact Deployment Record", + "description": "Artifact Metadata Deployment Record", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "digest": { + "type": "string" + }, + "logical_environment": { + "type": "string" + }, + "physical_environment": { + "type": "string" + }, + "cluster": { + "type": "string" + }, + "deployment_name": { + "type": "string" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "runtime_risks": { + "type": "array", + "description": "A list of runtime risks associated with the deployment.", + "maxItems": 4, + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "critical-resource", + "internet-exposed", + "lateral-movement", + "sensitive-data" + ] + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "attestation_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the provenance attestation associated with the deployment record." + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "deployment_records": [ + { + "id": 123, + "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", + "logical_environment": "prod", + "physical_environment": "pacific-east", + "cluster": "moda-1", + "deployment_name": "prod-deployment", + "tags": { + "data": "sensitive" + }, + "created": "2011-01-26T19:14:43Z", + "updated_at": "2011-01-26T19:14:43Z", + "attestation_id": 456 + } + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "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" + } + } }, "examples": { - "default": { + "insufficient_repo_permissions": { "value": { - "total_count": 1, - "deployment_records": [ - { - "id": 123, - "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", - "logical_environment": "prod", - "physical_environment": "pacific-east", - "cluster": "moda-1", - "deployment_name": "prod-deployment", - "tags": { - "data": "sensitive" - }, - "created": "2011-01-26T19:14:43Z", - "updated_at": "2011-01-26T19:14:43Z", - "attestation_id": 456 - } - ] - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "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" + "message": { + "cause": "artifact metadata write permission required on one or more repositories", + "repositories": [ + 123, + 345 + ] + } } } } @@ -126056,6 +129362,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -127552,12 +130859,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -169467,7 +172772,7 @@ "/orgs/{org}/organization-roles": { "get": { "summary": "Get all organization roles for an organization", - "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -170258,7 +173563,7 @@ "/orgs/{org}/organization-roles/{role_id}": { "get": { "summary": "Get an organization role", - "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -230783,6 +234088,14 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] } }, "required": [ @@ -230876,6 +234189,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -230893,6 +234214,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -230910,6 +234239,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] } }, "required": [ @@ -230978,6 +234315,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -230995,6 +234340,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -231012,6 +234365,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] } }, "required": [ @@ -231029,6 +234390,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] } }, "required": [ @@ -231046,6 +234415,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] } }, "required": [ @@ -236667,338 +240044,364 @@ }, "network_settings_ids": { "type": "array", - "minItems": 1, + "minItems": 1, + "maxItems": 1, + "description": "A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", + "items": { + "type": "string" + } + }, + "failover_network_settings_ids": { + "type": "array", + "minItems": 0, + "maxItems": 1, + "description": "A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", + "items": { + "type": "string" + } + }, + "failover_network_enabled": { + "type": "boolean", + "description": "Indicates whether the failover network resource is enabled." + } + }, + "required": [ + "name", + "network_settings_ids" + ] + }, + "examples": { + "default": { + "value": { + "name": "my-network-configuration", + "network_settings_ids": [ + "23456789ABDCEF1" + ], + "compute_service": "actions" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "failover_network_settings_ids": { + "description": "The unique identifier of each failover network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "failover_network_enabled": { + "description": "Indicates whether the failover network resource is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" + ] + } + }, + "required": [ + "id", + "name", + "created_on" + ] + }, + "examples": { + "default": { + "value": { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "network-configurations" + } + } + }, + "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { + "get": { + "summary": "Get a hosted compute network configuration for an organization", + "description": "Gets a hosted compute network configuration configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", + "tags": [ + "hosted-compute" + ], + "operationId": "hosted-compute/get-network-configuration-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "network_configuration_id", + "description": "Unique identifier of the hosted compute network configuration.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "failover_network_settings_ids": { + "description": "The unique identifier of each failover network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "failover_network_enabled": { + "description": "Indicates whether the failover network resource is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" + ] + } + }, + "required": [ + "id", + "name", + "created_on" + ] + }, + "examples": { + "default": { + "value": { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "network-configurations" + } + }, + "patch": { + "summary": "Update a hosted compute network configuration for an organization", + "description": "Updates a hosted compute network configuration for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", + "tags": [ + "hosted-compute" + ], + "operationId": "hosted-compute/update-network-configuration-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "network_configuration_id", + "description": "Unique identifier of the hosted compute network configuration.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", + "type": "string" + }, + "compute_service": { + "description": "The hosted compute service to use for the network configuration.", + "type": "string", + "enum": [ + "none", + "actions" + ] + }, + "network_settings_ids": { + "type": "array", + "minItems": 0, "maxItems": 1, "description": "A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", "items": { "type": "string" } - } - }, - "required": [ - "name", - "network_settings_ids" - ] - }, - "examples": { - "default": { - "value": { - "name": "my-network-configuration", - "network_settings_ids": [ - "23456789ABDCEF1" - ], - "compute_service": "actions" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Hosted compute network configuration", - "description": "A hosted compute network configuration.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the network configuration.", - "type": "string", - "examples": [ - "123ABC456DEF789" - ] - }, - "name": { - "description": "The name of the network configuration.", - "type": "string", - "examples": [ - "my-network-configuration" - ] - }, - "compute_service": { - "description": "The hosted compute service the network configuration supports.", - "type": "string", - "enum": [ - "none", - "actions", - "codespaces" - ] - }, - "network_settings_ids": { - "description": "The unique identifier of each network settings in the configuration.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "123ABC456DEF789" - ] - }, - "failover_network_settings_ids": { - "description": "The unique identifier of each failover network settings in the configuration.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "123ABC456DEF789" - ] - }, - "failover_network_enabled": { - "description": "Indicates whether the failover network resource is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "created_on": { - "description": "The time at which the network configuration was created, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2024-04-26T11:31:07Z" - ] - } }, - "required": [ - "id", - "name", - "created_on" - ] - }, - "examples": { - "default": { - "value": { - "id": "123456789ABCDEF", - "name": "My network configuration", - "compute_service": "actions", - "network_settings_ids": [ - "23456789ABDCEF1", - "3456789ABDCEF12" - ], - "created_on": "2022-10-09T23:39:01Z" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "network-configurations" - } - } - }, - "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { - "get": { - "summary": "Get a hosted compute network configuration for an organization", - "description": "Gets a hosted compute network configuration configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", - "tags": [ - "hosted-compute" - ], - "operationId": "hosted-compute/get-network-configuration-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "network_configuration_id", - "description": "Unique identifier of the hosted compute network configuration.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Hosted compute network configuration", - "description": "A hosted compute network configuration.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the network configuration.", - "type": "string", - "examples": [ - "123ABC456DEF789" - ] - }, - "name": { - "description": "The name of the network configuration.", - "type": "string", - "examples": [ - "my-network-configuration" - ] - }, - "compute_service": { - "description": "The hosted compute service the network configuration supports.", - "type": "string", - "enum": [ - "none", - "actions", - "codespaces" - ] - }, - "network_settings_ids": { - "description": "The unique identifier of each network settings in the configuration.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "123ABC456DEF789" - ] - }, - "failover_network_settings_ids": { - "description": "The unique identifier of each failover network settings in the configuration.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "123ABC456DEF789" - ] - }, - "failover_network_enabled": { - "description": "Indicates whether the failover network resource is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "created_on": { - "description": "The time at which the network configuration was created, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2024-04-26T11:31:07Z" - ] - } - }, - "required": [ - "id", - "name", - "created_on" - ] - }, - "examples": { - "default": { - "value": { - "id": "123456789ABCDEF", - "name": "My network configuration", - "compute_service": "actions", - "network_settings_ids": [ - "23456789ABDCEF1", - "3456789ABDCEF12" - ], - "created_on": "2022-10-09T23:39:01Z" - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "network-configurations" - } - }, - "patch": { - "summary": "Update a hosted compute network configuration for an organization", - "description": "Updates a hosted compute network configuration for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", - "tags": [ - "hosted-compute" - ], - "operationId": "hosted-compute/update-network-configuration-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "network_configuration_id", - "description": "Unique identifier of the hosted compute network configuration.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", - "type": "string" - }, - "compute_service": { - "description": "The hosted compute service to use for the network configuration.", - "type": "string", - "enum": [ - "none", - "actions" - ] - }, - "network_settings_ids": { + "failover_network_settings_ids": { "type": "array", "minItems": 0, "maxItems": 1, - "description": "A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", + "description": "A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", "items": { "type": "string" } + }, + "failover_network_enabled": { + "type": "boolean", + "description": "Indicates whether the failover network resource is enabled." } } }, @@ -370490,6 +373893,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -371434,12 +374838,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -371951,6 +375353,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -372904,12 +376307,10 @@ "score": 8.5 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-532", @@ -373241,6 +376642,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -607941,6 +611343,14 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] } }, "required": [ @@ -608034,6 +611444,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -608051,6 +611469,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -608068,6 +611494,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] } }, "required": [ @@ -608136,6 +611570,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -608153,6 +611595,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -608170,6 +611620,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] } }, "required": [ @@ -608187,6 +611645,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] } }, "required": [ @@ -608204,6 +611670,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] } }, "required": [ @@ -609352,6 +612826,14 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] } }, "required": [ @@ -609445,6 +612927,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -609462,6 +612952,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -609479,6 +612977,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] } }, "required": [ @@ -609547,6 +613053,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -609564,6 +613078,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -609581,6 +613103,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] } }, "required": [ @@ -609598,6 +613128,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] } }, "required": [ @@ -609615,6 +613153,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] } }, "required": [ @@ -610746,6 +614292,14 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] } }, "required": [ @@ -610839,6 +614393,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -610856,6 +614418,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -610873,6 +614443,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] } }, "required": [ @@ -610941,6 +614519,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -610958,6 +614544,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -610975,6 +614569,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] } }, "required": [ @@ -610992,6 +614594,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] } }, "required": [ @@ -611009,6 +614619,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] } }, "required": [ @@ -611454,6 +615072,14 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] } }, "required": [ @@ -611547,6 +615173,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -611564,6 +615198,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -611581,6 +615223,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] } }, "required": [ @@ -611649,6 +615299,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -611666,6 +615324,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -611683,6 +615349,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] } }, "required": [ @@ -611700,6 +615374,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] } }, "required": [ @@ -611717,6 +615399,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] } }, "required": [ @@ -898670,6 +902360,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -901614,6 +905305,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -904558,6 +908250,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -907502,6 +911195,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -910446,6 +914140,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -913390,6 +917085,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -916334,6 +920030,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -919278,6 +922975,7 @@ "unknown", "direct", "transitive", + "inconclusive", null ] } @@ -1542309,6 +1546007,14 @@ "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "examples": [ + "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + ] } }, "required": [ @@ -1542402,6 +1546108,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -1542419,6 +1546133,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1" + ] } }, "required": [ @@ -1542436,6 +1546158,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + ] } }, "required": [ @@ -1542504,6 +1546234,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -1542521,6 +1546259,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846" + ] } }, "required": [ @@ -1542538,6 +1546284,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + ] } }, "required": [ @@ -1542555,6 +1546309,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + ] } }, "required": [ @@ -1542572,6 +1546334,14 @@ "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" ] + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "examples": [ + "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + ] } }, "required": [ diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index 5da299486f..594fb14f97 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -103,6 +103,8 @@ tags: description: Endpoints to manage campaigns via the REST API. - name: projects description: Endpoints to manage Projects using the REST API. +- name: agent-tasks + description: Endpoints to manage and interact with agent tasks. servers: - url: https://api.github.com externalDocs: @@ -874,7 +876,7 @@ paths: - subscriptions_url - type - url - type: &314 + type: &313 type: string description: The type of credit the user is receiving. enum: @@ -962,7 +964,7 @@ paths: - cwe_id: CWE-400 name: Uncontrolled Resource Consumption epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 credits: - user: @@ -1039,7 +1041,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &631 + - &630 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1129,6 +1131,2539 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories + "/agents/repos/{owner}/{repo}/tasks": + get: + summary: List tasks for repository + description: Returns a list of tasks for a specific repository + 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 + description: Filter by archived status. When `true`, returns only archived + tasks. When `false`, returns only non-archived tasks. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + - name: creator_id + in: query + schema: + type: integer + description: Filter tasks by creator user ID + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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: Create a task + description: Creates a new task for a repository + tags: + - agent-tasks + operationId: agent-tasks/create-task + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#create-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 + content: + application/json: + schema: + type: object + required: + - event_content + properties: + agent_id: + type: integer + format: int64 + description: Agent ID (optional, defaults to coding agent) + problem_statement: + type: string + description: Additional prompting for the agent + event_content: + type: string + description: User's written prompt + model: + type: string + description: Model identifier + custom_agent: + type: string + description: Custom agent identifier + create_pull_request: + type: boolean + description: Whether to create a PR + base_ref: + type: string + description: Base ref for new branch/PR + event_type: + type: string + description: Type of event + event_url: + type: string + description: URL of the triggering event + event_identifiers: + type: array + items: + type: string + description: Identifiers for tracking + examples: + default: + value: + event_content: Fix the login button on the homepage + create_pull_request: true + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + 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: Returns a task by ID scoped to an owner/repo path + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + agent_id: + type: integer + format: int64 + description: Agent ID + agent_task_id: + type: string + description: Agent internal task ID + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + event_type: + type: string + description: Type of event that triggered this session + event_url: + type: string + description: URL of the triggering event + event_content: + type: string + description: Content of the triggering event + event_identifiers: + type: array + items: + type: string + description: Identifiers for tracking + resource_type: + type: string + description: Type of resource associated with this session + resource_id: + type: integer + format: int64 + description: Resource ID + resource_number: + type: integer + format: int32 + description: Resource number (e.g., PR number) + resource_global_id: + type: string + description: GraphQL global ID of the resource + resource_state: + type: string + description: State of the associated resource + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + workflow_run_id: + type: integer + format: int64 + description: GitHub Actions workflow run ID + model: + type: string + description: Model used for this session + premium_requests: + type: number + format: double + description: Premium request count + remote_steerable: + type: boolean + description: Whether this session supports remote steering + via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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' + event_content: Fix the login button on the homepage + head_ref: copilot/fix-1 + base_ref: main + '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: Returns a list of tasks for the authenticated user + 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 + description: Filter by archived status. When `true`, returns only archived + tasks. When `false`, returns only non-archived tasks. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its + most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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: Returns a task by ID with its associated sessions + 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: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - github_resource + - branch + description: Discriminator for data shape + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, + etc.) + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + type: + type: string + description: Resource type (e.g., pull_request, + issue) + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, + etc.) + archived_at: + type: + - string + - 'null' + format: date-time + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + remote_steerable: + type: boolean + description: Whether the latest session in this task supports + remote steering via Mission Control + - type: object + properties: + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + agent_id: + type: integer + format: int64 + description: Agent ID + agent_task_id: + type: string + description: Agent internal task ID + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + event_type: + type: string + description: Type of event that triggered this session + event_url: + type: string + description: URL of the triggering event + event_content: + type: string + description: Content of the triggering event + event_identifiers: + type: array + items: + type: string + description: Identifiers for tracking + resource_type: + type: string + description: Type of resource associated with this session + resource_id: + type: integer + format: int64 + description: Resource ID + resource_number: + type: integer + format: int32 + description: Resource number (e.g., PR number) + resource_global_id: + type: string + description: GraphQL global ID of the resource + resource_state: + type: string + description: State of the associated resource + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + workflow_run_id: + type: integer + format: int64 + description: GitHub Actions workflow run ID + model: + type: string + description: Model used for this session + premium_requests: + type: number + format: double + description: Premium request count + remote_steerable: + type: boolean + description: Whether this session supports remote steering + via Mission Control + 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: github_resource + data: + id: 42 + type: pull_request + 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' + event_content: Fix the login button on the homepage + head_ref: copilot/fix-1 + base_ref: main + '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 @@ -1624,7 +4159,7 @@ paths: schema: type: integer default: 30 - - &204 + - &203 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1633,7 +4168,7 @@ paths: required: false schema: type: string - - &205 + - &204 name: status description: Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries @@ -1653,7 +4188,7 @@ paths: application/json: schema: type: array - items: &206 + items: &205 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1749,7 +4284,7 @@ paths: - installation_id - repository_id examples: - default: &207 + default: &206 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1884,7 +4419,7 @@ paths: description: Response content: application/json: - schema: &208 + schema: &207 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -2019,7 +4554,7 @@ paths: - request - response examples: - default: &209 + default: &208 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -8274,7 +10809,7 @@ paths: description: Response content: application/json: - schema: &182 + schema: &181 type: array description: A list of default code security configurations items: @@ -8290,7 +10825,7 @@ paths: default configuration: *47 examples: - default: &183 + default: &182 value: - default_for_new_repos: public configuration: @@ -8630,7 +11165,7 @@ paths: - *38 - *49 responses: - '204': &184 + '204': &183 description: A header with no content is returned. '400': *14 '403': *27 @@ -8757,7 +11292,7 @@ paths: default: value: default_for_new_repos: all - configuration: &181 + configuration: &180 value: id: 1325 target_type: organization @@ -8842,7 +11377,7 @@ paths: application/json: schema: type: array - items: &185 + items: &184 type: object description: Repositories associated with a code security configuration and attachment status @@ -9187,7 +11722,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &186 + repository: &185 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -9488,7 +12023,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *38 - - &190 + - &189 name: state in: query description: |- @@ -9497,7 +12032,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &191 + - &190 name: severity in: query description: |- @@ -9506,7 +12041,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &192 + - &191 name: ecosystem in: query description: |- @@ -9515,14 +12050,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &193 + - &192 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &194 + - &193 name: epss_percentage in: query description: |- @@ -9534,7 +12069,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 - - &471 + - &470 name: has in: query description: |- @@ -9548,7 +12083,7 @@ paths: type: string enum: - patch - - &195 + - &194 name: assignee in: query description: |- @@ -9557,7 +12092,7 @@ paths: Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. schema: type: string - - &196 + - &195 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -9567,7 +12102,7 @@ paths: enum: - development - runtime - - &197 + - &196 name: sort in: query description: |- @@ -9593,11 +12128,11 @@ paths: application/json: schema: type: array - items: &198 + items: &197 type: object description: A Dependabot alert. properties: - number: &171 + number: &170 type: integer description: The security alert number. readOnly: true @@ -9662,8 +12197,9 @@ paths: - unknown - direct - transitive + - inconclusive - - security_advisory: &472 + security_advisory: &471 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9847,29 +12383,29 @@ paths: - withdrawn_at additionalProperties: false security_vulnerability: *63 - url: &174 + url: &173 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &175 + html_url: &174 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &172 + created_at: &171 type: string description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &173 + updated_at: &172 type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_at: &177 + dismissed_at: &176 type: - string - 'null' @@ -9900,7 +12436,7 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: &176 + fixed_at: &175 type: - string - 'null' @@ -9908,7 +12444,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &473 + auto_dismissed_at: &472 type: - string - 'null' @@ -9916,7 +12452,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &474 + dismissal_request: &473 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -9979,7 +12515,7 @@ paths: - repository additionalProperties: false examples: - default: &199 + default: &198 value: - number: 2 state: dismissed @@ -10028,7 +12564,7 @@ paths: vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N score: 8.7 epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 cwes: - cwe_id: CWE-200 @@ -11343,7 +13879,7 @@ paths: properties: action: type: string - discussion: &722 + discussion: &721 title: Discussion description: A Discussion in a repository. type: object @@ -11840,7 +14376,7 @@ paths: milestone: anyOf: - type: 'null' - - &266 + - &265 title: Milestone description: A collection of related issues and pull requests. @@ -12017,7 +14553,7 @@ paths: timeline_url: type: string format: uri - type: &230 + type: &229 title: Issue Type description: The type of issue. type: @@ -12128,7 +14664,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &643 + sub_issues_summary: &642 title: Sub-issues Summary type: object properties: @@ -12212,7 +14748,7 @@ paths: pin: anyOf: - type: 'null' - - &544 + - &543 title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. @@ -12239,7 +14775,7 @@ paths: - url - created_at - updated_at - issue_dependencies_summary: &644 + issue_dependencies_summary: &643 title: Issue Dependencies Summary type: object properties: @@ -12258,7 +14794,7 @@ paths: - total_blocking issue_field_values: type: array - items: &529 + items: &528 title: Issue Field Value description: A value assigned to an issue field type: object @@ -13038,7 +15574,7 @@ paths: type: string release: allOf: - - &576 + - &575 title: Release description: A release. type: object @@ -13120,7 +15656,7 @@ paths: author: *4 assets: type: array - items: &577 + items: &576 title: Release Asset description: Data related to a release. type: object @@ -15384,7 +17920,7 @@ paths: - closed - all default: open - - &233 + - &232 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -15435,7 +17971,7 @@ paths: type: array items: *81 examples: - default: &234 + default: &233 value: - id: 1 node_id: MDU6SXNzdWUx @@ -16847,14 +19383,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &325 + - &324 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &326 + - &325 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -16916,7 +19452,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &329 + '301': &328 description: Moved permanently content: application/json: @@ -16938,7 +19474,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &552 + - &551 name: all description: If `true`, show notifications marked as read. in: query @@ -16946,7 +19482,7 @@ paths: schema: type: boolean default: false - - &553 + - &552 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -16956,7 +19492,7 @@ paths: type: boolean default: false - *86 - - &554 + - &553 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: @@ -16988,7 +19524,7 @@ paths: properties: id: type: string - repository: &153 + repository: &152 title: Minimal Repository description: Minimal Repository type: object @@ -17336,7 +19872,7 @@ paths: type: boolean examples: - false - security_and_analysis: &281 + security_and_analysis: &280 type: - object - 'null' @@ -17540,7 +20076,7 @@ paths: - url - subscription_url examples: - default: &555 + default: &554 value: - id: '1' repository: @@ -19110,7 +21646,7 @@ paths: required: false schema: type: string - - &699 + - &698 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -19256,7 +21792,7 @@ paths: parameters: - *73 - *115 - - &700 + - &699 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 @@ -19368,7 +21904,7 @@ paths: - *115 - *117 - *116 - - &701 + - &700 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -19376,7 +21912,7 @@ paths: schema: type: string - *118 - - &702 + - &701 name: sku description: The SKU to query for usage. in: query @@ -20345,7 +22881,7 @@ paths: type: integer repository_cache_usages: type: array - items: &336 + items: &335 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -20593,7 +23129,7 @@ paths: - public_ip_enabled - platform examples: - default: &152 + default: &151 value: total_count: 2 runners: @@ -21588,7 +24124,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &135 + schema: title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -21602,7 +24138,7 @@ paths: required: - include_claim_keys examples: - default: &136 + default: &135 value: include_claim_keys: - repo @@ -21629,15 +24165,25 @@ paths: required: true content: application/json: - schema: *135 + schema: + title: Actions OIDC Subject customization + description: Actions OIDC Subject customization + type: object + properties: + include_claim_keys: + description: Array of unique strings. Each claim key can only contain + alphanumeric characters and underscores. + type: array + items: + type: string examples: - default: *136 + default: *135 responses: '201': description: Empty response content: application/json: - schema: &162 + schema: &161 title: Empty Object description: An object without any properties. type: object @@ -21676,7 +24222,7 @@ paths: schema: type: object properties: - enabled_repositories: &137 + enabled_repositories: &136 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -21689,7 +24235,7 @@ paths: description: The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. - allowed_actions: &138 + allowed_actions: &137 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -21697,12 +24243,12 @@ paths: - all - local_only - selected - selected_actions_url: &342 + selected_actions_url: &341 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. - sha_pinning_required: &139 + sha_pinning_required: &138 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -21744,9 +24290,9 @@ paths: schema: type: object properties: - enabled_repositories: *137 - allowed_actions: *138 - sha_pinning_required: *139 + enabled_repositories: *136 + allowed_actions: *137 + sha_pinning_required: *138 required: - enabled_repositories examples: @@ -21780,7 +24326,7 @@ paths: description: Response content: application/json: - schema: &346 + schema: &345 type: object properties: days: @@ -21822,7 +24368,7 @@ paths: required: true content: application/json: - schema: &347 + schema: &346 type: object properties: days: @@ -21865,7 +24411,7 @@ paths: description: Response content: application/json: - schema: &140 + schema: &139 type: object properties: approval_policy: @@ -21879,7 +24425,7 @@ paths: required: - approval_policy examples: - default: &348 + default: &347 value: approval_policy: first_time_contributors '404': *6 @@ -21910,7 +24456,7 @@ paths: required: true content: application/json: - schema: *140 + schema: *139 examples: default: summary: Set approval policy to first time contributors @@ -21938,7 +24484,7 @@ paths: description: Response content: application/json: - schema: &349 + schema: &348 type: object required: - run_workflows_from_fork_pull_requests @@ -21964,7 +24510,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &141 + default: &140 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -21992,7 +24538,7 @@ paths: required: true content: application/json: - schema: &350 + schema: &349 type: object required: - run_workflows_from_fork_pull_requests @@ -22015,7 +24561,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *141 + default: *140 responses: '204': description: Empty response for successful settings update @@ -22065,7 +24611,7 @@ paths: type: array items: *77 examples: - default: &145 + default: &144 value: total_count: 1 repositories: @@ -22250,7 +24796,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *73 - - &142 + - &141 name: repository_id description: The unique identifier of the repository. in: path @@ -22279,7 +24825,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *73 - - *142 + - *141 responses: '204': description: Response @@ -22308,7 +24854,7 @@ paths: description: Response content: application/json: - schema: &143 + schema: &142 type: object properties: github_owned_allowed: @@ -22330,7 +24876,7 @@ paths: items: type: string examples: - default: &144 + default: &143 value: github_owned_allowed: true verified_allowed: false @@ -22363,9 +24909,9 @@ paths: required: false content: application/json: - schema: *143 + schema: *142 examples: - selected_actions: *144 + selected_actions: *143 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22497,7 +25043,7 @@ paths: type: array items: *77 examples: - default: *145 + default: *144 '403': *27 '404': *6 x-github: @@ -22566,7 +25112,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - *73 - - *142 + - *141 responses: '204': description: No content @@ -22593,7 +25139,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - *73 - - *142 + - *141 responses: '204': description: No content @@ -22627,17 +25173,17 @@ paths: description: Response content: application/json: - schema: &351 + schema: &350 type: object properties: - default_workflow_permissions: &146 + default_workflow_permissions: &145 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &147 + can_approve_pull_request_reviews: &146 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -22645,7 +25191,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &148 + default: &147 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -22678,13 +25224,13 @@ paths: required: false content: application/json: - schema: &352 + schema: &351 type: object properties: - default_workflow_permissions: *146 - can_approve_pull_request_reviews: *147 + default_workflow_permissions: *145 + can_approve_pull_request_reviews: *146 examples: - default: *148 + default: *147 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22729,7 +25275,7 @@ paths: type: number runner_groups: type: array - items: &149 + items: &148 type: object properties: id: @@ -22919,9 +25465,9 @@ paths: description: Response content: application/json: - schema: *149 + schema: *148 examples: - default: &151 + default: &150 value: id: 2 name: octo-runner-group @@ -22957,7 +25503,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - *73 - - &150 + - &149 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -22969,7 +25515,7 @@ paths: description: Response content: application/json: - schema: *149 + schema: *148 examples: default: value: @@ -23006,7 +25552,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - *73 - - *150 + - *149 requestBody: required: true content: @@ -23062,9 +25608,9 @@ paths: description: Response content: application/json: - schema: *149 + schema: *148 examples: - default: *151 + default: *150 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -23084,7 +25630,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - *73 - - *150 + - *149 responses: '204': description: Response @@ -23108,7 +25654,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - *73 - - *150 + - *149 - *17 - *19 responses: @@ -23128,7 +25674,7 @@ paths: type: array items: *123 examples: - default: *152 + default: *151 headers: Link: *65 x-github: @@ -23151,7 +25697,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *73 - - *150 + - *149 - *19 - *17 responses: @@ -23169,9 +25715,9 @@ paths: type: number repositories: type: array - items: *153 + items: *152 examples: - default: &189 + default: &188 value: total_count: 1 repositories: @@ -23424,7 +25970,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - *73 - - *150 + - *149 requestBody: required: true content: @@ -23469,8 +26015,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *73 - - *150 - - *142 + - *149 + - *141 responses: '204': description: Response @@ -23493,8 +26039,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *73 - - *150 - - *142 + - *149 + - *141 responses: '204': description: Response @@ -23518,7 +26064,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - *73 - - *150 + - *149 - *17 - *19 responses: @@ -23536,7 +26082,7 @@ paths: type: number runners: type: array - items: &155 + items: &154 title: Self hosted runners description: A self hosted runner type: object @@ -23570,7 +26116,7 @@ paths: type: boolean labels: type: array - items: &158 + items: &157 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -23600,7 +26146,7 @@ paths: - busy - labels examples: - default: &156 + default: &155 value: total_count: 2 runners: @@ -23660,7 +26206,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - *73 - - *150 + - *149 requestBody: required: true content: @@ -23705,8 +26251,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - *73 - - *150 - - &154 + - *149 + - &153 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -23735,8 +26281,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - *73 - - *150 - - *154 + - *149 + - *153 responses: '204': description: Response @@ -23784,9 +26330,9 @@ paths: type: integer runners: type: array - items: *155 + items: *154 examples: - default: *156 + default: *155 headers: Link: *65 x-github: @@ -23818,7 +26364,7 @@ paths: application/json: schema: type: array - items: &353 + items: &352 title: Runner Application description: Runner Application type: object @@ -23843,7 +26389,7 @@ paths: - download_url - filename examples: - default: &354 + default: &353 value: - os: osx architecture: x64 @@ -23929,7 +26475,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &355 + '201': &354 description: Response content: application/json: @@ -23939,7 +26485,7 @@ paths: - runner - encoded_jit_config properties: - runner: *155 + runner: *154 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -24002,7 +26548,7 @@ paths: description: Response content: application/json: - schema: &157 + schema: &156 title: Authentication Token description: Authentication Token type: object @@ -24044,7 +26590,7 @@ paths: - token - expires_at examples: - default: &356 + default: &355 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -24081,9 +26627,9 @@ paths: description: Response content: application/json: - schema: *157 + schema: *156 examples: - default: &357 + default: &356 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -24109,15 +26655,15 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - *73 - - *154 + - *153 responses: '200': description: Response content: application/json: - schema: *155 + schema: *154 examples: - default: &358 + default: &357 value: id: 23 name: MBP @@ -24159,7 +26705,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - *73 - - *154 + - *153 responses: '204': description: Response @@ -24186,9 +26732,9 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - *73 - - *154 + - *153 responses: - '200': &159 + '200': &158 description: Response content: application/json: @@ -24202,7 +26748,7 @@ paths: type: integer labels: type: array - items: *158 + items: *157 examples: default: value: @@ -24242,7 +26788,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - *73 - - *154 + - *153 requestBody: required: true content: @@ -24266,7 +26812,7 @@ paths: - gpu - accelerated responses: - '200': *159 + '200': *158 '404': *6 '422': *7 x-github: @@ -24291,7 +26837,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - *73 - - *154 + - *153 requestBody: required: true content: @@ -24316,7 +26862,7 @@ paths: - gpu - accelerated responses: - '200': *159 + '200': *158 '404': *6 '422': *7 x-github: @@ -24341,9 +26887,9 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - *73 - - *154 + - *153 responses: - '200': &359 + '200': &358 description: Response content: application/json: @@ -24357,7 +26903,7 @@ paths: type: integer labels: type: array - items: *158 + items: *157 examples: default: value: @@ -24399,8 +26945,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - *73 - - *154 - - &360 + - *153 + - &359 name: name description: The name of a self-hosted runner's custom label. in: path @@ -24408,7 +26954,7 @@ paths: schema: type: string responses: - '200': *159 + '200': *158 '404': *6 '422': *7 x-github: @@ -24451,7 +26997,7 @@ paths: type: integer secrets: type: array - items: &160 + items: &159 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -24532,7 +27078,7 @@ paths: description: Response content: application/json: - schema: &372 + schema: &371 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -24567,7 +27113,7 @@ paths: - key_id - key examples: - default: &373 + default: &372 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -24593,7 +27139,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - *73 - - &161 + - &160 name: secret_name description: The name of the secret. in: path @@ -24605,7 +27151,7 @@ paths: description: Response content: application/json: - schema: *160 + schema: *159 examples: default: value: @@ -24636,7 +27182,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - *73 - - *161 + - *160 requestBody: required: true content: @@ -24693,7 +27239,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -24720,7 +27266,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - *73 - - *161 + - *160 responses: '204': description: Response @@ -24747,7 +27293,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - *73 - - *161 + - *160 - *19 - *17 responses: @@ -24765,9 +27311,9 @@ paths: type: integer repositories: type: array - items: *153 + items: *152 examples: - default: &165 + default: &164 value: total_count: 1 repositories: @@ -24860,7 +27406,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - *73 - - *161 + - *160 requestBody: required: true content: @@ -24913,7 +27459,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - *73 - - *161 + - *160 - name: repository_id in: path required: true @@ -24947,7 +27493,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - *73 - - *161 + - *160 - name: repository_id in: path required: true @@ -24980,7 +27526,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *73 - - &341 + - &340 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/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -25004,7 +27550,7 @@ paths: type: integer variables: type: array - items: &163 + items: &162 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -25142,7 +27688,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -25168,7 +27714,7 @@ paths: url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - *73 - - &164 + - &163 name: name description: The name of the variable. in: path @@ -25180,7 +27726,7 @@ paths: description: Response content: application/json: - schema: *163 + schema: *162 examples: default: value: @@ -25211,7 +27757,7 @@ paths: url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - *73 - - *164 + - *163 requestBody: required: true content: @@ -25274,7 +27820,7 @@ paths: url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - *73 - - *164 + - *163 responses: '204': description: Response @@ -25301,7 +27847,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - *73 - - *164 + - *163 - *19 - *17 responses: @@ -25319,9 +27865,9 @@ paths: type: integer repositories: type: array - items: *153 + items: *152 examples: - default: *165 + default: *164 '409': description: Response when the visibility of the variable is not set to `selected` @@ -25348,7 +27894,7 @@ paths: url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - *73 - - *164 + - *163 requestBody: required: true content: @@ -25398,7 +27944,7 @@ paths: url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - *73 - - *164 + - *163 - name: repository_id in: path required: true @@ -25433,7 +27979,7 @@ paths: url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - *73 - - *164 + - *163 - name: repository_id in: path required: true @@ -25593,7 +28139,7 @@ paths: type: integer deployment_records: type: array - items: &166 + items: &165 title: Artifact Deployment Record description: Artifact Metadata Deployment Record type: object @@ -25638,7 +28184,7 @@ paths: description: The ID of the provenance attestation associated with the deployment record. examples: - default: &167 + default: &166 value: total_count: 1 deployment_records: @@ -25813,10 +28359,23 @@ paths: type: integer deployment_records: type: array - items: *166 + items: *165 examples: - default: *167 - '403': *27 + default: *166 + '403': + description: Forbidden + content: + application/json: + schema: *3 + examples: + insufficient_repo_permissions: + value: + message: + cause: artifact metadata write permission required on one or + more repositories + repositories: + - 123 + - 345 '404': *6 x-github: githubCloudOnly: false @@ -26029,9 +28588,9 @@ paths: - 3 deployment_records: type: array - items: *166 + items: *165 examples: - default: *167 + default: *166 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26161,12 +28720,12 @@ paths: required: - subject_digests examples: - default: &681 + default: &680 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &682 + withPredicateType: &681 value: subject_digests: - sha256:abc123 @@ -26211,7 +28770,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &683 + default: &682 value: attestations_subject_digests: - sha256:abc: @@ -26544,7 +29103,7 @@ paths: initiator: type: string examples: - default: &386 + default: &385 value: attestations: - bundle: @@ -26763,7 +29322,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &168 + schema: &167 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -26789,7 +29348,7 @@ paths: application/json: schema: type: array - items: &169 + items: &168 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -26820,7 +29379,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &188 + items: &187 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -26897,7 +29456,7 @@ paths: parent: anyOf: - type: 'null' - - &245 + - &244 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -27033,7 +29592,7 @@ paths: - string - 'null' format: date-time - state: *168 + state: *167 contact_link: description: The contact link of the campaign. type: @@ -27256,9 +29815,9 @@ paths: description: Response content: application/json: - schema: *169 + schema: *168 examples: - default: &170 + default: &169 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -27341,9 +29900,9 @@ paths: description: Response content: application/json: - schema: *169 + schema: *168 examples: - default: *170 + default: *169 '404': *6 '422': description: Unprocessable Entity @@ -27421,7 +29980,7 @@ paths: - string - 'null' format: uri - state: *168 + state: *167 examples: default: value: @@ -27431,9 +29990,9 @@ paths: description: Response content: application/json: - schema: *169 + schema: *168 examples: - default: *170 + default: *169 '400': description: Bad Request content: @@ -27500,17 +30059,17 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *73 - - &410 + - &409 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. in: query required: false - schema: &178 + schema: &177 type: string description: The name of the tool used to generate the code scanning analysis. - - &411 + - &410 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -27518,7 +30077,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &179 + schema: &178 type: - string - 'null' @@ -27534,7 +30093,7 @@ paths: be returned. in: query required: false - schema: &413 + schema: &412 type: string description: State of a code scanning alert. enum: @@ -27557,7 +30116,7 @@ paths: be returned. in: query required: false - schema: &414 + schema: &413 type: string description: Severity of a code scanning alert. enum: @@ -27586,18 +30145,18 @@ paths: items: type: object properties: - number: *171 - created_at: *172 - updated_at: *173 - url: *174 - html_url: *175 - instances_url: &415 + number: *170 + created_at: *171 + updated_at: *172 + url: *173 + html_url: *174 + instances_url: &414 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &180 + state: &179 type: - string - 'null' @@ -27607,13 +30166,13 @@ paths: - dismissed - fixed - - fixed_at: *176 + fixed_at: *175 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *177 - dismissed_reason: &416 + dismissed_at: *176 + dismissed_reason: &415 type: - string - 'null' @@ -27624,14 +30183,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &417 + dismissed_comment: &416 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &418 + rule: &417 type: object properties: id: @@ -27692,43 +30251,43 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &419 + tool: &418 type: object properties: - name: *178 + name: *177 version: type: - string - 'null' description: The version of the tool used to generate the code scanning analysis. - guid: *179 - most_recent_instance: &420 + guid: *178 + most_recent_instance: &419 type: object properties: - ref: &412 + ref: &411 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &430 + analysis_key: &429 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: &431 + environment: &430 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: &432 + category: &431 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. - state: *180 + state: *179 commit_sha: type: string message: @@ -27742,7 +30301,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: &433 + location: &432 type: object description: Describe a region within a file for the alert. properties: @@ -27763,7 +30322,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: &434 + items: &433 type: - string - 'null' @@ -28399,7 +30958,7 @@ paths: application/json: schema: *47 examples: - default: *181 + default: *180 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28427,9 +30986,9 @@ paths: description: Response content: application/json: - schema: *182 + schema: *181 examples: - default: *183 + default: *182 '304': *35 '403': *27 '404': *6 @@ -28481,7 +31040,7 @@ paths: - 32 - 91 responses: - '204': *184 + '204': *183 '400': *14 '403': *27 '404': *6 @@ -28516,7 +31075,7 @@ paths: application/json: schema: *47 examples: - default: *181 + default: *180 '304': *35 '403': *27 '404': *6 @@ -28816,7 +31375,7 @@ paths: - *73 - *49 responses: - '204': *184 + '204': *183 '400': *14 '403': *27 '404': *6 @@ -28954,7 +31513,7 @@ paths: default: value: default_for_new_repos: all - configuration: *181 + configuration: *180 '403': *27 '404': *6 x-github: @@ -29007,13 +31566,13 @@ paths: application/json: schema: type: array - items: *185 + items: *184 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *186 + repository: *185 '403': *27 '404': *6 x-github: @@ -29053,7 +31612,7 @@ paths: type: integer codespaces: type: array - items: &235 + items: &234 type: object title: Codespace description: A codespace. @@ -29084,11 +31643,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *153 + repository: *152 machine: anyOf: - type: 'null' - - &446 + - &445 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -29375,7 +31934,7 @@ paths: - pulls_url - recent_folders examples: - default: &236 + default: &235 value: total_count: 3 codespaces: @@ -29999,7 +32558,7 @@ paths: type: integer secrets: type: array - items: &187 + items: &186 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -30040,7 +32599,7 @@ paths: - updated_at - visibility examples: - default: &447 + default: &446 value: total_count: 2 secrets: @@ -30078,7 +32637,7 @@ paths: description: Response content: application/json: - schema: &448 + schema: &447 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -30113,7 +32672,7 @@ paths: - key_id - key examples: - default: &449 + default: &448 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -30137,15 +32696,15 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - *73 - - *161 + - *160 responses: '200': description: Response content: application/json: - schema: *187 + schema: *186 examples: - default: &451 + default: &450 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -30173,7 +32732,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - *73 - - *161 + - *160 requestBody: required: true content: @@ -30228,7 +32787,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -30255,7 +32814,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - *73 - - *161 + - *160 responses: '204': description: Response @@ -30281,7 +32840,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - *73 - - *161 + - *160 - *19 - *17 responses: @@ -30299,9 +32858,9 @@ paths: type: integer repositories: type: array - items: *153 + items: *152 examples: - default: *165 + default: *164 '404': *6 x-github: githubCloudOnly: false @@ -30324,7 +32883,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - *73 - - *161 + - *160 requestBody: required: true content: @@ -30375,7 +32934,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - *73 - - *161 + - *160 - name: repository_id in: path required: true @@ -30409,7 +32968,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - *73 - - *161 + - *160 - name: repository_id in: path required: true @@ -30612,7 +33171,7 @@ paths: currently being billed. seats: type: array - items: &238 + items: &237 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -30630,7 +33189,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *188 + - *187 - *66 type: - 'null' @@ -31243,12 +33802,12 @@ paths: type: integer repositories: type: array - items: *153 + items: *152 required: - total_count - repositories examples: - default: *189 + default: *188 '500': *53 '401': *23 '403': *27 @@ -31334,7 +33893,7 @@ paths: url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization parameters: - *73 - - *142 + - *141 responses: '204': description: No Content @@ -31368,7 +33927,7 @@ paths: url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization parameters: - *73 - - *142 + - *141 responses: '204': description: No Content @@ -31583,7 +34142,7 @@ paths: application/json: schema: type: array - items: &318 + items: &317 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -31898,7 +34457,7 @@ paths: - date additionalProperties: true examples: - default: &319 + default: &318 value: - date: '2024-06-24' total_active_users: 24 @@ -32000,7 +34559,7 @@ paths: '500': *53 '403': *27 '404': *6 - '422': &320 + '422': &319 description: Copilot Usage Metrics API setting is disabled at the organization or enterprise level. content: @@ -32041,7 +34600,7 @@ paths: schema: *55 examples: default: *56 - '204': *184 + '204': *183 '500': *53 '403': *27 '404': *6 @@ -32117,7 +34676,7 @@ paths: schema: *55 examples: default: *56 - '204': *184 + '204': *183 '500': *53 '403': *27 '404': *6 @@ -32180,11 +34739,11 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *73 + - *189 - *190 - *191 - *192 - *193 - - *194 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -32214,7 +34773,7 @@ paths: enum: - patch - deployment - - *195 + - *194 - name: runtime_risk in: query description: |- @@ -32223,8 +34782,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string + - *195 - *196 - - *197 - *59 - *45 - *46 @@ -32236,9 +34795,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *199 + default: *198 '304': *35 '400': *14 '403': *27 @@ -32282,7 +34841,7 @@ paths: type: integer secrets: type: array - items: &200 + items: &199 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -32361,7 +34920,7 @@ paths: description: Response content: application/json: - schema: &477 + schema: &476 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -32380,7 +34939,7 @@ paths: - key_id - key examples: - default: &478 + default: &477 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -32404,13 +34963,13 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - *73 - - *161 + - *160 responses: '200': description: Response content: application/json: - schema: *200 + schema: *199 examples: default: value: @@ -32439,7 +34998,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - *73 - - *161 + - *160 requestBody: required: true content: @@ -32494,7 +35053,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -32519,7 +35078,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - *73 - - *161 + - *160 responses: '204': description: Response @@ -32544,7 +35103,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - *73 - - *161 + - *160 - *19 - *17 responses: @@ -32562,9 +35121,9 @@ paths: type: integer repositories: type: array - items: *153 + items: *152 examples: - default: *165 + default: *164 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32586,7 +35145,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - *73 - - *161 + - *160 requestBody: required: true content: @@ -32637,7 +35196,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - *73 - - *161 + - *160 - name: repository_id in: path required: true @@ -32669,7 +35228,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - *73 - - *161 + - *160 - name: repository_id in: path required: true @@ -32707,7 +35266,7 @@ paths: application/json: schema: type: array - items: &247 + items: &246 title: Package description: A software package type: object @@ -32760,7 +35319,7 @@ paths: repository: anyOf: - type: 'null' - - *153 + - *152 created_at: type: string format: date-time @@ -32778,7 +35337,7 @@ paths: - created_at - updated_at examples: - default: &248 + default: &247 value: - id: 197 name: hello_docker @@ -32948,7 +35507,7 @@ paths: application/json: schema: type: array - items: &224 + items: &223 title: Organization Invitation description: Organization Invitation type: object @@ -33002,7 +35561,7 @@ paths: - invitation_teams_url - node_id examples: - default: &225 + default: &224 value: - id: 1 login: monalisa @@ -33069,7 +35628,7 @@ paths: application/json: schema: type: array - items: &201 + items: &200 title: Org Hook description: Org Hook type: object @@ -33254,9 +35813,9 @@ paths: description: Response content: application/json: - schema: *201 + schema: *200 examples: - default: &202 + default: &201 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -33304,7 +35863,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - *73 - - &203 + - &202 name: hook_id description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. @@ -33317,9 +35876,9 @@ paths: description: Response content: application/json: - schema: *201 + schema: *200 examples: - default: *202 + default: *201 '404': *6 x-github: githubCloudOnly: false @@ -33347,7 +35906,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - *73 - - *203 + - *202 requestBody: required: false content: @@ -33393,7 +35952,7 @@ paths: description: Response content: application/json: - schema: *201 + schema: *200 examples: default: value: @@ -33435,7 +35994,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - *73 - - *203 + - *202 responses: '204': description: Response @@ -33463,7 +36022,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *73 - - *203 + - *202 responses: '200': description: Response @@ -33494,7 +36053,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *73 - - *203 + - *202 requestBody: required: false content: @@ -33545,10 +36104,10 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *73 - - *203 + - *202 - *17 + - *203 - *204 - - *205 responses: '200': description: Response @@ -33556,9 +36115,9 @@ paths: application/json: schema: type: array - items: *206 + items: *205 examples: - default: *207 + default: *206 '400': *14 '422': *15 x-github: @@ -33584,16 +36143,16 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *73 - - *203 + - *202 - *16 responses: '200': description: Response content: application/json: - schema: *208 + schema: *207 examples: - default: *209 + default: *208 '400': *14 '422': *15 x-github: @@ -33619,7 +36178,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *73 - - *203 + - *202 - *16 responses: '202': *37 @@ -33649,7 +36208,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - *73 - - *203 + - *202 responses: '204': description: Response @@ -33672,7 +36231,7 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - *73 - - &214 + - &213 name: actor_type in: path description: The type of the actor @@ -33685,14 +36244,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &215 + - &214 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &210 + - &209 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -33700,7 +36259,7 @@ paths: required: true schema: type: string - - &211 + - &210 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -33795,12 +36354,12 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - *73 + - *209 - *210 - - *211 - *19 - *17 - *59 - - &220 + - &219 name: sort description: The property to sort the results by. in: query @@ -33879,14 +36438,14 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - *73 + - *209 - *210 - - *211 responses: '200': description: Response content: application/json: - schema: &212 + schema: &211 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -33902,7 +36461,7 @@ paths: type: integer format: int64 examples: - default: &213 + default: &212 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -33923,23 +36482,23 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - *73 - - &216 + - &215 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string + - *209 - *210 - - *211 responses: '200': description: Response content: application/json: - schema: *212 + schema: *211 examples: - default: *213 + default: *212 x-github: enabledForGitHubApps: true category: orgs @@ -33958,18 +36517,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *73 + - *209 - *210 - - *211 + - *213 - *214 - - *215 responses: '200': description: Response content: application/json: - schema: *212 + schema: *211 examples: - default: *213 + default: *212 x-github: enabledForGitHubApps: true category: orgs @@ -33987,9 +36546,9 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - *73 + - *209 - *210 - - *211 - - &217 + - &216 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -34002,7 +36561,7 @@ paths: description: Response content: application/json: - schema: &218 + schema: &217 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -34018,7 +36577,7 @@ paths: type: integer format: int64 examples: - default: &219 + default: &218 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -34055,18 +36614,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - *73 - - *216 + - *215 + - *209 - *210 - - *211 - - *217 + - *216 responses: '200': description: Response content: application/json: - schema: *218 + schema: *217 examples: - default: *219 + default: *218 x-github: enabledForGitHubApps: true category: orgs @@ -34084,19 +36643,19 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - *73 + - *213 - *214 - - *215 + - *209 - *210 - - *211 - - *217 + - *216 responses: '200': description: Response content: application/json: - schema: *218 + schema: *217 examples: - default: *219 + default: *218 x-github: enabledForGitHubApps: true category: orgs @@ -34114,13 +36673,13 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - *73 - - *216 + - *215 + - *209 - *210 - - *211 - *19 - *17 - *59 - - *220 + - *219 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -34204,7 +36763,7 @@ paths: application/json: schema: *20 examples: - default: &516 + default: &515 value: id: 1 account: @@ -34370,12 +36929,12 @@ paths: application/json: schema: anyOf: - - &222 + - &221 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &221 + limit: &220 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -34403,7 +36962,7 @@ paths: properties: {} additionalProperties: false examples: - default: &223 + default: &222 value: limit: collaborators_only origin: organization @@ -34432,13 +36991,13 @@ paths: required: true content: application/json: - schema: &517 + schema: &516 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *221 + limit: *220 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -34463,9 +37022,9 @@ paths: description: Response content: application/json: - schema: *222 + schema: *221 examples: - default: *223 + default: *222 '422': *15 x-github: githubCloudOnly: false @@ -34541,9 +37100,9 @@ paths: application/json: schema: type: array - items: *224 + items: *223 examples: - default: *225 + default: *224 headers: Link: *65 '404': *6 @@ -34620,7 +37179,7 @@ paths: description: Response content: application/json: - schema: *224 + schema: *223 examples: default: value: @@ -34675,7 +37234,7 @@ paths: url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - *73 - - &226 + - &225 name: invitation_id description: The unique identifier of the invitation. in: path @@ -34706,7 +37265,7 @@ paths: url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - *73 - - *226 + - *225 - *17 - *19 responses: @@ -34716,9 +37275,9 @@ paths: application/json: schema: type: array - items: *188 + items: *187 examples: - default: &246 + default: &245 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -34761,7 +37320,7 @@ paths: application/json: schema: type: array - items: &227 + items: &226 title: Issue Field description: A custom attribute defined at the organization level for attaching structured data to issues. @@ -35004,9 +37563,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *226 examples: - default: &228 + default: &227 value: id: 512 node_id: IF_kwDNAd3NAZr @@ -35062,7 +37621,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-fields#update-issue-field-for-an-organization parameters: - *73 - - &229 + - &228 name: issue_field_id description: The unique identifier of the issue field. in: path @@ -35163,9 +37722,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *226 examples: - default: *228 + default: *227 '404': *6 '422': *7 x-github: @@ -35190,9 +37749,9 @@ paths: url: https://docs.github.com/rest/orgs/issue-fields#delete-issue-field-for-an-organization parameters: - *73 - - *229 + - *228 responses: - '204': *184 + '204': *183 '404': *6 '422': *7 x-github: @@ -35220,7 +37779,7 @@ paths: application/json: schema: type: array - items: *230 + items: *229 examples: default: value: @@ -35308,9 +37867,9 @@ paths: description: Response content: application/json: - schema: *230 + schema: *229 examples: - default: &231 + default: &230 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -35343,7 +37902,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *73 - - &232 + - &231 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -35399,9 +37958,9 @@ paths: description: Response content: application/json: - schema: *230 + schema: *229 examples: - default: *231 + default: *230 '404': *6 '422': *7 x-github: @@ -35426,7 +37985,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *73 - - *232 + - *231 responses: '204': description: Response @@ -35489,7 +38048,7 @@ paths: - closed - all default: open - - *233 + - *232 - name: type description: Can be the name of an issue type. in: query @@ -35520,7 +38079,7 @@ paths: type: array items: *81 examples: - default: *234 + default: *233 headers: Link: *65 '404': *6 @@ -35680,9 +38239,9 @@ paths: type: integer codespaces: type: array - items: *235 + items: *234 examples: - default: *236 + default: *235 '304': *35 '500': *53 '401': *23 @@ -35709,7 +38268,7 @@ paths: parameters: - *73 - *69 - - &237 + - &236 name: codespace_name in: path required: true @@ -35744,15 +38303,15 @@ paths: parameters: - *73 - *69 - - *237 + - *236 responses: '200': description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: &445 + default: &444 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -35932,7 +38491,7 @@ paths: description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *238 + schema: *237 examples: default: value: @@ -36008,7 +38567,7 @@ paths: description: Response content: application/json: - schema: &239 + schema: &238 title: Org Membership description: Org Membership type: object @@ -36077,7 +38636,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &240 + response-if-user-has-an-active-admin-membership-with-organization: &239 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -36178,9 +38737,9 @@ paths: description: Response content: application/json: - schema: *239 + schema: *238 examples: - response-if-user-already-had-membership-with-organization: *240 + response-if-user-already-had-membership-with-organization: *239 '422': *15 '403': *27 '451': *15 @@ -36253,7 +38812,7 @@ paths: application/json: schema: type: array - items: &241 + items: &240 title: Migration description: A migration. type: object @@ -36591,7 +39150,7 @@ paths: description: Response content: application/json: - schema: *241 + schema: *240 examples: default: value: @@ -36770,7 +39329,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - *73 - - &242 + - &241 name: migration_id description: The unique identifier of the migration. in: path @@ -36798,7 +39357,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *241 + schema: *240 examples: default: value: @@ -36968,7 +39527,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - *73 - - *242 + - *241 responses: '302': description: Response @@ -36990,7 +39549,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *73 - - *242 + - *241 responses: '204': description: Response @@ -37014,8 +39573,8 @@ paths: url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - *73 - - *242 - - &663 + - *241 + - &662 name: repo_name description: repo_name parameter in: path @@ -37043,7 +39602,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *73 - - *242 + - *241 - *17 - *19 responses: @@ -37071,7 +39630,7 @@ paths: To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -37097,7 +39656,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &244 + items: &243 title: Organization Role description: Organization roles type: object @@ -37274,7 +39833,7 @@ paths: parameters: - *73 - *75 - - &243 + - &242 name: role_id description: The unique identifier of the role. in: path @@ -37311,7 +39870,7 @@ paths: parameters: - *73 - *75 - - *243 + - *242 responses: '204': description: Response @@ -37364,7 +39923,7 @@ paths: parameters: - *73 - *69 - - *243 + - *242 responses: '204': description: Response @@ -37396,7 +39955,7 @@ paths: parameters: - *73 - *69 - - *243 + - *242 responses: '204': description: Response @@ -37414,7 +39973,7 @@ paths: To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: @@ -37425,13 +39984,13 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - *73 - - *243 + - *242 responses: '200': description: Response content: application/json: - schema: *244 + schema: *243 examples: default: value: @@ -37482,7 +40041,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - *73 - - *243 + - *242 - *17 - *19 responses: @@ -37561,7 +40120,7 @@ paths: parent: anyOf: - type: 'null' - - *245 + - *244 type: description: The ownership type of the team type: string @@ -37594,7 +40153,7 @@ paths: - type - parent examples: - default: *246 + default: *245 headers: Link: *65 '404': @@ -37624,7 +40183,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - *73 - - *243 + - *242 - *17 - *19 responses: @@ -37653,7 +40212,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *245 + items: *244 name: type: - string @@ -37963,7 +40522,7 @@ paths: - nuget - container - *73 - - &664 + - &663 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -37999,12 +40558,12 @@ paths: application/json: schema: type: array - items: *247 + items: *246 examples: - default: *248 + default: *247 '403': *27 '401': *23 - '400': &666 + '400': &665 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -38026,7 +40585,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &249 + - &248 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -38044,7 +40603,7 @@ paths: - docker - nuget - container - - &250 + - &249 name: package_name description: The name of the package. in: path @@ -38057,7 +40616,7 @@ paths: description: Response content: application/json: - schema: *247 + schema: *246 examples: default: value: @@ -38109,8 +40668,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: + - *248 - *249 - - *250 - *73 responses: '204': @@ -38143,8 +40702,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: + - *248 - *249 - - *250 - *73 - name: token description: package token @@ -38177,8 +40736,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: + - *248 - *249 - - *250 - *73 - *19 - *17 @@ -38199,7 +40758,7 @@ paths: application/json: schema: type: array - items: &251 + items: &250 title: Package Version description: A version of a software package type: object @@ -38334,10 +40893,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: + - *248 - *249 - - *250 - *73 - - &252 + - &251 name: package_version_id description: Unique identifier of the package version. in: path @@ -38349,7 +40908,7 @@ paths: description: Response content: application/json: - schema: *251 + schema: *250 examples: default: value: @@ -38385,10 +40944,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: + - *248 - *249 - - *250 - *73 - - *252 + - *251 responses: '204': description: Response @@ -38420,10 +40979,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: + - *248 - *249 - - *250 - *73 - - *252 + - *251 responses: '204': description: Response @@ -38453,7 +41012,7 @@ paths: - *73 - *17 - *19 - - &253 + - &252 name: sort description: The property by which to sort the results. in: query @@ -38464,7 +41023,7 @@ paths: - created_at default: created_at - *59 - - &254 + - &253 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -38476,7 +41035,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &255 + - &254 name: repository description: The name of the repository to use to filter the results. in: query @@ -38485,7 +41044,7 @@ paths: type: string examples: - Hello-World - - &256 + - &255 name: permission description: The permission to use to filter the results. in: query @@ -38494,7 +41053,7 @@ paths: type: string examples: - issues_read - - &257 + - &256 name: last_used_before description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -38504,7 +41063,7 @@ paths: schema: type: string format: date-time - - &258 + - &257 name: last_used_after description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -38514,7 +41073,7 @@ paths: schema: type: string format: date-time - - &259 + - &258 name: token_id description: The ID of the token in: query @@ -38790,7 +41349,7 @@ paths: '422': *15 '404': *6 '403': *27 - '204': *184 + '204': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38831,9 +41390,9 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: - default: &260 + default: &259 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -38970,14 +41529,14 @@ paths: - *73 - *17 - *19 - - *253 + - *252 - *59 + - *253 - *254 - *255 - *256 - *257 - *258 - - *259 responses: '500': *53 '422': *15 @@ -39218,7 +41777,7 @@ paths: responses: '500': *53 '404': *6 - '204': *184 + '204': *183 '403': *27 '422': *15 x-github: @@ -39259,9 +41818,9 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: - default: *260 + default: *259 headers: Link: *65 x-github: @@ -39303,7 +41862,7 @@ paths: type: integer configurations: type: array - items: &261 + items: &260 title: Organization private registry description: Private registry configuration for an organization type: object @@ -39737,7 +42296,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &262 + org-private-registry-with-selected-visibility: &261 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -39829,15 +42388,15 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - *73 - - *161 + - *160 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *261 + schema: *260 examples: - default: *262 + default: *261 '404': *6 x-github: githubCloudOnly: false @@ -39860,7 +42419,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - *73 - - *161 + - *160 requestBody: required: true content: @@ -40025,7 +42584,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - *73 - - *161 + - *160 responses: '204': description: Response @@ -40065,7 +42624,7 @@ paths: application/json: schema: type: array - items: &263 + items: &262 title: Projects v2 Project description: A projects v2 project type: object @@ -40139,7 +42698,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &750 + - &749 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -40224,7 +42783,7 @@ paths: - deleted_at - deleted_by examples: - default: &264 + default: &263 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -40327,7 +42886,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &265 + - &264 name: project_number description: The project's number. in: path @@ -40340,9 +42899,9 @@ paths: description: Response content: application/json: - schema: *263 + schema: *262 examples: - default: *264 + default: *263 headers: Link: *65 '304': *35 @@ -40365,7 +42924,7 @@ paths: url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - *73 - - *265 + - *264 requestBody: required: true description: Details of the draft item to create in the project. @@ -40399,7 +42958,7 @@ paths: description: Response content: application/json: - schema: &270 + schema: &269 title: Projects v2 Item description: An item belonging to a project type: object @@ -40413,7 +42972,7 @@ paths: content: oneOf: - *81 - - &460 + - &459 title: Pull Request Simple description: Pull Request Simple type: object @@ -40533,7 +43092,7 @@ paths: milestone: anyOf: - type: 'null' - - *266 + - *265 active_lock_reason: type: - string @@ -40572,7 +43131,7 @@ paths: items: *4 requested_teams: type: array - items: *188 + items: *187 head: type: object properties: @@ -40616,7 +43175,7 @@ paths: _links: type: object properties: - comments: &267 + comments: &266 title: Link description: Hypermedia Link type: object @@ -40625,13 +43184,13 @@ paths: type: string required: - href - commits: *267 - statuses: *267 - html: *267 - issue: *267 - review_comments: *267 - review_comment: *267 - self: *267 + commits: *266 + statuses: *266 + html: *266 + issue: *266 + review_comments: *266 + review_comment: *266 + self: *266 required: - comments - commits @@ -40642,7 +43201,7 @@ paths: - review_comment - self author_association: *78 - auto_merge: &562 + auto_merge: &561 title: Auto merge description: The status of auto merging a pull request. type: @@ -40742,7 +43301,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &269 + content_type: &268 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -40786,7 +43345,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &271 + draft_issue: &270 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -40860,7 +43419,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *265 + - *264 - *73 - *17 - *45 @@ -40872,7 +43431,7 @@ paths: application/json: schema: type: array - items: &268 + items: &267 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -41025,7 +43584,7 @@ paths: - updated_at - project_url examples: - default: &686 + default: &685 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -41155,7 +43714,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project parameters: - - *265 + - *264 - *73 requestBody: required: true @@ -41202,7 +43761,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &687 + items: &686 type: object properties: name: @@ -41239,7 +43798,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &688 + iteration_configuration: &687 type: object description: The configuration for iteration fields. properties: @@ -41289,7 +43848,7 @@ paths: value: name: Due date data_type: date - single_select_field: &689 + single_select_field: &688 summary: Create a single select field value: name: Priority @@ -41316,7 +43875,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &690 + iteration_field: &689 summary: Create an iteration field value: name: Sprint @@ -41340,9 +43899,9 @@ paths: description: Response for adding a field to an organization-owned project. content: application/json: - schema: *268 + schema: *267 examples: - text_field: &691 + text_field: &690 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -41351,7 +43910,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: &692 + number_field: &691 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -41360,7 +43919,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: &693 + date_field: &692 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -41369,7 +43928,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: &694 + single_select_field: &693 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -41403,7 +43962,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &695 + iteration_field: &694 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -41448,8 +44007,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *265 - - &696 + - *264 + - &695 name: field_id description: The unique identifier of the field. in: path @@ -41462,9 +44021,9 @@ paths: description: Response content: application/json: - schema: *268 + schema: *267 examples: - default: &697 + default: &696 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -41520,7 +44079,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *265 + - *264 - *73 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) @@ -41553,7 +44112,7 @@ paths: application/json: schema: type: array - items: &272 + items: &271 title: Projects v2 Item description: An item belonging to a project type: object @@ -41570,7 +44129,7 @@ paths: description: The API URL of the project that contains this item. examples: - https://api.github.com/users/monalisa/2/projectsV2/3 - content_type: *269 + content_type: *268 content: type: - object @@ -41620,7 +44179,7 @@ paths: - updated_at - archived_at examples: - default: &273 + default: &272 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -42318,7 +44877,7 @@ paths: url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - *73 - - *265 + - *264 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -42388,22 +44947,22 @@ paths: description: Response content: application/json: - schema: *270 + schema: *269 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *271 + value: *270 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *271 + value: *270 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *271 + value: *270 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *271 + value: *270 '304': *35 '403': *27 '401': *23 @@ -42423,9 +44982,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *265 + - *264 - *73 - - &274 + - &273 name: item_id description: The unique identifier of the project item. in: path @@ -42451,9 +45010,9 @@ paths: description: Response content: application/json: - schema: *272 + schema: *271 examples: - default: *273 + default: *272 headers: Link: *65 '304': *35 @@ -42474,9 +45033,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *265 + - *264 - *73 - - *274 + - *273 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -42549,13 +45108,13 @@ paths: description: Response content: application/json: - schema: *272 + schema: *271 examples: - text_field: *273 - number_field: *273 - date_field: *273 - single_select_field: *273 - iteration_field: *273 + text_field: *272 + number_field: *272 + date_field: *272 + single_select_field: *272 + iteration_field: *272 '401': *23 '403': *27 '404': *6 @@ -42575,9 +45134,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *265 + - *264 - *73 - - *274 + - *273 responses: '204': description: Response @@ -42601,7 +45160,7 @@ paths: url: https://docs.github.com/rest/projects/views#create-a-view-for-an-organization-owned-project parameters: - *73 - - *265 + - *264 requestBody: required: true content: @@ -42675,7 +45234,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &678 + schema: &677 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -42779,7 +45338,7 @@ paths: examples: table_view: summary: Response for creating a table view - value: &275 + value: &274 value: id: 1 number: 1 @@ -42825,10 +45384,10 @@ paths: - 456 board_view: summary: Response for creating a board view with filter - value: *275 + value: *274 roadmap_view: summary: Response for creating a roadmap view - value: *275 + value: *274 '304': *35 '403': *27 '401': *23 @@ -42856,9 +45415,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-project-view parameters: - - *265 + - *264 - *73 - - &698 + - &697 name: view_number description: The number that identifies the project view. in: path @@ -42890,9 +45449,9 @@ paths: application/json: schema: type: array - items: *272 + items: *271 examples: - default: *273 + default: *272 headers: Link: *65 '304': *35 @@ -42925,7 +45484,7 @@ paths: application/json: schema: type: array - items: &276 + items: &275 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -43003,7 +45562,7 @@ paths: - property_name - value_type examples: - default: &277 + default: &276 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -43063,7 +45622,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *276 + items: *275 minItems: 1 maxItems: 100 required: @@ -43093,9 +45652,9 @@ paths: application/json: schema: type: array - items: *276 + items: *275 examples: - default: *277 + default: *276 '403': *27 '404': *6 x-github: @@ -43117,7 +45676,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - *73 - - &278 + - &277 name: custom_property_name description: The custom property name in: path @@ -43129,9 +45688,9 @@ paths: description: Response content: application/json: - schema: *276 + schema: *275 examples: - default: &279 + default: &278 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -43166,7 +45725,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - *73 - - *278 + - *277 requestBody: required: true content: @@ -43246,9 +45805,9 @@ paths: description: Response content: application/json: - schema: *276 + schema: *275 examples: - default: *279 + default: *278 '403': *27 '404': *6 x-github: @@ -43272,9 +45831,9 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - *73 - - *278 + - *277 responses: - '204': *184 + '204': *183 '403': *27 '404': *6 x-github: @@ -43336,7 +45895,7 @@ paths: - octocat/Hello-World properties: type: array - items: &280 + items: &279 title: Custom Property Value description: Custom property name and associated value type: object @@ -43426,7 +45985,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *280 + items: *279 required: - repository_names - properties @@ -43616,9 +46175,9 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: - default: *260 + default: *259 headers: Link: *65 x-github: @@ -43821,7 +46380,7 @@ paths: description: Response content: application/json: - schema: &328 + schema: &327 title: Full Repository description: Full Repository type: object @@ -44291,7 +46850,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &465 + code_of_conduct: &464 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -44321,7 +46880,7 @@ paths: - key - name - html_url - security_and_analysis: *281 + security_and_analysis: *280 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -44405,7 +46964,7 @@ paths: - network_count - subscribers_count examples: - default: &330 + default: &329 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -44927,7 +47486,7 @@ paths: - *73 - *17 - *19 - - &584 + - &583 name: targets description: | A comma-separated list of rule targets to filter by. @@ -44946,7 +47505,7 @@ paths: application/json: schema: type: array - items: &308 + items: &307 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -44981,7 +47540,7 @@ paths: source: type: string description: The name of the source - enforcement: &284 + enforcement: &283 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -44994,7 +47553,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &285 + items: &284 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -45065,7 +47624,7 @@ paths: description: The html URL of the ruleset conditions: anyOf: - - &282 + - &281 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -45089,7 +47648,7 @@ paths: match. items: type: string - - &286 + - &285 title: Organization ruleset conditions type: object description: |- @@ -45103,7 +47662,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *282 + - *281 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -45137,7 +47696,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *282 + - *281 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -45159,7 +47718,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *282 + - *281 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -45172,7 +47731,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &283 + items: &282 title: Repository ruleset property targeting definition type: object @@ -45205,7 +47764,7 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *283 + items: *282 required: - repository_property type: @@ -45213,12 +47772,12 @@ paths: - object rules: type: array - items: &585 + items: &584 title: Repository Rule type: object description: A repository rule. oneOf: - - &287 + - &286 title: creation description: Only allow users with bypass permission to create matching refs. @@ -45230,7 +47789,7 @@ paths: type: string enum: - creation - - &288 + - &287 title: update description: Only allow users with bypass permission to update matching refs. @@ -45251,7 +47810,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &289 + - &288 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -45263,7 +47822,7 @@ paths: type: string enum: - deletion - - &290 + - &289 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -45275,7 +47834,7 @@ paths: type: string enum: - required_linear_history - - &583 + - &582 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -45353,7 +47912,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &291 + - &290 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -45377,7 +47936,7 @@ paths: type: string required: - required_deployment_environments - - &292 + - &291 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -45389,7 +47948,7 @@ paths: type: string enum: - required_signatures - - &293 + - &292 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -45495,7 +48054,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &294 + - &293 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -45543,7 +48102,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &295 + - &294 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -45555,7 +48114,7 @@ paths: type: string enum: - non_fast_forward - - &296 + - &295 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -45592,7 +48151,7 @@ paths: required: - operator - pattern - - &297 + - &296 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -45629,7 +48188,7 @@ paths: required: - operator - pattern - - &298 + - &297 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -45666,7 +48225,7 @@ paths: required: - operator - pattern - - &299 + - &298 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -45703,7 +48262,7 @@ paths: required: - operator - pattern - - &300 + - &299 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -45740,7 +48299,7 @@ paths: required: - operator - pattern - - &301 + - &300 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -45765,7 +48324,7 @@ paths: type: string required: - restricted_file_paths - - &302 + - &301 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -45789,7 +48348,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &303 + - &302 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -45812,7 +48371,7 @@ paths: type: string required: - restricted_file_extensions - - &304 + - &303 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -45837,7 +48396,7 @@ paths: maximum: 100 required: - max_file_size - - &305 + - &304 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -45887,7 +48446,7 @@ paths: - repository_id required: - workflows - - &306 + - &305 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -45948,7 +48507,7 @@ paths: - tool required: - code_scanning_tools - - &307 + - &306 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -46047,20 +48606,21 @@ paths: - push - repository default: branch - enforcement: *284 + enforcement: *283 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *285 - conditions: *286 + items: *284 + conditions: *285 rules: type: array description: An array of rules within the ruleset. - items: &310 + items: &309 title: Repository Rule type: object description: A repository rule. oneOf: + - *286 - *287 - *288 - *289 @@ -46081,7 +48641,6 @@ paths: - *304 - *305 - *306 - - *307 required: - name - enforcement @@ -46119,9 +48678,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *307 examples: - default: &309 + default: &308 value: id: 21 name: super cool ruleset @@ -46177,7 +48736,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *73 - - &586 + - &585 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 @@ -46192,7 +48751,7 @@ paths: in: query schema: type: string - - &587 + - &586 name: time_period description: |- The time period to filter by. @@ -46208,14 +48767,14 @@ paths: - week - month default: day - - &588 + - &587 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 - - &589 + - &588 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -46235,7 +48794,7 @@ paths: description: Response content: application/json: - schema: &590 + schema: &589 title: Rule Suites description: Response type: array @@ -46291,7 +48850,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &591 + default: &590 value: - id: 21 actor_id: 12 @@ -46335,7 +48894,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *73 - - &592 + - &591 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -46351,7 +48910,7 @@ paths: description: Response content: application/json: - schema: &593 + schema: &592 title: Rule Suite description: Response type: object @@ -46458,7 +49017,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &594 + default: &593 value: id: 21 actor_id: 12 @@ -46531,9 +49090,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *307 examples: - default: *309 + default: *308 '404': *6 '500': *53 put: @@ -46577,16 +49136,16 @@ paths: - tag - push - repository - enforcement: *284 + enforcement: *283 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *285 - conditions: *286 + items: *284 + conditions: *285 rules: description: An array of rules within the ruleset. type: array - items: *310 + items: *309 examples: default: value: @@ -46621,9 +49180,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *307 examples: - default: *309 + default: *308 '404': *6 '422': *15 '500': *53 @@ -46681,7 +49240,7 @@ paths: application/json: schema: type: array - items: &311 + items: &310 title: Ruleset version type: object description: The historical version of a ruleset @@ -46705,7 +49264,7 @@ paths: type: string format: date-time examples: - default: &596 + default: &595 value: - version_id: 3 actor: @@ -46758,9 +49317,9 @@ paths: description: Response content: application/json: - schema: &597 + schema: &596 allOf: - - *311 + - *310 - type: object required: - state @@ -46830,7 +49389,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *73 - - &598 + - &597 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -46841,7 +49400,7 @@ paths: enum: - open - resolved - - &599 + - &598 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -46851,7 +49410,7 @@ paths: required: false schema: type: string - - &600 + - &599 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -46860,7 +49419,7 @@ paths: required: false schema: type: string - - &601 + - &600 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -46879,7 +49438,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &602 + - &601 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -46894,7 +49453,7 @@ paths: - *59 - *19 - *17 - - &603 + - &602 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 events before this cursor. To @@ -46904,7 +49463,7 @@ paths: required: false schema: type: string - - &604 + - &603 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 events after this cursor. To @@ -46914,7 +49473,7 @@ paths: required: false schema: type: string - - &605 + - &604 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -46923,7 +49482,7 @@ paths: required: false schema: type: string - - &606 + - &605 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -46932,7 +49491,7 @@ paths: schema: type: boolean default: false - - &607 + - &606 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -46941,7 +49500,7 @@ paths: schema: type: boolean default: false - - &608 + - &607 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -46960,27 +49519,27 @@ paths: items: type: object properties: - number: *171 - created_at: *172 + number: *170 + created_at: *171 updated_at: anyOf: - type: 'null' - - *173 - url: *174 - html_url: *175 + - *172 + url: *173 + html_url: *174 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &609 + state: &608 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: &610 + resolution: &609 type: - string - 'null' @@ -47087,14 +49646,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &611 + - &610 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &613 + - &612 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -47141,6 +49700,13 @@ paths: type: string description: The API URL to get the associated commit resource + html_url: + type: string + format: uri + description: The GitHub URL to get the associated commit + resource. + examples: + - https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1 required: - path - start_line @@ -47151,7 +49717,7 @@ paths: - blob_url - commit_sha - commit_url - - &614 + - &613 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. @@ -47212,7 +49778,7 @@ paths: - page_url - commit_sha - commit_url - - &615 + - &614 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -47225,9 +49791,16 @@ paths: secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/1347 + html_url: + type: string + format: uri + description: The GitHub URL for the issue where the + secret was detected. + examples: + - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &616 + - &615 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -47240,9 +49813,16 @@ paths: secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/1347 + html_url: + type: string + format: uri + description: The GitHub URL for the issue where the + secret was detected. + examples: + - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &617 + - &616 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -47255,9 +49835,16 @@ paths: the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + html_url: + type: string + format: uri + description: The GitHub URL for the issue comment where + the secret was detected. + examples: + - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &618 + - &617 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -47272,7 +49859,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &619 + - &618 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -47287,7 +49874,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &620 + - &619 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -47302,7 +49889,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &621 + - &620 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. @@ -47315,9 +49902,16 @@ paths: the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request where + the secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &622 + - &621 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. @@ -47330,9 +49924,16 @@ paths: the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request where + the secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &623 + - &622 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. @@ -47345,9 +49946,16 @@ paths: where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request comment + where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &624 + - &623 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. @@ -47360,9 +49968,16 @@ paths: where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request review + where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &625 + - &624 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 @@ -47376,6 +49991,13 @@ paths: comment where the secret was detected. examples: - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request review + comment where the secret was detected. + examples: + - https://github.com/octocat/Hello-World/pull/2846#discussion_r12 required: - pull_request_review_comment_url has_more_locations: @@ -47602,7 +50224,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &313 + pattern_config_version: &312 type: - string - 'null' @@ -47612,7 +50234,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &312 + items: &311 type: object properties: token_type: @@ -47681,7 +50303,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *312 + items: *311 examples: default: value: @@ -47738,7 +50360,7 @@ paths: schema: type: object properties: - pattern_config_version: *313 + pattern_config_version: *312 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -47764,7 +50386,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *313 + custom_pattern_version: *312 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -47862,7 +50484,7 @@ paths: application/json: schema: type: array - items: &629 + items: &628 description: A repository security advisory. type: object properties: @@ -48085,7 +50707,7 @@ paths: login: type: string description: The username of the user credited. - type: *314 + type: *313 credits_detailed: type: - array @@ -48096,7 +50718,7 @@ paths: type: object properties: user: *4 - type: *314 + type: *313 state: type: string description: The state of the user's acceptance of the @@ -48122,7 +50744,7 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *188 + items: *187 private_fork: readOnly: true description: A temporary private fork of the advisory's repository @@ -48159,7 +50781,7 @@ paths: - private_fork additionalProperties: false examples: - default: &630 + default: &629 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -48546,7 +51168,7 @@ paths: application/json: schema: type: array - items: *245 + items: *244 examples: default: value: @@ -48766,9 +51388,9 @@ paths: type: integer repositories: type: array - items: *153 + items: *152 examples: - default: *165 + default: *164 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48837,7 +51459,7 @@ paths: url: https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *73 - - *142 + - *141 responses: '204': description: Response @@ -48860,7 +51482,7 @@ paths: url: https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *73 - - *142 + - *141 responses: '204': description: Response @@ -48901,7 +51523,7 @@ paths: type: integer network_configurations: type: array - items: &315 + items: &314 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -49026,6 +51648,19 @@ paths: must be specified in the list. items: type: string + failover_network_settings_ids: + type: array + minItems: 0 + maxItems: 1 + description: A list of identifiers of the failover network settings + resources to use for the network configuration. Exactly one resource + identifier must be specified in the list. + items: + type: string + failover_network_enabled: + type: boolean + description: Indicates whether the failover network resource is + enabled. required: - name - network_settings_ids @@ -49041,9 +51676,9 @@ paths: description: Response content: application/json: - schema: *315 + schema: *314 examples: - default: &316 + default: &315 value: id: 123456789ABCDEF name: My network configuration @@ -49072,7 +51707,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - *73 - - &317 + - &316 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -49084,9 +51719,9 @@ paths: description: Response content: application/json: - schema: *315 + schema: *314 examples: - default: *316 + default: *315 headers: Link: *65 x-github: @@ -49108,7 +51743,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - *73 - - *317 + - *316 requestBody: required: true content: @@ -49136,6 +51771,19 @@ paths: must be specified in the list. items: type: string + failover_network_settings_ids: + type: array + minItems: 0 + maxItems: 1 + description: A list of identifiers of the failover network settings + resources to use for the network configuration. Exactly one resource + identifier must be specified in the list. + items: + type: string + failover_network_enabled: + type: boolean + description: Indicates whether the failover network resource is + enabled. examples: default: value: @@ -49148,9 +51796,9 @@ paths: description: Response content: application/json: - schema: *315 + schema: *314 examples: - default: *316 + default: *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49170,7 +51818,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - *73 - - *317 + - *316 responses: '204': description: Response @@ -49315,13 +51963,13 @@ paths: application/json: schema: type: array - items: *318 + items: *317 examples: - default: *319 + default: *318 '500': *53 '403': *27 '404': *6 - '422': *320 + '422': *319 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49361,9 +52009,9 @@ paths: application/json: schema: type: array - items: *188 + items: *187 examples: - default: *246 + default: *245 headers: Link: *65 '403': *27 @@ -49449,7 +52097,7 @@ paths: description: Response content: application/json: - schema: &321 + schema: &320 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -49523,7 +52171,7 @@ paths: parent: anyOf: - type: 'null' - - *245 + - *244 members_count: type: integer examples: @@ -49848,7 +52496,7 @@ paths: - repos_count - organization examples: - default: &322 + default: &321 value: id: 1 node_id: MDQ6VGVhbTE= @@ -49925,9 +52573,9 @@ paths: description: Response content: application/json: - schema: *321 + schema: *320 examples: - default: *322 + default: *321 '404': *6 x-github: githubCloudOnly: false @@ -50012,16 +52660,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *321 + schema: *320 examples: - default: *322 + default: *321 '201': description: Response content: application/json: - schema: *321 + schema: *320 examples: - default: *322 + default: *321 '404': *6 '422': *15 '403': *27 @@ -50051,7 +52699,7 @@ paths: responses: '204': description: Response - '422': &323 + '422': &322 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -50085,12 +52733,12 @@ paths: application/json: schema: type: array - items: *224 + items: *223 examples: - default: *225 + default: *224 headers: Link: *65 - '422': *323 + '422': *322 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50172,7 +52820,7 @@ paths: description: Response content: application/json: - schema: &324 + schema: &323 title: Team Membership description: Team Membership type: object @@ -50200,7 +52848,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &646 + response-if-user-is-a-team-maintainer: &645 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -50263,9 +52911,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *323 examples: - response-if-users-membership-with-team-is-now-pending: &647 + response-if-users-membership-with-team-is-now-pending: &646 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -50339,9 +52987,9 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: - default: *260 + default: *259 headers: Link: *65 x-github: @@ -50372,14 +53020,14 @@ paths: parameters: - *73 - *75 + - *324 - *325 - - *326 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &648 + schema: &647 title: Team Repository description: A team's access to a repository. type: object @@ -51015,8 +53663,8 @@ paths: parameters: - *73 - *75 + - *324 - *325 - - *326 requestBody: required: false content: @@ -51063,8 +53711,8 @@ paths: parameters: - *73 - *75 + - *324 - *325 - - *326 responses: '204': description: Response @@ -51099,9 +53747,9 @@ paths: application/json: schema: type: array - items: *188 + items: *187 examples: - response-if-child-teams-exist: &649 + response-if-child-teams-exist: &648 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -51255,7 +53903,7 @@ paths: resources: type: object properties: - core: &327 + core: &326 title: Rate Limit type: object properties: @@ -51272,17 +53920,17 @@ paths: - remaining - reset - used - graphql: *327 - search: *327 - code_search: *327 - source_import: *327 - integration_manifest: *327 - code_scanning_upload: *327 - actions_runner_registration: *327 - scim: *327 - dependency_snapshots: *327 - dependency_sbom: *327 - code_scanning_autofix: *327 + graphql: *326 + search: *326 + code_search: *326 + source_import: *326 + integration_manifest: *326 + code_scanning_upload: *326 + actions_runner_registration: *326 + scim: *326 + dependency_snapshots: *326 + dependency_sbom: *326 + code_scanning_autofix: *326 required: - core - search @@ -51389,14 +54037,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *328 + schema: *327 examples: default-response: summary: Default response @@ -51901,7 +54549,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *329 + '301': *328 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51919,8 +54567,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: false content: @@ -52212,10 +54860,10 @@ paths: description: Response content: application/json: - schema: *328 + schema: *327 examples: - default: *330 - '307': &331 + default: *329 + '307': &330 description: Temporary Redirect content: application/json: @@ -52244,8 +54892,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -52267,7 +54915,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *331 + '307': *330 '404': *6 '409': *52 x-github: @@ -52291,11 +54939,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: + - *324 - *325 - - *326 - *17 - *19 - - &364 + - &363 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -52318,7 +54966,7 @@ paths: type: integer artifacts: type: array - items: &332 + items: &331 title: Artifact description: An artifact type: object @@ -52413,7 +55061,7 @@ paths: - expires_at - updated_at examples: - default: &365 + default: &364 value: total_count: 2 artifacts: @@ -52474,9 +55122,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: + - *324 - *325 - - *326 - - &333 + - &332 name: artifact_id description: The unique identifier of the artifact. in: path @@ -52488,7 +55136,7 @@ paths: description: Response content: application/json: - schema: *332 + schema: *331 examples: default: value: @@ -52526,9 +55174,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: + - *324 - *325 - - *326 - - *333 + - *332 responses: '204': description: Response @@ -52552,9 +55200,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: + - *324 - *325 - - *326 - - *333 + - *332 - name: archive_format in: path required: true @@ -52568,7 +55216,7 @@ paths: 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': &520 + '410': &519 description: Gone content: application/json: @@ -52593,14 +55241,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: &334 + schema: &333 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -52634,13 +55282,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: application/json: - schema: *334 + schema: *333 examples: selected_actions: *40 responses: @@ -52669,14 +55317,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: &335 + schema: &334 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -52710,13 +55358,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: application/json: - schema: *335 + schema: *334 examples: selected_actions: *42 responses: @@ -52747,14 +55395,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *336 + schema: *335 examples: default: value: @@ -52780,11 +55428,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: + - *324 - *325 - - *326 - *17 - *19 - - &337 + - &336 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 @@ -52818,7 +55466,7 @@ paths: description: Response content: application/json: - schema: &338 + schema: &337 title: Repository actions caches description: Repository actions caches type: object @@ -52868,7 +55516,7 @@ paths: - total_count - actions_caches examples: - default: &339 + default: &338 value: total_count: 1 actions_caches: @@ -52900,23 +55548,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: + - *324 - *325 - - *326 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *337 + - *336 responses: '200': description: Response content: application/json: - schema: *338 + schema: *337 examples: - default: *339 + default: *338 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52936,8 +55584,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: + - *324 - *325 - - *326 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -52968,9 +55616,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: + - *324 - *325 - - *326 - - &340 + - &339 name: job_id description: The unique identifier of the job. in: path @@ -52982,7 +55630,7 @@ paths: description: Response content: application/json: - schema: &368 + schema: &367 title: Job description: Information of a job execution in a workflow run type: object @@ -53329,9 +55977,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: + - *324 - *325 - - *326 - - *340 + - *339 responses: '302': description: Response @@ -53359,9 +56007,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: + - *324 - *325 - - *326 - - *340 + - *339 requestBody: required: false content: @@ -53383,7 +56031,7 @@ paths: description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -53407,8 +56055,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Status response @@ -53458,8 +56106,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -53493,7 +56141,7 @@ paths: description: Empty response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -53522,8 +56170,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -53541,7 +56189,7 @@ paths: type: integer secrets: type: array - items: &370 + items: &369 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -53562,7 +56210,7 @@ paths: - created_at - updated_at examples: - default: &371 + default: &370 value: total_count: 2 secrets: @@ -53595,9 +56243,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: + - *324 - *325 - - *326 - - *341 + - *340 - *19 responses: '200': @@ -53614,7 +56262,7 @@ paths: type: integer variables: type: array - items: &374 + items: &373 title: Actions Variable type: object properties: @@ -53648,7 +56296,7 @@ paths: - created_at - updated_at examples: - default: &375 + default: &374 value: total_count: 2 variables: @@ -53681,8 +56329,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -53691,12 +56339,12 @@ paths: schema: type: object properties: - enabled: &343 + enabled: &342 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *138 - selected_actions_url: *342 - sha_pinning_required: *139 + allowed_actions: *137 + selected_actions_url: *341 + sha_pinning_required: *138 required: - enabled examples: @@ -53724,8 +56372,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -53736,9 +56384,9 @@ paths: schema: type: object properties: - enabled: *343 - allowed_actions: *138 - sha_pinning_required: *139 + enabled: *342 + allowed_actions: *137 + sha_pinning_required: *138 required: - enabled examples: @@ -53768,14 +56416,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: &344 + schema: &343 type: object properties: access_level: @@ -53792,7 +56440,7 @@ paths: required: - access_level examples: - default: &345 + default: &344 value: access_level: organization x-github: @@ -53816,15 +56464,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: application/json: - schema: *344 + schema: *343 examples: - default: *345 + default: *344 responses: '204': description: Response @@ -53848,14 +56496,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *346 + schema: *345 examples: default: value: @@ -53879,8 +56527,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: + - *324 - *325 - - *326 responses: '204': description: Empty response for successful settings update @@ -53890,7 +56538,7 @@ paths: required: true content: application/json: - schema: *347 + schema: *346 examples: default: summary: Set retention days @@ -53914,16 +56562,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *140 + schema: *139 examples: - default: *348 + default: *347 '404': *6 x-github: enabledForGitHubApps: true @@ -53942,8 +56590,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -53953,7 +56601,7 @@ paths: required: true content: application/json: - schema: *140 + schema: *139 examples: default: summary: Set approval policy to first time contributors @@ -53977,16 +56625,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *349 + schema: *348 examples: - default: *141 + default: *140 '403': *27 '404': *6 x-github: @@ -54006,15 +56654,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: application/json: - schema: *350 + schema: *349 examples: - default: *141 + default: *140 responses: '204': description: Empty response for successful settings update @@ -54038,16 +56686,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *143 + schema: *142 examples: - default: *144 + default: *143 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -54066,8 +56714,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -54075,9 +56723,9 @@ paths: required: false content: application/json: - schema: *143 + schema: *142 examples: - selected_actions: *144 + selected_actions: *143 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -54099,16 +56747,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *351 + schema: *350 examples: - default: *148 + default: *147 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54129,8 +56777,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: + - *324 - *325 - - *326 responses: '204': description: Success response @@ -54141,9 +56789,9 @@ paths: required: true content: application/json: - schema: *352 + schema: *351 examples: - default: *148 + default: *147 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54170,8 +56818,8 @@ paths: in: query schema: type: string + - *324 - *325 - - *326 - *17 - *19 responses: @@ -54189,9 +56837,9 @@ paths: type: integer runners: type: array - items: *155 + items: *154 examples: - default: *156 + default: *155 headers: Link: *65 x-github: @@ -54215,8 +56863,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -54224,9 +56872,9 @@ paths: application/json: schema: type: array - items: *353 + items: *352 examples: - default: *354 + default: *353 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54248,8 +56896,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -54292,7 +56940,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *355 + '201': *354 '404': *6 '422': *7 '409': *52 @@ -54323,16 +56971,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: + - *324 - *325 - - *326 responses: '201': description: Response content: application/json: - schema: *157 + schema: *156 examples: - default: *356 + default: *355 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54360,16 +57008,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: + - *324 - *325 - - *326 responses: '201': description: Response content: application/json: - schema: *157 + schema: *156 examples: - default: *357 + default: *356 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54391,17 +57039,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: + - *324 - *325 - - *326 - - *154 + - *153 responses: '200': description: Response content: application/json: - schema: *155 + schema: *154 examples: - default: *358 + default: *357 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54422,9 +57070,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: + - *324 - *325 - - *326 - - *154 + - *153 responses: '204': description: Response @@ -54450,11 +57098,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: + - *324 - *325 - - *326 - - *154 + - *153 responses: - '200': *159 + '200': *158 '404': *6 x-github: githubCloudOnly: false @@ -54476,9 +57124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: + - *324 - *325 - - *326 - - *154 + - *153 requestBody: required: true content: @@ -54502,7 +57150,7 @@ paths: - gpu - accelerated responses: - '200': *159 + '200': *158 '404': *6 '422': *7 x-github: @@ -54526,9 +57174,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: + - *324 - *325 - - *326 - - *154 + - *153 requestBody: required: true content: @@ -54553,7 +57201,7 @@ paths: - gpu - accelerated responses: - '200': *159 + '200': *158 '404': *6 '422': *7 x-github: @@ -54577,11 +57225,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: + - *324 - *325 - - *326 - - *154 + - *153 responses: - '200': *359 + '200': *358 '404': *6 x-github: githubCloudOnly: false @@ -54608,12 +57256,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: + - *324 - *325 - - *326 - - *154 - - *360 + - *153 + - *359 responses: - '200': *159 + '200': *158 '404': *6 '422': *7 x-github: @@ -54639,9 +57287,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: + - *324 - *325 - - *326 - - &378 + - &377 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. @@ -54649,7 +57297,7 @@ paths: required: false schema: type: string - - &379 + - &378 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -54657,7 +57305,7 @@ paths: required: false schema: type: string - - &380 + - &379 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -54666,7 +57314,7 @@ paths: required: false schema: type: string - - &381 + - &380 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 @@ -54693,7 +57341,7 @@ paths: - pending - *17 - *19 - - &382 + - &381 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/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -54702,7 +57350,7 @@ paths: schema: type: string format: date-time - - &361 + - &360 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -54711,13 +57359,13 @@ paths: schema: type: boolean default: false - - &383 + - &382 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &384 + - &383 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -54740,7 +57388,7 @@ paths: type: integer workflow_runs: type: array - items: &362 + items: &361 title: Workflow Run description: An invocation of a workflow type: object @@ -54918,7 +57566,7 @@ paths: head_commit: anyOf: - type: 'null' - - &406 + - &405 title: Simple Commit description: A commit. type: object @@ -54992,8 +57640,8 @@ paths: - timestamp - author - committer - repository: *153 - head_repository: *153 + repository: *152 + head_repository: *152 head_repository_id: type: integer examples: @@ -55033,7 +57681,7 @@ paths: - workflow_url - pull_requests examples: - default: &385 + default: &384 value: total_count: 1 workflow_runs: @@ -55269,24 +57917,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: + - *324 - *325 - - *326 - - &363 + - &362 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *361 + - *360 responses: '200': description: Response content: application/json: - schema: *362 + schema: *361 examples: - default: &366 + default: &365 value: id: 30433642 name: Build @@ -55527,9 +58175,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: + - *324 - *325 - - *326 - - *363 + - *362 responses: '204': description: Response @@ -55552,9 +58200,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: + - *324 - *325 - - *326 - - *363 + - *362 responses: '200': description: Response @@ -55682,15 +58330,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: + - *324 - *325 - - *326 - - *363 + - *362 responses: '201': description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -55717,12 +58365,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: + - *324 - *325 - - *326 - - *363 + - *362 - *17 - *19 - - *364 + - *363 - *59 responses: '200': @@ -55739,9 +58387,9 @@ paths: type: integer artifacts: type: array - items: *332 + items: *331 examples: - default: *365 + default: *364 headers: Link: *65 x-github: @@ -55765,25 +58413,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: + - *324 - *325 - - *326 - - *363 - - &367 + - *362 + - &366 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *361 + - *360 responses: '200': description: Response content: application/json: - schema: *362 + schema: *361 examples: - default: *366 + default: *365 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55806,10 +58454,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: + - *324 - *325 - - *326 - - *363 - - *367 + - *362 + - *366 - *17 - *19 responses: @@ -55827,9 +58475,9 @@ paths: type: integer jobs: type: array - items: *368 + items: *367 examples: - default: &369 + default: &368 value: total_count: 1 jobs: @@ -55942,10 +58590,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: + - *324 - *325 - - *326 - - *363 - - *367 + - *362 + - *366 responses: '302': description: Response @@ -55973,15 +58621,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: + - *324 - *325 - - *326 - - *363 + - *362 responses: '202': description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -56008,9 +58656,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: + - *324 - *325 - - *326 - - *363 + - *362 requestBody: required: true content: @@ -56077,15 +58725,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: + - *324 - *325 - - *326 - - *363 + - *362 responses: '202': description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -56112,9 +58760,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: + - *324 - *325 - - *326 - - *363 + - *362 - 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 @@ -56144,9 +58792,9 @@ paths: type: integer jobs: type: array - items: *368 + items: *367 examples: - default: *369 + default: *368 headers: Link: *65 x-github: @@ -56171,9 +58819,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: + - *324 - *325 - - *326 - - *363 + - *362 responses: '302': description: Response @@ -56200,9 +58848,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: + - *324 - *325 - - *326 - - *363 + - *362 responses: '204': description: Response @@ -56229,9 +58877,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: + - *324 - *325 - - *326 - - *363 + - *362 responses: '200': description: Response @@ -56300,7 +58948,7 @@ paths: items: type: object properties: - type: &486 + type: &485 type: string description: The type of reviewer. enum: @@ -56311,7 +58959,7 @@ paths: reviewer: anyOf: - *4 - - *188 + - *187 required: - environment - wait_timer @@ -56386,9 +59034,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: + - *324 - *325 - - *326 - - *363 + - *362 requestBody: required: true content: @@ -56438,7 +59086,7 @@ paths: application/json: schema: type: array - items: &481 + items: &480 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -56550,7 +59198,7 @@ paths: - created_at - updated_at examples: - default: &482 + default: &481 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -56606,9 +59254,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: + - *324 - *325 - - *326 - - *363 + - *362 requestBody: required: false content: @@ -56630,7 +59278,7 @@ paths: description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -56653,9 +59301,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: + - *324 - *325 - - *326 - - *363 + - *362 requestBody: required: false content: @@ -56677,7 +59325,7 @@ paths: description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -56709,9 +59357,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: + - *324 - *325 - - *326 - - *363 + - *362 responses: '200': description: Response @@ -56848,8 +59496,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -56867,9 +59515,9 @@ paths: type: integer secrets: type: array - items: *370 + items: *369 examples: - default: *371 + default: *370 headers: Link: *65 x-github: @@ -56894,16 +59542,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *372 + schema: *371 examples: - default: *373 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56925,17 +59573,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: + - *324 - *325 - - *326 - - *161 + - *160 responses: '200': description: Response content: application/json: - schema: *370 + schema: *369 examples: - default: &499 + default: &498 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -56961,9 +59609,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: + - *324 - *325 - - *326 - - *161 + - *160 requestBody: required: true content: @@ -56994,7 +59642,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -57020,9 +59668,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: + - *324 - *325 - - *326 - - *161 + - *160 responses: '204': description: Response @@ -57047,9 +59695,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: + - *324 - *325 - - *326 - - *341 + - *340 - *19 responses: '200': @@ -57066,9 +59714,9 @@ paths: type: integer variables: type: array - items: *374 + items: *373 examples: - default: *375 + default: *374 headers: Link: *65 x-github: @@ -57091,8 +59739,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -57119,7 +59767,7 @@ paths: description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -57144,17 +59792,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: + - *324 - *325 - - *326 - - *164 + - *163 responses: '200': description: Response content: application/json: - schema: *374 + schema: *373 examples: - default: &500 + default: &499 value: name: USERNAME value: octocat @@ -57180,9 +59828,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: + - *324 - *325 - - *326 - - *164 + - *163 requestBody: required: true content: @@ -57224,9 +59872,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: + - *324 - *325 - - *326 - - *164 + - *163 responses: '204': description: Response @@ -57251,8 +59899,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -57270,7 +59918,7 @@ paths: type: integer workflows: type: array - items: &376 + items: &375 title: Workflow description: A GitHub Actions workflow type: object @@ -57388,9 +60036,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: + - *324 - *325 - - *326 - - &377 + - &376 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -57405,7 +60053,7 @@ paths: description: Response content: application/json: - schema: *376 + schema: *375 examples: default: value: @@ -57438,9 +60086,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: + - *324 - *325 - - *326 - - *377 + - *376 responses: '204': description: Response @@ -57465,9 +60113,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: + - *324 - *325 - - *326 - - *377 + - *376 responses: '200': description: Response including the workflow run ID and URLs when `return_run_details` @@ -57548,9 +60196,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: + - *324 - *325 - - *326 - - *377 + - *376 responses: '204': description: Response @@ -57577,19 +60225,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: + - *324 - *325 - - *326 + - *376 - *377 - *378 - *379 - *380 - - *381 - *17 - *19 + - *381 + - *360 - *382 - - *361 - *383 - - *384 responses: '200': description: Response @@ -57605,9 +60253,9 @@ paths: type: integer workflow_runs: type: array - items: *362 + items: *361 examples: - default: *385 + default: *384 headers: Link: *65 x-github: @@ -57639,9 +60287,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: + - *324 - *325 - - *326 - - *377 + - *376 responses: '200': description: Response @@ -57702,8 +60350,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: + - *324 - *325 - - *326 - *59 - *17 - *45 @@ -57871,8 +60519,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -57909,8 +60557,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: + - *324 - *325 - - *326 - name: assignee in: path required: true @@ -57946,8 +60594,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -58057,8 +60705,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: + - *324 - *325 - - *326 - *17 - *45 - *46 @@ -58099,7 +60747,7 @@ paths: initiator: type: string examples: - default: *386 + default: *385 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58119,8 +60767,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -58128,7 +60776,7 @@ paths: application/json: schema: type: array - items: &387 + items: &386 title: Autolink reference description: An autolink reference. type: object @@ -58187,8 +60835,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -58227,9 +60875,9 @@ paths: description: response content: application/json: - schema: *387 + schema: *386 examples: - default: &388 + default: &387 value: id: 1 key_prefix: TICKET- @@ -58260,9 +60908,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: + - *324 - *325 - - *326 - - &389 + - &388 name: autolink_id description: The unique identifier of the autolink. in: path @@ -58274,9 +60922,9 @@ paths: description: Response content: application/json: - schema: *387 + schema: *386 examples: - default: *388 + default: *387 '404': *6 x-github: githubCloudOnly: false @@ -58296,9 +60944,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: + - *324 - *325 - - *326 - - *389 + - *388 responses: '204': description: Response @@ -58322,8 +60970,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response if Dependabot is enabled @@ -58373,8 +61021,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -58395,8 +61043,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -58416,8 +61064,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: + - *324 - *325 - - *326 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -58455,7 +61103,7 @@ paths: - url protected: type: boolean - protection: &391 + protection: &390 title: Branch Protection description: Branch Protection type: object @@ -58498,7 +61146,7 @@ paths: required: - contexts - checks - enforce_admins: &394 + enforce_admins: &393 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -58515,7 +61163,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &396 + required_pull_request_reviews: &395 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -58537,7 +61185,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *188 + items: *187 apps: description: The list of apps with review dismissal access. @@ -58569,7 +61217,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *188 + items: *187 apps: description: The list of apps allowed to bypass pull request requirements. @@ -58599,7 +61247,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &393 + restrictions: &392 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -58662,7 +61310,7 @@ paths: type: string teams: type: array - items: *188 + items: *187 apps: type: array items: @@ -58892,9 +61540,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: + - *324 - *325 - - *326 - - &392 + - &391 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/graphql). @@ -58908,14 +61556,14 @@ paths: description: Response content: application/json: - schema: &402 + schema: &401 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &456 + commit: &455 title: Commit description: Commit type: object @@ -58954,7 +61602,7 @@ paths: author: anyOf: - type: 'null' - - &390 + - &389 title: Git User description: Metaproperties for Git author/committer information. @@ -58976,7 +61624,7 @@ paths: committer: anyOf: - type: 'null' - - *390 + - *389 message: type: string examples: @@ -59000,7 +61648,7 @@ paths: required: - sha - url - verification: &506 + verification: &505 title: Verification type: object properties: @@ -59036,14 +61684,14 @@ paths: author: oneOf: - *4 - - *162 + - *161 type: - 'null' - object committer: oneOf: - *4 - - *162 + - *161 type: - 'null' - object @@ -59080,7 +61728,7 @@ paths: type: integer files: type: array - items: &467 + items: &466 title: Diff Entry description: Diff Entry type: object @@ -59176,7 +61824,7 @@ paths: - self protected: type: boolean - protection: *391 + protection: *390 protection_url: type: string format: uri @@ -59285,7 +61933,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *329 + '301': *328 '404': *6 x-github: githubCloudOnly: false @@ -59307,15 +61955,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response content: application/json: - schema: *391 + schema: *390 examples: default: value: @@ -59509,9 +62157,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: true content: @@ -59771,7 +62419,7 @@ paths: url: type: string format: uri - required_status_checks: &399 + required_status_checks: &398 title: Status Check Policy description: Status Check Policy type: object @@ -59852,7 +62500,7 @@ paths: items: *4 teams: type: array - items: *188 + items: *187 apps: type: array items: *5 @@ -59870,7 +62518,7 @@ paths: items: *4 teams: type: array - items: *188 + items: *187 apps: type: array items: *5 @@ -59930,7 +62578,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *393 + restrictions: *392 required_conversation_resolution: type: object properties: @@ -60042,9 +62690,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '204': description: Response @@ -60069,17 +62717,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response content: application/json: - schema: *394 + schema: *393 examples: - default: &395 + default: &394 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -60101,17 +62749,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response content: application/json: - schema: *394 + schema: *393 examples: - default: *395 + default: *394 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60130,9 +62778,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '204': description: Response @@ -60157,17 +62805,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response content: application/json: - schema: *396 + schema: *395 examples: - default: &397 + default: &396 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -60263,9 +62911,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: false content: @@ -60363,9 +63011,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *395 examples: - default: *397 + default: *396 '422': *15 x-github: githubCloudOnly: false @@ -60386,9 +63034,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '204': description: Response @@ -60415,17 +63063,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response content: application/json: - schema: *394 + schema: *393 examples: - default: &398 + default: &397 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -60448,17 +63096,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response content: application/json: - schema: *394 + schema: *393 examples: - default: *398 + default: *397 '404': *6 x-github: githubCloudOnly: false @@ -60478,9 +63126,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '204': description: Response @@ -60505,17 +63153,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response content: application/json: - schema: *399 + schema: *398 examples: - default: &400 + default: &399 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -60541,9 +63189,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: false content: @@ -60595,9 +63243,9 @@ paths: description: Response content: application/json: - schema: *399 + schema: *398 examples: - default: *400 + default: *399 '404': *6 '422': *15 x-github: @@ -60619,9 +63267,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '204': description: Response @@ -60645,9 +63293,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response @@ -60681,9 +63329,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: false content: @@ -60750,9 +63398,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: false content: @@ -60816,9 +63464,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: content: application/json: @@ -60884,15 +63532,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response content: application/json: - schema: *393 + schema: *392 examples: default: value: @@ -60983,9 +63631,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '204': description: Response @@ -61008,9 +63656,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response @@ -61020,7 +63668,7 @@ paths: type: array items: *5 examples: - default: &401 + default: &400 value: - id: 1 slug: octoapp @@ -61077,9 +63725,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: true content: @@ -61113,7 +63761,7 @@ paths: type: array items: *5 examples: - default: *401 + default: *400 '422': *15 x-github: githubCloudOnly: false @@ -61134,9 +63782,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: true content: @@ -61170,7 +63818,7 @@ paths: type: array items: *5 examples: - default: *401 + default: *400 '422': *15 x-github: githubCloudOnly: false @@ -61191,9 +63839,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: true content: @@ -61227,7 +63875,7 @@ paths: type: array items: *5 examples: - default: *401 + default: *400 '422': *15 x-github: githubCloudOnly: false @@ -61249,9 +63897,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response @@ -61259,9 +63907,9 @@ paths: application/json: schema: type: array - items: *188 + items: *187 examples: - default: *246 + default: *245 '404': *6 x-github: githubCloudOnly: false @@ -61281,9 +63929,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: false content: @@ -61319,9 +63967,9 @@ paths: application/json: schema: type: array - items: *188 + items: *187 examples: - default: *246 + default: *245 '422': *15 x-github: githubCloudOnly: false @@ -61342,9 +63990,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: false content: @@ -61380,9 +64028,9 @@ paths: application/json: schema: type: array - items: *188 + items: *187 examples: - default: *246 + default: *245 '422': *15 x-github: githubCloudOnly: false @@ -61403,9 +64051,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: content: application/json: @@ -61440,9 +64088,9 @@ paths: application/json: schema: type: array - items: *188 + items: *187 examples: - default: *246 + default: *245 '422': *15 x-github: githubCloudOnly: false @@ -61464,9 +64112,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: + - *324 - *325 - - *326 - - *392 + - *391 responses: '200': description: Response @@ -61500,9 +64148,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: true content: @@ -61560,9 +64208,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: true content: @@ -61620,9 +64268,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: true content: @@ -61682,9 +64330,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: + - *324 - *325 - - *326 - - *392 + - *391 requestBody: required: true content: @@ -61706,7 +64354,7 @@ paths: description: Response content: application/json: - schema: *402 + schema: *401 examples: default: value: @@ -61822,8 +64470,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -62102,7 +64750,7 @@ paths: description: Response content: application/json: - schema: &403 + schema: &402 title: CheckRun description: A check performed on the code of a given code change type: object @@ -62238,7 +64886,7 @@ paths: check. type: array items: *84 - deployment: &711 + deployment: &710 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -62525,9 +65173,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: + - *324 - *325 - - *326 - - &404 + - &403 name: check_run_id description: The unique identifier of the check run. in: path @@ -62539,9 +65187,9 @@ paths: description: Response content: application/json: - schema: *403 + schema: *402 examples: - default: &405 + default: &404 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -62641,9 +65289,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: + - *324 - *325 - - *326 - - *404 + - *403 requestBody: required: true content: @@ -62883,9 +65531,9 @@ paths: description: Response content: application/json: - schema: *403 + schema: *402 examples: - default: *405 + default: *404 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62905,9 +65553,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: + - *324 - *325 - - *326 - - *404 + - *403 - *17 - *19 responses: @@ -63017,15 +65665,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: + - *324 - *325 - - *326 - - *404 + - *403 responses: '201': description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -63063,8 +65711,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -63086,7 +65734,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &407 + schema: &406 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -63173,7 +65821,7 @@ paths: anyOf: - type: 'null' - *5 - repository: *153 + repository: *152 created_at: type: - string @@ -63184,7 +65832,7 @@ paths: - string - 'null' format: date-time - head_commit: *406 + head_commit: *405 latest_check_runs_count: type: integer check_runs_url: @@ -63212,7 +65860,7 @@ paths: - check_runs_url - pull_requests examples: - default: &408 + default: &407 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -63503,9 +66151,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *407 + schema: *406 examples: - default: *408 + default: *407 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63524,8 +66172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -63586,7 +66234,7 @@ paths: required: - app_id - setting - repository: *153 + repository: *152 examples: default: value: @@ -63834,9 +66482,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: + - *324 - *325 - - *326 - - &409 + - &408 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -63848,9 +66496,9 @@ paths: description: Response content: application/json: - schema: *407 + schema: *406 examples: - default: *408 + default: *407 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63873,17 +66521,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: + - *324 - *325 - - *326 - - *409 - - &462 + - *408 + - &461 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &463 + - &462 name: status description: Returns check runs with the specified `status`. in: query @@ -63922,9 +66570,9 @@ paths: type: integer check_runs: type: array - items: *403 + items: *402 examples: - default: &464 + default: &463 value: total_count: 1 check_runs: @@ -64026,15 +66674,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: + - *324 - *325 - - *326 - - *409 + - *408 responses: '201': description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -64061,21 +66709,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: + - *324 - *325 - - *326 + - *409 - *410 - - *411 - *19 - *17 - - &428 + - &427 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: *412 - - &429 + schema: *411 + - &428 name: pr description: The number of the pull request for the results you want to list. in: query @@ -64100,13 +66748,13 @@ paths: be returned. in: query required: false - schema: *413 + schema: *412 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *414 + schema: *413 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -64125,24 +66773,24 @@ paths: items: type: object properties: - number: *171 - created_at: *172 - updated_at: *173 - url: *174 - html_url: *175 - instances_url: *415 - state: *180 - fixed_at: *176 + number: *170 + created_at: *171 + updated_at: *172 + url: *173 + html_url: *174 + instances_url: *414 + state: *179 + fixed_at: *175 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *177 - dismissed_reason: *416 - dismissed_comment: *417 - rule: *418 - tool: *419 - most_recent_instance: *420 + dismissed_at: *176 + dismissed_reason: *415 + dismissed_comment: *416 + rule: *417 + tool: *418 + most_recent_instance: *419 dismissal_approved_by: anyOf: - type: 'null' @@ -64265,7 +66913,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &421 + '403': &420 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -64292,9 +66940,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: + - *324 - *325 - - *326 - - &422 + - &421 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -64302,30 +66950,30 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *171 + schema: *170 responses: '200': description: Response content: application/json: - schema: &423 + schema: &422 type: object properties: - number: *171 - created_at: *172 - updated_at: *173 - url: *174 - html_url: *175 - instances_url: *415 - state: *180 - fixed_at: *176 + number: *170 + created_at: *171 + updated_at: *172 + url: *173 + html_url: *174 + instances_url: *414 + state: *179 + fixed_at: *175 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *177 - dismissed_reason: *416 - dismissed_comment: *417 + dismissed_at: *176 + dismissed_reason: *415 + dismissed_comment: *416 rule: type: object properties: @@ -64387,8 +67035,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *419 - most_recent_instance: *420 + tool: *418 + most_recent_instance: *419 dismissal_approved_by: anyOf: - type: 'null' @@ -64484,7 +67132,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *421 + '403': *420 '404': *6 '503': *113 x-github: @@ -64504,9 +67152,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: + - *324 - *325 - - *326 - - *422 + - *421 requestBody: required: true content: @@ -64521,8 +67169,8 @@ paths: enum: - open - dismissed - dismissed_reason: *416 - dismissed_comment: *417 + dismissed_reason: *415 + dismissed_comment: *416 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -64550,7 +67198,7 @@ paths: description: Response content: application/json: - schema: *423 + schema: *422 examples: default: value: @@ -64626,7 +67274,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &427 + '403': &426 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -64653,15 +67301,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: + - *324 - *325 - - *326 - - *422 + - *421 responses: '200': description: Response content: application/json: - schema: &424 + schema: &423 type: object properties: status: @@ -64688,13 +67336,13 @@ paths: - description - started_at examples: - default: &425 + default: &424 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &426 + '400': &425 description: Bad Request content: application/json: @@ -64705,7 +67353,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': *421 + '403': *420 '404': *6 '503': *113 x-github: @@ -64730,29 +67378,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: + - *324 - *325 - - *326 - - *422 + - *421 responses: '200': description: OK content: application/json: - schema: *424 + schema: *423 examples: - default: *425 + default: *424 '202': description: Accepted content: application/json: - schema: *424 + schema: *423 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *426 + '400': *425 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -64784,9 +67432,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: + - *324 - *325 - - *326 - - *422 + - *421 requestBody: required: false content: @@ -64832,8 +67480,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *426 - '403': *427 + '400': *425 + '403': *426 '404': *6 '422': description: Unprocessable Entity @@ -64857,13 +67505,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: + - *324 - *325 - - *326 - - *422 + - *421 - *19 - *17 + - *427 - *428 - - *429 responses: '200': description: Response @@ -64874,10 +67522,10 @@ paths: items: type: object properties: - ref: *412 - analysis_key: *430 - environment: *431 - category: *432 + ref: *411 + analysis_key: *429 + environment: *430 + category: *431 state: type: - string @@ -64894,7 +67542,7 @@ paths: properties: text: type: string - location: *433 + location: *432 html_url: type: string classifications: @@ -64902,7 +67550,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: *434 + items: *433 examples: default: value: @@ -64939,7 +67587,7 @@ paths: end_column: 50 classifications: - source - '403': *421 + '403': *420 '404': *6 '503': *113 x-github: @@ -64973,25 +67621,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: + - *324 - *325 - - *326 + - *409 - *410 - - *411 - *19 - *17 - - *429 + - *428 - 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: *412 + schema: *411 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &435 + schema: &434 type: string description: An identifier for the upload. examples: @@ -65013,23 +67661,23 @@ paths: application/json: schema: type: array - items: &436 + items: &435 type: object properties: - ref: *412 - commit_sha: &444 + ref: *411 + commit_sha: &443 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: *430 + analysis_key: *429 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *432 + category: *431 error: type: string examples: @@ -65054,8 +67702,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *435 - tool: *419 + sarif_id: *434 + tool: *418 deletable: type: boolean warning: @@ -65117,7 +67765,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *421 + '403': *420 '404': *6 '503': *113 x-github: @@ -65153,8 +67801,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: + - *324 - *325 - - *326 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -65167,7 +67815,7 @@ paths: description: Response content: application/json: - schema: *436 + schema: *435 examples: response: summary: application/json response @@ -65221,7 +67869,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *421 + '403': *420 '404': *6 '422': description: Response if analysis could not be processed @@ -65308,8 +67956,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: + - *324 - *325 - - *326 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -65365,7 +68013,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': *427 + '403': *426 '404': *6 '503': *113 x-github: @@ -65387,8 +68035,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -65396,7 +68044,7 @@ paths: application/json: schema: type: array - items: &437 + items: &436 title: CodeQL Database description: A CodeQL database. type: object @@ -65508,7 +68156,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': *421 + '403': *420 '404': *6 '503': *113 x-github: @@ -65537,8 +68185,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: + - *324 - *325 - - *326 - name: language in: path description: The language of the CodeQL database. @@ -65550,7 +68198,7 @@ paths: description: Response content: application/json: - schema: *437 + schema: *436 examples: default: value: @@ -65582,9 +68230,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': &469 + '302': &468 description: Found - '403': *421 + '403': *420 '404': *6 '503': *113 x-github: @@ -65606,8 +68254,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: + - *324 - *325 - - *326 - name: language in: path description: The language of the CodeQL database. @@ -65617,7 +68265,7 @@ paths: responses: '204': description: Response - '403': *427 + '403': *426 '404': *6 '503': *113 x-github: @@ -65645,8 +68293,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -65655,7 +68303,7 @@ paths: type: object additionalProperties: false properties: - language: &438 + language: &437 type: string description: The language targeted by the CodeQL query enum: @@ -65735,7 +68383,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &442 + schema: &441 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -65745,7 +68393,7 @@ paths: description: The ID of the variant analysis. controller_repo: *64 actor: *4 - query_language: *438 + query_language: *437 query_pack_url: type: string description: The download url for the query pack. @@ -65793,7 +68441,7 @@ paths: items: type: object properties: - repository: &439 + repository: &438 title: Repository Identifier description: Repository Identifier type: object @@ -65835,7 +68483,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &443 + analysis_status: &442 type: string description: The new status of the CodeQL variant analysis repository task. @@ -65867,7 +68515,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &440 + access_mismatch_repos: &439 type: object properties: repository_count: @@ -65882,7 +68530,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: *439 + items: *438 required: - repository_count - repositories @@ -65905,8 +68553,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *440 - over_limit_repos: *440 + no_codeql_db_repos: *439 + over_limit_repos: *439 required: - access_mismatch_repos - not_found_repos @@ -65922,7 +68570,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &441 + value: &440 summary: Default response value: id: 1 @@ -66068,10 +68716,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *441 + value: *440 repository_lists: summary: Response for a successful variant analysis submission - value: *441 + value: *440 '404': *6 '422': description: Unable to process variant analysis submission @@ -66099,8 +68747,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: + - *324 - *325 - - *326 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -66112,9 +68760,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *441 examples: - default: *441 + default: *440 '404': *6 '503': *113 x-github: @@ -66137,7 +68785,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *325 + - *324 - name: repo in: path description: The name of the controller repository. @@ -66172,7 +68820,7 @@ paths: type: object properties: repository: *64 - analysis_status: *443 + analysis_status: *442 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -66297,8 +68945,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -66389,7 +69037,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *421 + '403': *420 '404': *6 '503': *113 x-github: @@ -66410,8 +69058,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -66480,7 +69128,7 @@ paths: description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -66505,7 +69153,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *427 + '403': *426 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -66576,8 +69224,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -66585,7 +69233,7 @@ paths: schema: type: object properties: - commit_sha: *444 + commit_sha: *443 ref: type: string description: |- @@ -66645,7 +69293,7 @@ paths: schema: type: object properties: - id: *435 + id: *434 url: type: string description: The REST API URL for checking the status of the upload. @@ -66659,7 +69307,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': *427 + '403': *426 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -66682,8 +69330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: + - *324 - *325 - - *326 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -66731,7 +69379,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': *421 + '403': *420 '404': description: Not Found if the sarif id does not match any upload '503': *113 @@ -66756,8 +69404,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -66813,7 +69461,7 @@ paths: html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 created_at: '2024-05-01T00:00:00Z' updated_at: '2024-05-01T00:00:00Z' - '204': *184 + '204': *183 '304': *35 '403': *27 '404': *6 @@ -66838,8 +69486,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: + - *324 - *325 - - *326 - 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 @@ -66967,8 +69615,8 @@ paths: parameters: - *17 - *19 + - *324 - *325 - - *326 responses: '200': description: Response @@ -66984,7 +69632,7 @@ paths: type: integer codespaces: type: array - items: *235 + items: *234 examples: default: value: @@ -67282,8 +69930,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -67347,17 +69995,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '400': *14 '401': *23 '403': *27 @@ -67386,8 +70034,8 @@ paths: parameters: - *17 - *19 + - *324 - *325 - - *326 responses: '200': description: Response @@ -67451,8 +70099,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: + - *324 - *325 - - *326 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -67489,9 +70137,9 @@ paths: type: integer machines: type: array - items: *446 + items: *445 examples: - default: &654 + default: &653 value: total_count: 2 machines: @@ -67531,8 +70179,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: + - *324 - *325 - - *326 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -67619,8 +70267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: + - *324 - *325 - - *326 - 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 @@ -67689,8 +70337,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -67708,7 +70356,7 @@ paths: type: integer secrets: type: array - items: &450 + items: &449 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -67729,7 +70377,7 @@ paths: - created_at - updated_at examples: - default: *447 + default: *446 headers: Link: *65 x-github: @@ -67752,16 +70400,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *448 + schema: *447 examples: - default: *449 + default: *448 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -67781,17 +70429,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: + - *324 - *325 - - *326 - - *161 + - *160 responses: '200': description: Response content: application/json: - schema: *450 + schema: *449 examples: - default: *451 + default: *450 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67811,9 +70459,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: + - *324 - *325 - - *326 - - *161 + - *160 requestBody: required: true content: @@ -67841,7 +70489,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -67865,9 +70513,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: + - *324 - *325 - - *326 - - *161 + - *160 responses: '204': description: Response @@ -67895,8 +70543,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: + - *324 - *325 - - *326 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -67934,7 +70582,7 @@ paths: application/json: schema: type: array - items: &452 + items: &451 title: Collaborator description: Collaborator type: object @@ -68127,8 +70775,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: + - *324 - *325 - - *326 - *69 responses: '204': @@ -68175,8 +70823,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: + - *324 - *325 - - *326 - *69 requestBody: required: false @@ -68203,7 +70851,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &519 + schema: &518 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -68215,7 +70863,7 @@ paths: format: int64 examples: - 42 - repository: *153 + repository: *152 invitee: anyOf: - type: 'null' @@ -68431,8 +71079,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: + - *324 - *325 - - *326 - *69 responses: '204': @@ -68464,8 +71112,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: + - *324 - *325 - - *326 - *69 responses: '200': @@ -68486,7 +71134,7 @@ paths: user: anyOf: - type: 'null' - - *452 + - *451 required: - permission - role_name @@ -68540,8 +71188,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -68551,7 +71199,7 @@ paths: application/json: schema: type: array - items: &453 + items: &452 title: Commit Comment description: Commit Comment type: object @@ -68609,7 +71257,7 @@ paths: - created_at - updated_at examples: - default: &458 + default: &457 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -68668,17 +71316,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: + - *324 - *325 - - *326 - *95 responses: '200': description: Response content: application/json: - schema: *453 + schema: *452 examples: - default: &459 + default: &458 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -68735,8 +71383,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: + - *324 - *325 - - *326 - *95 requestBody: required: true @@ -68759,7 +71407,7 @@ paths: description: Response content: application/json: - schema: *453 + schema: *452 examples: default: value: @@ -68810,8 +71458,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: + - *324 - *325 - - *326 - *95 responses: '204': @@ -68833,8 +71481,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: + - *324 - *325 - - *326 - *95 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -68861,7 +71509,7 @@ paths: application/json: schema: type: array - items: &454 + items: &453 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -68905,7 +71553,7 @@ paths: - content - created_at examples: - default: &522 + default: &521 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -68950,8 +71598,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: + - *324 - *325 - - *326 - *95 requestBody: required: true @@ -68984,9 +71632,9 @@ paths: description: Reaction exists content: application/json: - schema: *454 + schema: *453 examples: - default: &455 + default: &454 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -69015,9 +71663,9 @@ paths: description: Reaction created content: application/json: - schema: *454 + schema: *453 examples: - default: *455 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -69039,10 +71687,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: + - *324 - *325 - - *326 - *95 - - &523 + - &522 name: reaction_id description: The unique identifier of the reaction. in: path @@ -69097,8 +71745,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: + - *324 - *325 - - *326 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -69154,9 +71802,9 @@ paths: application/json: schema: type: array - items: *456 + items: *455 examples: - default: &569 + default: &568 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -69250,9 +71898,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: + - *324 - *325 - - *326 - - &457 + - &456 name: commit_sha description: The SHA of the commit. in: path @@ -69324,9 +71972,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: + - *324 - *325 - - *326 - - *457 + - *456 - *17 - *19 responses: @@ -69336,9 +71984,9 @@ paths: application/json: schema: type: array - items: *453 + items: *452 examples: - default: *458 + default: *457 headers: Link: *65 x-github: @@ -69366,9 +72014,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: + - *324 - *325 - - *326 - - *457 + - *456 requestBody: required: true content: @@ -69403,9 +72051,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *452 examples: - default: *459 + default: *458 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -69433,9 +72081,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: + - *324 - *325 - - *326 - - *457 + - *456 - *17 - *19 responses: @@ -69445,9 +72093,9 @@ paths: application/json: schema: type: array - items: *460 + items: *459 examples: - default: &561 + default: &560 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -69984,11 +72632,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: + - *324 - *325 - - *326 - *19 - *17 - - &461 + - &460 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)" @@ -70003,9 +72651,9 @@ paths: description: Response content: application/json: - schema: *456 + schema: *455 examples: - default: &549 + default: &548 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -70118,11 +72766,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: + - *324 - *325 - - *326 + - *460 - *461 - *462 - - *463 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -70156,9 +72804,9 @@ paths: type: integer check_runs: type: array - items: *403 + items: *402 examples: - default: *464 + default: *463 headers: Link: *65 x-github: @@ -70183,9 +72831,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: + - *324 - *325 - - *326 - - *461 + - *460 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -70193,7 +72841,7 @@ paths: schema: type: integer example: 1 - - *462 + - *461 - *17 - *19 responses: @@ -70211,7 +72859,7 @@ paths: type: integer check_suites: type: array - items: *407 + items: *406 examples: default: value: @@ -70411,9 +73059,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: + - *324 - *325 - - *326 - - *461 + - *460 - *17 - *19 responses: @@ -70484,7 +73132,7 @@ paths: type: string total_count: type: integer - repository: *153 + repository: *152 commit_url: type: string format: uri @@ -70615,9 +73263,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: + - *324 - *325 - - *326 - - *461 + - *460 - *17 - *19 responses: @@ -70627,7 +73275,7 @@ paths: application/json: schema: type: array - items: &634 + items: &633 title: Status description: The status of a commit. type: object @@ -70708,7 +73356,7 @@ paths: site_admin: false headers: Link: *65 - '301': *329 + '301': *328 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70736,8 +73384,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -70770,11 +73418,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *465 + - *464 code_of_conduct_file: anyOf: - type: 'null' - - &466 + - &465 title: Community Health File type: object properties: @@ -70794,19 +73442,19 @@ paths: contributing: anyOf: - type: 'null' - - *466 + - *465 readme: anyOf: - type: 'null' - - *466 + - *465 issue_template: anyOf: - type: 'null' - - *466 + - *465 pull_request_template: anyOf: - type: 'null' - - *466 + - *465 required: - code_of_conduct - code_of_conduct_file @@ -70935,8 +73583,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: + - *324 - *325 - - *326 - *19 - *17 - name: basehead @@ -70984,8 +73632,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *456 - merge_base_commit: *456 + base_commit: *455 + merge_base_commit: *455 status: type: string enum: @@ -71009,10 +73657,10 @@ paths: - 6 commits: type: array - items: *456 + items: *455 files: type: array - items: *467 + items: *466 required: - url - html_url @@ -71298,8 +73946,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: + - *324 - *325 - - *326 - name: path description: path parameter in: path @@ -71469,7 +74117,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &468 + response-if-content-is-a-file-github-object: &467 summary: Response if content is a file value: type: file @@ -71606,7 +74254,7 @@ paths: - size - type - url - - &574 + - &573 title: Content File description: Content File type: object @@ -71824,7 +74472,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *468 + response-if-content-is-a-file: *467 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -71893,7 +74541,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *469 + '302': *468 '304': *35 x-github: githubCloudOnly: false @@ -71916,8 +74564,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: + - *324 - *325 - - *326 - name: path description: path parameter in: path @@ -72012,7 +74660,7 @@ paths: description: Response content: application/json: - schema: &470 + schema: &469 title: File Commit description: File Commit type: object @@ -72168,7 +74816,7 @@ paths: description: Response content: application/json: - schema: *470 + schema: *469 examples: example-for-creating-a-file: value: @@ -72222,7 +74870,7 @@ paths: schema: oneOf: - *3 - - &501 + - &500 description: Repository rule violation was detected type: object properties: @@ -72243,7 +74891,7 @@ paths: items: type: object properties: - placeholder_id: &626 + placeholder_id: &625 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -72275,8 +74923,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: + - *324 - *325 - - *326 - name: path description: path parameter in: path @@ -72337,7 +74985,7 @@ paths: description: Response content: application/json: - schema: *470 + schema: *469 examples: default: value: @@ -72392,8 +75040,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: + - *324 - *325 - - *326 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -72517,23 +75165,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: + - *324 - *325 - - *326 + - *189 - *190 - *191 - *192 - - *193 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string + - *193 + - *470 - *194 - - *471 - *195 - *196 - - *197 - *59 - *45 - *46 @@ -72545,11 +75193,11 @@ paths: application/json: schema: type: array - items: &475 + items: &474 type: object description: A Dependabot alert. properties: - number: *171 + number: *170 state: type: string description: The state of the Dependabot alert. @@ -72594,14 +75242,15 @@ paths: - unknown - direct - transitive + - inconclusive - - security_advisory: *472 + security_advisory: *471 security_vulnerability: *63 - url: *174 - html_url: *175 - created_at: *172 - updated_at: *173 - dismissed_at: *177 + url: *173 + html_url: *174 + created_at: *171 + updated_at: *172 + dismissed_at: *176 dismissed_by: anyOf: - type: 'null' @@ -72625,9 +75274,9 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: *176 - auto_dismissed_at: *473 - dismissal_request: *474 + fixed_at: *175 + auto_dismissed_at: *472 + dismissal_request: *473 assignees: type: array description: The users assigned to this alert. @@ -72699,7 +75348,7 @@ paths: vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N score: 8.7 epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 cwes: - cwe_id: CWE-200 @@ -72882,9 +75531,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: + - *324 - *325 - - *326 - - &476 + - &475 name: alert_number in: path description: |- @@ -72893,13 +75542,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *171 + schema: *170 responses: '200': description: Response content: application/json: - schema: *475 + schema: *474 examples: default: value: @@ -72956,7 +75605,7 @@ paths: vector_string: CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N score: 8.5 epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 cwes: - cwe_id: CWE-532 @@ -73031,9 +75680,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: + - *324 - *325 - - *326 - - *476 + - *475 requestBody: required: true content: @@ -73089,7 +75738,7 @@ paths: description: Response content: application/json: - schema: *475 + schema: *474 examples: default: value: @@ -73219,8 +75868,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -73238,7 +75887,7 @@ paths: type: integer secrets: type: array - items: &479 + items: &478 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -73292,16 +75941,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *477 + schema: *476 examples: - default: *478 + default: *477 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73321,15 +75970,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: + - *324 - *325 - - *326 - - *161 + - *160 responses: '200': description: Response content: application/json: - schema: *479 + schema: *478 examples: default: value: @@ -73355,9 +76004,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: + - *324 - *325 - - *326 - - *161 + - *160 requestBody: required: true content: @@ -73385,7 +76034,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -73409,9 +76058,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: + - *324 - *325 - - *326 - - *161 + - *160 responses: '204': description: Response @@ -73433,8 +76082,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: + - *324 - *325 - - *326 - 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 @@ -73608,8 +76257,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -73869,8 +76518,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -73953,7 +76602,7 @@ paths: - version - url additionalProperties: false - metadata: &480 + metadata: &479 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -73992,7 +76641,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *480 + metadata: *479 resolved: type: object description: A collection of resolved package dependencies. @@ -74006,7 +76655,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *480 + metadata: *479 relationship: type: string description: A notation of whether a dependency is requested @@ -74139,8 +76788,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: + - *324 - *325 - - *326 - name: sha description: The SHA recorded at creation time. in: query @@ -74181,9 +76830,9 @@ paths: application/json: schema: type: array - items: *481 + items: *480 examples: - default: *482 + default: *481 headers: Link: *65 x-github: @@ -74249,8 +76898,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -74332,7 +76981,7 @@ paths: description: Response content: application/json: - schema: *481 + schema: *480 examples: simple-example: summary: Simple example @@ -74405,9 +77054,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: + - *324 - *325 - - *326 - - &483 + - &482 name: deployment_id description: deployment_id parameter in: path @@ -74419,7 +77068,7 @@ paths: description: Response content: application/json: - schema: *481 + schema: *480 examples: default: value: @@ -74484,9 +77133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: + - *324 - *325 - - *326 - - *483 + - *482 responses: '204': description: Response @@ -74508,9 +77157,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: + - *324 - *325 - - *326 - - *483 + - *482 - *17 - *19 responses: @@ -74520,7 +77169,7 @@ paths: application/json: schema: type: array - items: &484 + items: &483 title: Deployment Status description: The status of a deployment. type: object @@ -74684,9 +77333,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: + - *324 - *325 - - *326 - - *483 + - *482 requestBody: required: true content: @@ -74761,9 +77410,9 @@ paths: description: Response content: application/json: - schema: *484 + schema: *483 examples: - default: &485 + default: &484 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -74819,9 +77468,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: + - *324 - *325 - - *326 - - *483 + - *482 - name: status_id in: path required: true @@ -74832,9 +77481,9 @@ paths: description: Response content: application/json: - schema: *484 + schema: *483 examples: - default: *485 + default: *484 '404': *6 x-github: githubCloudOnly: false @@ -74859,8 +77508,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -74917,8 +77566,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -74936,7 +77585,7 @@ paths: - 5 environments: type: array - items: &487 + items: &486 title: Environment description: Details of a deployment environment type: object @@ -74998,7 +77647,7 @@ paths: type: string examples: - wait_timer - wait_timer: &489 + wait_timer: &488 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -75040,11 +77689,11 @@ paths: items: type: object properties: - type: *486 + type: *485 reviewer: anyOf: - *4 - - *188 + - *187 required: - id - node_id @@ -75067,7 +77716,7 @@ paths: - id - node_id - type - deployment_branch_policy: &490 + deployment_branch_policy: &489 type: - object - 'null' @@ -75184,9 +77833,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: + - *324 - *325 - - *326 - - &488 + - &487 name: environment_name in: path required: true @@ -75199,9 +77848,9 @@ paths: description: Response content: application/json: - schema: *487 + schema: *486 examples: - default: &491 + default: &490 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -75285,9 +77934,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: + - *324 - *325 - - *326 - - *488 + - *487 requestBody: required: false content: @@ -75297,7 +77946,7 @@ paths: - object - 'null' properties: - wait_timer: *489 + wait_timer: *488 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -75316,14 +77965,14 @@ paths: items: type: object properties: - type: *486 + type: *485 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *490 + deployment_branch_policy: *489 additionalProperties: false examples: default: @@ -75343,9 +77992,9 @@ paths: description: Response content: application/json: - schema: *487 + schema: *486 examples: - default: *491 + default: *490 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -75369,9 +78018,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: + - *324 - *325 - - *326 - - *488 + - *487 responses: '204': description: Default response @@ -75396,9 +78045,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: + - *324 - *325 - - *326 - - *488 + - *487 - *17 - *19 responses: @@ -75417,7 +78066,7 @@ paths: - 2 branch_policies: type: array - items: &492 + items: &491 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -75478,9 +78127,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: + - *324 - *325 - - *326 - - *488 + - *487 requestBody: required: true content: @@ -75528,9 +78177,9 @@ paths: description: Response content: application/json: - schema: *492 + schema: *491 examples: - example-wildcard: &493 + example-wildcard: &492 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -75572,10 +78221,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: + - *324 - *325 - - *326 - - *488 - - &494 + - *487 + - &493 name: branch_policy_id in: path required: true @@ -75587,9 +78236,9 @@ paths: description: Response content: application/json: - schema: *492 + schema: *491 examples: - default: *493 + default: *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75608,10 +78257,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: + - *324 - *325 - - *326 - - *488 - - *494 + - *487 + - *493 requestBody: required: true content: @@ -75640,9 +78289,9 @@ paths: description: Response content: application/json: - schema: *492 + schema: *491 examples: - default: *493 + default: *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75661,10 +78310,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: + - *324 - *325 - - *326 - - *488 - - *494 + - *487 + - *493 responses: '204': description: Response @@ -75689,9 +78338,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *488 - - *326 + - *487 - *325 + - *324 responses: '200': description: List of deployment protection rules @@ -75708,7 +78357,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &495 + items: &494 title: Deployment protection rule description: Deployment protection rule type: object @@ -75730,7 +78379,7 @@ paths: for the environment. examples: - true - app: &496 + app: &495 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -75833,9 +78482,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *488 - - *326 + - *487 - *325 + - *324 requestBody: content: application/json: @@ -75856,9 +78505,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *495 + schema: *494 examples: - default: &497 + default: &496 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -75893,9 +78542,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *488 - - *326 + - *487 - *325 + - *324 - *19 - *17 responses: @@ -75915,7 +78564,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *496 + items: *495 examples: default: value: @@ -75950,10 +78599,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: + - *324 - *325 - - *326 - - *488 - - &498 + - *487 + - &497 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -75965,9 +78614,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *494 examples: - default: *497 + default: *496 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75988,10 +78637,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *488 - - *326 + - *487 - *325 - - *498 + - *324 + - *497 responses: '204': description: Response @@ -76017,9 +78666,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: + - *324 - *325 - - *326 - - *488 + - *487 - *17 - *19 responses: @@ -76037,9 +78686,9 @@ paths: type: integer secrets: type: array - items: *370 + items: *369 examples: - default: *371 + default: *370 headers: Link: *65 x-github: @@ -76064,17 +78713,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: + - *324 - *325 - - *326 - - *488 + - *487 responses: '200': description: Response content: application/json: - schema: *372 + schema: *371 examples: - default: *373 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76096,18 +78745,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: + - *324 - *325 - - *326 - - *488 - - *161 + - *487 + - *160 responses: '200': description: Response content: application/json: - schema: *370 + schema: *369 examples: - default: *499 + default: *498 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76129,10 +78778,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: + - *324 - *325 - - *326 - - *488 - - *161 + - *487 + - *160 requestBody: required: true content: @@ -76163,7 +78812,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -76189,10 +78838,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: + - *324 - *325 - - *326 - - *488 - - *161 + - *487 + - *160 responses: '204': description: Default response @@ -76217,10 +78866,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: + - *324 - *325 - - *326 - - *488 - - *341 + - *487 + - *340 - *19 responses: '200': @@ -76237,9 +78886,9 @@ paths: type: integer variables: type: array - items: *374 + items: *373 examples: - default: *375 + default: *374 headers: Link: *65 x-github: @@ -76262,9 +78911,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: + - *324 - *325 - - *326 - - *488 + - *487 requestBody: required: true content: @@ -76291,7 +78940,7 @@ paths: description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -76316,18 +78965,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: + - *324 - *325 - - *326 - - *488 - - *164 + - *487 + - *163 responses: '200': description: Response content: application/json: - schema: *374 + schema: *373 examples: - default: *500 + default: *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76348,10 +78997,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: + - *324 - *325 - - *326 - - *164 - - *488 + - *163 + - *487 requestBody: required: true content: @@ -76393,10 +79042,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: + - *324 - *325 - - *326 - - *164 - - *488 + - *163 + - *487 responses: '204': description: Response @@ -76418,8 +79067,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -76487,8 +79136,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: + - *324 - *325 - - *326 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -76510,7 +79159,7 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: default: value: @@ -76647,8 +79296,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: + - *324 - *325 - - *326 requestBody: required: false content: @@ -76681,9 +79330,9 @@ paths: description: Response content: application/json: - schema: *328 + schema: *327 examples: - default: *330 + default: *329 '400': *14 '422': *15 '403': *27 @@ -76704,8 +79353,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -76765,7 +79414,7 @@ paths: schema: oneOf: - *121 - - *501 + - *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76790,8 +79439,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: + - *324 - *325 - - *326 - name: file_sha in: path required: true @@ -76891,8 +79540,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -77001,7 +79650,7 @@ paths: description: Response content: application/json: - schema: &502 + schema: &501 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -77228,15 +79877,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: + - *324 - *325 - - *326 - - *457 + - *456 responses: '200': description: Response content: application/json: - schema: *502 + schema: *501 examples: default: value: @@ -77292,9 +79941,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: + - *324 - *325 - - *326 - - &503 + - &502 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. @@ -77311,7 +79960,7 @@ paths: application/json: schema: type: array - items: &504 + items: &503 title: Git Reference description: Git references within a repository type: object @@ -77387,17 +80036,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: + - *324 - *325 - - *326 - - *503 + - *502 responses: '200': description: Response content: application/json: - schema: *504 + schema: *503 examples: - default: &505 + default: &504 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -77426,8 +80075,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -77456,9 +80105,9 @@ paths: description: Response content: application/json: - schema: *504 + schema: *503 examples: - default: *505 + default: *504 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -77484,9 +80133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: + - *324 - *325 - - *326 - - *503 + - *502 requestBody: required: true content: @@ -77515,9 +80164,9 @@ paths: description: Response content: application/json: - schema: *504 + schema: *503 examples: - default: *505 + default: *504 '422': *15 '409': *52 x-github: @@ -77535,9 +80184,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: + - *324 - *325 - - *326 - - *503 + - *502 responses: '204': description: Response @@ -77592,8 +80241,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -77660,7 +80309,7 @@ paths: description: Response content: application/json: - schema: &507 + schema: &506 title: Git Tag description: Metadata for a Git tag type: object @@ -77716,7 +80365,7 @@ paths: - sha - type - url - verification: *506 + verification: *505 required: - sha - url @@ -77726,7 +80375,7 @@ paths: - tag - message examples: - default: &508 + default: &507 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -77799,8 +80448,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: + - *324 - *325 - - *326 - name: tag_sha in: path required: true @@ -77811,9 +80460,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *506 examples: - default: *508 + default: *507 '404': *6 '409': *52 x-github: @@ -77837,8 +80486,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -77912,7 +80561,7 @@ paths: description: Response content: application/json: - schema: &509 + schema: &508 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -78014,8 +80663,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: + - *324 - *325 - - *326 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -78038,7 +80687,7 @@ paths: description: Response content: application/json: - schema: *509 + schema: *508 examples: default-response: summary: Default response @@ -78097,8 +80746,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -78108,7 +80757,7 @@ paths: application/json: schema: type: array - items: &510 + items: &509 title: Webhook description: Webhooks for repositories. type: object @@ -78171,7 +80820,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &742 + last_response: &741 title: Hook Response type: object properties: @@ -78248,8 +80897,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: + - *324 - *325 - - *326 requestBody: required: false content: @@ -78302,9 +80951,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *509 examples: - default: &511 + default: &510 value: type: Repository id: 12345678 @@ -78352,17 +81001,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: + - *324 - *325 - - *326 - - *203 + - *202 responses: '200': description: Response content: application/json: - schema: *510 + schema: *509 examples: - default: *511 + default: *510 '404': *6 x-github: githubCloudOnly: false @@ -78382,9 +81031,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: + - *324 - *325 - - *326 - - *203 + - *202 requestBody: required: true content: @@ -78429,9 +81078,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *509 examples: - default: *511 + default: *510 '422': *15 '404': *6 x-github: @@ -78452,9 +81101,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: + - *324 - *325 - - *326 - - *203 + - *202 responses: '204': description: Response @@ -78478,9 +81127,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: + - *324 - *325 - - *326 - - *203 + - *202 responses: '200': description: Response @@ -78507,9 +81156,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: + - *324 - *325 - - *326 - - *203 + - *202 requestBody: required: false content: @@ -78553,12 +81202,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: + - *324 - *325 - - *326 - - *203 + - *202 - *17 + - *203 - *204 - - *205 responses: '200': description: Response @@ -78566,9 +81215,9 @@ paths: application/json: schema: type: array - items: *206 + items: *205 examples: - default: *207 + default: *206 '400': *14 '422': *15 x-github: @@ -78587,18 +81236,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: + - *324 - *325 - - *326 - - *203 + - *202 - *16 responses: '200': description: Response content: application/json: - schema: *208 + schema: *207 examples: - default: *209 + default: *208 '400': *14 '422': *15 x-github: @@ -78617,9 +81266,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: + - *324 - *325 - - *326 - - *203 + - *202 - *16 responses: '202': *37 @@ -78642,9 +81291,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: + - *324 - *325 - - *326 - - *203 + - *202 responses: '204': description: Response @@ -78669,9 +81318,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: + - *324 - *325 - - *326 - - *203 + - *202 responses: '204': description: Response @@ -78694,8 +81343,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response if immutable releases are enabled @@ -78743,10 +81392,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: + - *324 - *325 - - *326 responses: - '204': *184 + '204': *183 '409': *52 x-github: githubCloudOnly: false @@ -78764,10 +81413,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: + - *324 - *325 - - *326 responses: - '204': *184 + '204': *183 '409': *52 x-github: githubCloudOnly: false @@ -78822,14 +81471,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: &512 + schema: &511 title: Import description: A repository import from an external source. type: object @@ -78936,7 +81585,7 @@ paths: - html_url - authors_url examples: - default: &515 + default: &514 value: vcs: subversion use_lfs: true @@ -78952,7 +81601,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': &513 + '503': &512 description: Unavailable due to service under maintenance. content: application/json: @@ -78981,8 +81630,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -79030,7 +81679,7 @@ paths: description: Response content: application/json: - schema: *512 + schema: *511 examples: default: value: @@ -79055,7 +81704,7 @@ paths: type: string '422': *15 '404': *6 - '503': *513 + '503': *512 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79083,8 +81732,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: + - *324 - *325 - - *326 requestBody: required: false content: @@ -79136,7 +81785,7 @@ paths: description: Response content: application/json: - schema: *512 + schema: *511 examples: example-1: summary: Example 1 @@ -79184,7 +81833,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': *513 + '503': *512 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79207,12 +81856,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: + - *324 - *325 - - *326 responses: '204': description: Response - '503': *513 + '503': *512 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79238,9 +81887,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: + - *324 - *325 - - *326 - - &676 + - &675 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -79254,7 +81903,7 @@ paths: application/json: schema: type: array - items: &514 + items: &513 title: Porter Author description: Porter Author type: object @@ -79308,7 +81957,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': *513 + '503': *512 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79333,8 +81982,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: + - *324 - *325 - - *326 - name: author_id in: path required: true @@ -79364,7 +82013,7 @@ paths: description: Response content: application/json: - schema: *514 + schema: *513 examples: default: value: @@ -79377,7 +82026,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *513 + '503': *512 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79401,8 +82050,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -79443,7 +82092,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *513 + '503': *512 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79471,8 +82120,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -79499,11 +82148,11 @@ paths: description: Response content: application/json: - schema: *512 + schema: *511 examples: - default: *515 + default: *514 '422': *15 - '503': *513 + '503': *512 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79526,8 +82175,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -79535,8 +82184,8 @@ paths: application/json: schema: *20 examples: - default: *516 - '301': *329 + default: *515 + '301': *328 '404': *6 x-github: githubCloudOnly: false @@ -79556,8 +82205,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -79565,12 +82214,12 @@ paths: application/json: schema: anyOf: - - *222 + - *221 - type: object properties: {} additionalProperties: false examples: - default: &518 + default: &517 value: limit: collaborators_only origin: repository @@ -79595,13 +82244,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: application/json: - schema: *517 + schema: *516 examples: default: summary: Example request body @@ -79613,9 +82262,9 @@ paths: description: Response content: application/json: - schema: *222 + schema: *221 examples: - default: *518 + default: *517 '409': description: Response x-github: @@ -79637,8 +82286,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -79661,8 +82310,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -79672,9 +82321,9 @@ paths: application/json: schema: type: array - items: *519 + items: *518 examples: - default: &668 + default: &667 value: - id: 1 repository: @@ -79805,9 +82454,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: + - *324 - *325 - - *326 - - *226 + - *225 requestBody: required: false content: @@ -79836,7 +82485,7 @@ paths: description: Response content: application/json: - schema: *519 + schema: *518 examples: default: value: @@ -79967,9 +82616,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: + - *324 - *325 - - *326 - - *226 + - *225 responses: '204': description: Response @@ -80000,8 +82649,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: + - *324 - *325 - - *326 - 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 @@ -80049,7 +82698,7 @@ paths: required: false schema: type: string - - *233 + - *232 - name: sort description: What to sort results by. in: query @@ -80074,7 +82723,7 @@ paths: type: array items: *81 examples: - default: &528 + default: &527 value: - id: 1 node_id: MDU6SXNzdWUx @@ -80223,7 +82872,7 @@ paths: state_reason: completed headers: Link: *65 - '301': *329 + '301': *328 '422': *15 '404': *6 x-github: @@ -80252,8 +82901,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -80337,7 +82986,7 @@ paths: application/json: schema: *81 examples: - default: &525 + default: &524 value: id: 1 node_id: MDU6SXNzdWUx @@ -80494,7 +83143,7 @@ paths: '422': *15 '503': *113 '404': *6 - '410': *520 + '410': *519 x-github: triggersNotification: true githubCloudOnly: false @@ -80522,8 +83171,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: + - *324 - *325 - - *326 - *103 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -80546,7 +83195,7 @@ paths: type: array items: *82 examples: - default: &527 + default: &526 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -80604,8 +83253,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: + - *324 - *325 - - *326 - *95 responses: '200': @@ -80614,7 +83263,7 @@ paths: application/json: schema: *82 examples: - default: &521 + default: &520 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -80669,8 +83318,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: + - *324 - *325 - - *326 - *95 requestBody: required: true @@ -80695,7 +83344,7 @@ paths: application/json: schema: *82 examples: - default: *521 + default: *520 '422': *15 x-github: githubCloudOnly: false @@ -80713,8 +83362,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: + - *324 - *325 - - *326 - *95 responses: '204': @@ -80743,8 +83392,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment parameters: + - *324 - *325 - - *326 - *95 responses: '200': @@ -80807,7 +83456,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *520 + '410': *519 '422': *15 x-github: githubCloudOnly: false @@ -80824,8 +83473,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment parameters: + - *324 - *325 - - *326 - *95 responses: '204': @@ -80833,7 +83482,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *520 + '410': *519 '503': *113 x-github: githubCloudOnly: false @@ -80851,8 +83500,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: + - *324 - *325 - - *326 - *95 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -80879,9 +83528,9 @@ paths: application/json: schema: type: array - items: *454 + items: *453 examples: - default: *522 + default: *521 headers: Link: *65 '404': *6 @@ -80902,8 +83551,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: + - *324 - *325 - - *326 - *95 requestBody: required: true @@ -80936,16 +83585,16 @@ paths: description: Reaction exists content: application/json: - schema: *454 + schema: *453 examples: - default: *455 + default: *454 '201': description: Reaction created content: application/json: - schema: *454 + schema: *453 examples: - default: *455 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -80967,10 +83616,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: + - *324 - *325 - - *326 - *95 - - *523 + - *522 responses: '204': description: Response @@ -80990,8 +83639,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -81001,7 +83650,7 @@ paths: application/json: schema: type: array - items: &524 + items: &523 title: Issue Event description: Issue Event type: object @@ -81081,7 +83730,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *188 + requested_team: *187 dismissed_review: title: Issue Event Dismissed Review type: object @@ -81341,8 +83990,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: + - *324 - *325 - - *326 - name: event_id in: path required: true @@ -81353,7 +84002,7 @@ paths: description: Response content: application/json: - schema: *524 + schema: *523 examples: default: value: @@ -81546,7 +84195,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *520 + '410': *519 '403': *27 x-github: githubCloudOnly: false @@ -81580,9 +84229,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: + - *324 - *325 - - *326 - - &526 + - &525 name: issue_number description: The number that identifies the issue. in: path @@ -81598,7 +84247,7 @@ paths: examples: default: summary: Issue - value: *525 + value: *524 pinned_comment: summary: Issue with pinned comment value: @@ -81797,9 +84446,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *329 + '301': *328 '404': *6 - '410': *520 + '410': *519 '304': *35 x-github: githubCloudOnly: false @@ -81824,9 +84473,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: false content: @@ -81961,13 +84610,13 @@ paths: application/json: schema: *81 examples: - default: *525 + default: *524 '422': *15 '503': *113 '403': *27 - '301': *329 + '301': *328 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81985,9 +84634,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: false content: @@ -82015,7 +84664,7 @@ paths: application/json: schema: *81 examples: - default: *525 + default: *524 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82031,9 +84680,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: content: application/json: @@ -82060,7 +84709,7 @@ paths: application/json: schema: *81 examples: - default: *525 + default: *524 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82082,9 +84731,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 - name: assignee in: path required: true @@ -82124,9 +84773,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: + - *324 - *325 - - *326 - - *526 + - *525 - *86 - *17 - *19 @@ -82139,11 +84788,11 @@ paths: type: array items: *82 examples: - default: *527 + default: *526 headers: Link: *65 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82172,9 +84821,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: true content: @@ -82198,14 +84847,14 @@ paths: application/json: schema: *82 examples: - default: *521 + default: *520 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *520 + '410': *519 '422': *15 '404': *6 x-github: @@ -82233,9 +84882,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: + - *324 - *325 - - *326 - - *526 + - *525 - *17 - *19 responses: @@ -82247,12 +84896,12 @@ paths: type: array items: *81 examples: - default: *528 + default: *527 headers: Link: *65 - '301': *329 + '301': *328 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82280,9 +84929,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: true content: @@ -82306,15 +84955,15 @@ paths: application/json: schema: *81 examples: - default: *525 + default: *524 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *329 + '301': *328 '403': *27 - '410': *520 + '410': *519 '422': *15 '404': *6 x-github: @@ -82345,9 +84994,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: + - *324 - *325 - - *326 - - *526 + - *525 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -82361,13 +85010,13 @@ paths: application/json: schema: *81 examples: - default: *525 - '301': *329 + default: *524 + '301': *328 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *520 + '410': *519 x-github: triggersNotification: true githubCloudOnly: false @@ -82393,9 +85042,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: + - *324 - *325 - - *326 - - *526 + - *525 - *17 - *19 responses: @@ -82407,12 +85056,12 @@ paths: type: array items: *81 examples: - default: *528 + default: *527 headers: Link: *65 - '301': *329 + '301': *328 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82429,9 +85078,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: + - *324 - *325 - - *326 - - *526 + - *525 - *17 - *19 responses: @@ -82445,7 +85094,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &531 + - &530 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -82494,7 +85143,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &532 + - &531 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -82622,7 +85271,7 @@ paths: - performed_via_github_app - assignee - assigner - - &533 + - &532 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -82668,7 +85317,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &534 + - &533 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -82714,7 +85363,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &535 + - &534 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -82763,7 +85412,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &536 + - &535 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -82792,7 +85441,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *188 + requested_team: *187 requested_reviewer: *4 required: - review_requester @@ -82805,7 +85454,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &537 + - &536 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -82834,7 +85483,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *188 + requested_team: *187 requested_reviewer: *4 required: - review_requester @@ -82847,7 +85496,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &538 + - &537 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -82903,7 +85552,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &539 + - &538 title: Locked Issue Event description: Locked Issue Event type: object @@ -82948,7 +85597,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &540 + - &539 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -83009,7 +85658,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &541 + - &540 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -83070,7 +85719,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &542 + - &541 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -83131,7 +85780,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &543 + - &542 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -83224,7 +85873,7 @@ paths: color: red headers: Link: *65 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83241,9 +85890,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 - *17 - *19 responses: @@ -83253,9 +85902,9 @@ paths: application/json: schema: type: array - items: *529 + items: *528 examples: - default: &640 + default: &639 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -83279,9 +85928,9 @@ paths: value: '2025-12-25' headers: Link: *65 - '301': *329 + '301': *328 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83298,9 +85947,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 - *17 - *19 responses: @@ -83312,7 +85961,7 @@ paths: type: array items: *80 examples: - default: &530 + default: &529 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -83330,9 +85979,9 @@ paths: default: false headers: Link: *65 - '301': *329 + '301': *328 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83348,9 +85997,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: false content: @@ -83395,10 +86044,10 @@ paths: type: array items: *80 examples: - default: *530 - '301': *329 + default: *529 + '301': *328 '404': *6 - '410': *520 + '410': *519 '422': *15 x-github: githubCloudOnly: false @@ -83415,9 +86064,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: false content: @@ -83479,10 +86128,10 @@ paths: type: array items: *80 examples: - default: *530 - '301': *329 + default: *529 + '301': *328 '404': *6 - '410': *520 + '410': *519 '422': *15 x-github: githubCloudOnly: false @@ -83499,15 +86148,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 responses: '204': description: Response - '301': *329 + '301': *328 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83526,9 +86175,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 - name: name in: path required: true @@ -83552,9 +86201,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *329 + '301': *328 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83574,9 +86223,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: false content: @@ -83605,7 +86254,7 @@ paths: '204': description: Response '403': *27 - '410': *520 + '410': *519 '404': *6 '422': *15 x-github: @@ -83623,9 +86272,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 responses: '204': description: Response @@ -83655,9 +86304,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 responses: '200': description: Response @@ -83665,10 +86314,10 @@ paths: application/json: schema: *81 examples: - default: *525 - '301': *329 + default: *524 + '301': *328 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83685,9 +86334,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -83713,13 +86362,13 @@ paths: application/json: schema: type: array - items: *454 + items: *453 examples: - default: *522 + default: *521 headers: Link: *65 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83737,9 +86386,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: true content: @@ -83771,16 +86420,16 @@ paths: description: Response content: application/json: - schema: *454 + schema: *453 examples: - default: *455 + default: *454 '201': description: Response content: application/json: - schema: *454 + schema: *453 examples: - default: *455 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -83802,10 +86451,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: + - *324 - *325 - - *326 - - *526 - - *523 + - *525 + - *522 responses: '204': description: Response @@ -83834,9 +86483,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: true content: @@ -83860,7 +86509,7 @@ paths: application/json: schema: *81 examples: - default: *525 + default: *524 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -83893,9 +86542,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: + - *324 - *325 - - *326 - - *526 + - *525 - *17 - *19 responses: @@ -83907,11 +86556,11 @@ paths: type: array items: *81 examples: - default: *528 + default: *527 headers: Link: *65 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83939,9 +86588,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: true content: @@ -83970,14 +86619,14 @@ paths: application/json: schema: *81 examples: - default: *525 + default: *524 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *520 + '410': *519 '422': *15 '404': *6 x-github: @@ -83997,9 +86646,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 requestBody: required: true content: @@ -84032,7 +86681,7 @@ paths: application/json: schema: *81 examples: - default: *525 + default: *524 '403': *27 '404': *6 '422': *7 @@ -84054,9 +86703,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: + - *324 - *325 - - *326 - - *526 + - *525 - *17 - *19 responses: @@ -84071,6 +86720,7 @@ paths: description: Timeline Event type: object anyOf: + - *530 - *531 - *532 - *533 @@ -84083,7 +86733,6 @@ paths: - *540 - *541 - *542 - - *543 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -84140,7 +86789,7 @@ paths: pin: anyOf: - type: 'null' - - *544 + - *543 required: - event - actor @@ -84416,7 +87065,7 @@ paths: type: string comments: type: array - items: &563 + items: &562 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -84657,7 +87306,7 @@ paths: type: string comments: type: array - items: *453 + items: *452 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -84932,7 +87581,7 @@ paths: headers: Link: *65 '404': *6 - '410': *520 + '410': *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84949,8 +87598,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -84960,7 +87609,7 @@ paths: application/json: schema: type: array - items: &545 + items: &544 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -85028,8 +87677,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -85065,9 +87714,9 @@ paths: description: Response content: application/json: - schema: *545 + schema: *544 examples: - default: &546 + default: &545 value: id: 1 key: ssh-rsa AAA... @@ -85101,9 +87750,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: + - *324 - *325 - - *326 - - &547 + - &546 name: key_id description: The unique identifier of the key. in: path @@ -85115,9 +87764,9 @@ paths: description: Response content: application/json: - schema: *545 + schema: *544 examples: - default: *546 + default: *545 '404': *6 x-github: githubCloudOnly: false @@ -85135,9 +87784,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: + - *324 - *325 - - *326 - - *547 + - *546 responses: '204': description: Response @@ -85157,8 +87806,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -85170,7 +87819,7 @@ paths: type: array items: *80 examples: - default: *530 + default: *529 headers: Link: *65 '404': *6 @@ -85191,8 +87840,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -85230,7 +87879,7 @@ paths: application/json: schema: *80 examples: - default: &548 + default: &547 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -85262,8 +87911,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: + - *324 - *325 - - *326 - name: name in: path required: true @@ -85276,7 +87925,7 @@ paths: application/json: schema: *80 examples: - default: *548 + default: *547 '404': *6 x-github: githubCloudOnly: false @@ -85293,8 +87942,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: + - *324 - *325 - - *326 - name: name in: path required: true @@ -85359,8 +88008,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: + - *324 - *325 - - *326 - name: name in: path required: true @@ -85386,8 +88035,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -85426,9 +88075,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: + - *324 - *325 - - *326 - - *428 + - *427 responses: '200': description: Response @@ -85575,8 +88224,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -85641,8 +88290,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -85676,9 +88325,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *456 + schema: *455 examples: - default: *549 + default: *548 '204': description: Response when already merged '404': @@ -85703,8 +88352,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: + - *324 - *325 - - *326 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -85745,7 +88394,7 @@ paths: application/json: schema: type: array - items: *266 + items: *265 examples: default: value: @@ -85801,8 +88450,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -85842,9 +88491,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *265 examples: - default: &550 + default: &549 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -85903,9 +88552,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: + - *324 - *325 - - *326 - - &551 + - &550 name: milestone_number description: The number that identifies the milestone. in: path @@ -85917,9 +88566,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *265 examples: - default: *550 + default: *549 '404': *6 x-github: githubCloudOnly: false @@ -85936,9 +88585,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: + - *324 - *325 - - *326 - - *551 + - *550 requestBody: required: false content: @@ -85976,9 +88625,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *265 examples: - default: *550 + default: *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85994,9 +88643,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: + - *324 - *325 - - *326 - - *551 + - *550 responses: '204': description: Response @@ -86017,9 +88666,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: + - *324 - *325 - - *326 - - *551 + - *550 - *17 - *19 responses: @@ -86031,7 +88680,7 @@ paths: type: array items: *80 examples: - default: *530 + default: *529 headers: Link: *65 x-github: @@ -86050,12 +88699,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: + - *324 - *325 - - *326 + - *551 - *552 - - *553 - *86 - - *554 + - *553 - *17 - *19 responses: @@ -86067,7 +88716,7 @@ paths: type: array items: *106 examples: - default: *555 + default: *554 headers: Link: *65 x-github: @@ -86091,8 +88740,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: + - *324 - *325 - - *326 requestBody: required: false content: @@ -86150,14 +88799,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: &556 + schema: &555 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -86301,7 +88950,7 @@ paths: - custom_404 - public examples: - default: &557 + default: &556 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -86342,8 +88991,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -86398,9 +89047,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *555 examples: - default: *557 + default: *556 '422': *15 '409': *52 x-github: @@ -86423,8 +89072,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -86524,8 +89173,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -86551,8 +89200,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -86562,7 +89211,7 @@ paths: application/json: schema: type: array - items: &558 + items: &557 title: Page Build description: Page Build type: object @@ -86654,8 +89303,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: + - *324 - *325 - - *326 responses: '201': description: Response @@ -86702,16 +89351,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *558 + schema: *557 examples: - default: &559 + default: &558 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -86759,8 +89408,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: + - *324 - *325 - - *326 - name: build_id in: path required: true @@ -86771,9 +89420,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *557 examples: - default: *559 + default: *558 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86793,8 +89442,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -86902,9 +89551,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: + - *324 - *325 - - *326 - - &560 + - &559 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -86962,11 +89611,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: + - *324 - *325 - - *326 - - *560 + - *559 responses: - '204': *184 + '204': *183 '404': *6 x-github: githubCloudOnly: false @@ -86991,8 +89640,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -87260,7 +89909,7 @@ paths: description: Empty response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -87287,8 +89936,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Private vulnerability reporting status @@ -87325,10 +89974,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: + - *324 - *325 - - *326 responses: - '204': *184 + '204': *183 '422': *14 x-github: githubCloudOnly: false @@ -87347,10 +89996,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: + - *324 - *325 - - *326 responses: - '204': *184 + '204': *183 '422': *14 x-github: githubCloudOnly: false @@ -87370,8 +90019,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -87379,7 +90028,7 @@ paths: application/json: schema: type: array - items: *280 + items: *279 examples: default: value: @@ -87410,8 +90059,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -87423,7 +90072,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *280 + items: *279 required: - properties examples: @@ -87473,8 +90122,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: + - *324 - *325 - - *326 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -87534,9 +90183,9 @@ paths: application/json: schema: type: array - items: *460 + items: *459 examples: - default: *561 + default: *560 headers: Link: *65 '304': *35 @@ -87568,8 +90217,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -87636,7 +90285,7 @@ paths: description: Response content: application/json: - schema: &565 + schema: &564 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -87765,7 +90414,7 @@ paths: milestone: anyOf: - type: 'null' - - *266 + - *265 active_lock_reason: type: - string @@ -87804,7 +90453,7 @@ paths: items: *4 requested_teams: type: array - items: *245 + items: *244 head: type: object properties: @@ -87842,14 +90491,14 @@ paths: _links: type: object properties: - comments: *267 - commits: *267 - statuses: *267 - html: *267 - issue: *267 - review_comments: *267 - review_comment: *267 - self: *267 + comments: *266 + commits: *266 + statuses: *266 + html: *266 + issue: *266 + review_comments: *266 + review_comment: *266 + self: *266 required: - comments - commits @@ -87860,7 +90509,7 @@ paths: - review_comment - self author_association: *78 - auto_merge: *562 + auto_merge: *561 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -87960,7 +90609,7 @@ paths: - merged_by - review_comments examples: - default: &566 + default: &565 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -88487,8 +91136,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: + - *324 - *325 - - *326 - name: sort in: query required: false @@ -88517,9 +91166,9 @@ paths: application/json: schema: type: array - items: *563 + items: *562 examples: - default: &568 + default: &567 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -88596,17 +91245,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: + - *324 - *325 - - *326 - *95 responses: '200': description: Response content: application/json: - schema: *563 + schema: *562 examples: - default: &564 + default: &563 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -88681,8 +91330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: + - *324 - *325 - - *326 - *95 requestBody: required: true @@ -88705,9 +91354,9 @@ paths: description: Response content: application/json: - schema: *563 + schema: *562 examples: - default: *564 + default: *563 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88723,8 +91372,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: + - *324 - *325 - - *326 - *95 responses: '204': @@ -88746,8 +91395,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: + - *324 - *325 - - *326 - *95 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -88774,9 +91423,9 @@ paths: application/json: schema: type: array - items: *454 + items: *453 examples: - default: *522 + default: *521 headers: Link: *65 '404': *6 @@ -88797,8 +91446,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: + - *324 - *325 - - *326 - *95 requestBody: required: true @@ -88831,16 +91480,16 @@ paths: description: Reaction exists content: application/json: - schema: *454 + schema: *453 examples: - default: *455 + default: *454 '201': description: Reaction created content: application/json: - schema: *454 + schema: *453 examples: - default: *455 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -88862,10 +91511,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: + - *324 - *325 - - *326 - *95 - - *523 + - *522 responses: '204': description: Response @@ -88908,9 +91557,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: + - *324 - *325 - - *326 - - &567 + - &566 name: pull_number description: The number that identifies the pull request. in: path @@ -88923,9 +91572,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *565 + schema: *564 examples: - default: *566 + default: *565 '304': *35 '404': *6 '406': @@ -88960,9 +91609,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 requestBody: required: false content: @@ -89004,9 +91653,9 @@ paths: description: Response content: application/json: - schema: *565 + schema: *564 examples: - default: *566 + default: *565 '422': *15 '403': *27 x-github: @@ -89028,9 +91677,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 requestBody: required: true content: @@ -89091,17 +91740,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '401': *23 '403': *27 '404': *6 @@ -89131,9 +91780,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 - *103 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -89154,9 +91803,9 @@ paths: application/json: schema: type: array - items: *563 + items: *562 examples: - default: *568 + default: *567 headers: Link: *65 x-github: @@ -89189,9 +91838,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 requestBody: required: true content: @@ -89297,7 +91946,7 @@ paths: description: Response content: application/json: - schema: *563 + schema: *562 examples: example-for-a-multi-line-comment: value: @@ -89385,9 +92034,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: + - *324 - *325 - - *326 - - *567 + - *566 - *95 requestBody: required: true @@ -89410,7 +92059,7 @@ paths: description: Response content: application/json: - schema: *563 + schema: *562 examples: default: value: @@ -89496,9 +92145,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 - *17 - *19 responses: @@ -89508,9 +92157,9 @@ paths: application/json: schema: type: array - items: *456 + items: *455 examples: - default: *569 + default: *568 headers: Link: *65 x-github: @@ -89540,9 +92189,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: + - *324 - *325 - - *326 - - *567 + - *566 - *17 - *19 responses: @@ -89552,7 +92201,7 @@ paths: application/json: schema: type: array - items: *467 + items: *466 examples: default: value: @@ -89590,9 +92239,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: + - *324 - *325 - - *326 - - *567 + - *566 responses: '204': description: Response if pull request has been merged @@ -89615,9 +92264,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 requestBody: required: false content: @@ -89729,9 +92378,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 responses: '200': description: Response @@ -89747,7 +92396,7 @@ paths: items: *4 teams: type: array - items: *188 + items: *187 required: - users - teams @@ -89806,9 +92455,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 requestBody: required: false content: @@ -89845,7 +92494,7 @@ paths: description: Response content: application/json: - schema: *460 + schema: *459 examples: default: value: @@ -90381,9 +93030,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 requestBody: required: true content: @@ -90417,7 +93066,7 @@ paths: description: Response content: application/json: - schema: *460 + schema: *459 examples: default: value: @@ -90922,9 +93571,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 - *17 - *19 responses: @@ -90934,7 +93583,7 @@ paths: application/json: schema: type: array - items: &570 + items: &569 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -91090,9 +93739,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 + - *566 requestBody: required: false content: @@ -91182,9 +93831,9 @@ paths: description: Response content: application/json: - schema: *570 + schema: *569 examples: - default: &572 + default: &571 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -91247,10 +93896,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 - - &571 + - *566 + - &570 name: review_id description: The unique identifier of the review. in: path @@ -91262,9 +93911,9 @@ paths: description: Response content: application/json: - schema: *570 + schema: *569 examples: - default: &573 + default: &572 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -91323,10 +93972,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 - - *571 + - *566 + - *570 requestBody: required: true content: @@ -91349,7 +93998,7 @@ paths: description: Response content: application/json: - schema: *570 + schema: *569 examples: default: value: @@ -91411,18 +94060,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 - - *571 + - *566 + - *570 responses: '200': description: Response content: application/json: - schema: *570 + schema: *569 examples: - default: *572 + default: *571 '422': *7 '404': *6 x-github: @@ -91449,10 +94098,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: + - *324 - *325 - - *326 - - *567 - - *571 + - *566 + - *570 - *17 - *19 responses: @@ -91550,9 +94199,9 @@ paths: _links: type: object properties: - self: *267 - html: *267 - pull_request: *267 + self: *266 + html: *266 + pull_request: *266 required: - self - html @@ -91710,10 +94359,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 - - *571 + - *566 + - *570 requestBody: required: true content: @@ -91742,7 +94391,7 @@ paths: description: Response content: application/json: - schema: *570 + schema: *569 examples: default: value: @@ -91805,10 +94454,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: + - *324 - *325 - - *326 - - *567 - - *571 + - *566 + - *570 requestBody: required: true content: @@ -91843,9 +94492,9 @@ paths: description: Response content: application/json: - schema: *570 + schema: *569 examples: - default: *573 + default: *572 '404': *6 '422': *7 '403': *27 @@ -91867,9 +94516,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: + - *324 - *325 - - *326 - - *567 + - *566 requestBody: required: false content: @@ -91933,8 +94582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: + - *324 - *325 - - *326 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -91947,9 +94596,9 @@ paths: description: Response content: application/json: - schema: *574 + schema: *573 examples: - default: &575 + default: &574 value: type: file encoding: base64 @@ -91991,8 +94640,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: + - *324 - *325 - - *326 - name: dir description: The alternate path to look for a README file in: path @@ -92012,9 +94661,9 @@ paths: description: Response content: application/json: - schema: *574 + schema: *573 examples: - default: *575 + default: *574 '404': *6 '422': *15 x-github: @@ -92036,8 +94685,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -92047,7 +94696,7 @@ paths: application/json: schema: type: array - items: *576 + items: *575 examples: default: value: @@ -92141,8 +94790,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -92218,9 +94867,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *575 examples: - default: &580 + default: &579 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -92325,9 +94974,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: + - *324 - *325 - - *326 - - &578 + - &577 name: asset_id description: The unique identifier of the asset. in: path @@ -92339,9 +94988,9 @@ paths: description: Response content: application/json: - schema: *577 + schema: *576 examples: - default: &579 + default: &578 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 @@ -92376,7 +95025,7 @@ paths: type: User site_admin: false '404': *6 - '302': *469 + '302': *468 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92392,9 +95041,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: + - *324 - *325 - - *326 - - *578 + - *577 requestBody: required: false content: @@ -92423,9 +95072,9 @@ paths: description: Response content: application/json: - schema: *577 + schema: *576 examples: - default: *579 + default: *578 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92441,9 +95090,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: + - *324 - *325 - - *326 - - *578 + - *577 responses: '204': description: Response @@ -92468,8 +95117,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -92555,16 +95204,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: + - *324 - *325 - - *326 responses: '200': description: Response content: application/json: - schema: *576 + schema: *575 examples: - default: *580 + default: *579 '404': *6 x-github: githubCloudOnly: false @@ -92582,8 +95231,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: + - *324 - *325 - - *326 - name: tag description: tag parameter in: path @@ -92596,9 +95245,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *575 examples: - default: *580 + default: *579 '404': *6 x-github: githubCloudOnly: false @@ -92620,9 +95269,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: + - *324 - *325 - - *326 - - &581 + - &580 name: release_id description: The unique identifier of the release. in: path @@ -92636,9 +95285,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *576 + schema: *575 examples: - default: *580 + default: *579 '401': description: Unauthorized x-github: @@ -92656,9 +95305,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: + - *324 - *325 - - *326 - - *581 + - *580 requestBody: required: false content: @@ -92722,9 +95371,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *575 examples: - default: *580 + default: *579 '404': description: Not Found if the discussion category name is invalid content: @@ -92745,9 +95394,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: + - *324 - *325 - - *326 - - *581 + - *580 responses: '204': description: Response @@ -92768,9 +95417,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: + - *324 - *325 - - *326 - - *581 + - *580 - *17 - *19 responses: @@ -92780,7 +95429,7 @@ paths: application/json: schema: type: array - items: *577 + items: *576 examples: default: value: @@ -92861,9 +95510,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: + - *324 - *325 - - *326 - - *581 + - *580 - name: name in: query required: true @@ -92889,7 +95538,7 @@ paths: description: Response for successful upload content: application/json: - schema: *577 + schema: *576 examples: response-for-successful-upload: value: @@ -92944,9 +95593,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: + - *324 - *325 - - *326 - - *581 + - *580 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -92970,9 +95619,9 @@ paths: application/json: schema: type: array - items: *454 + items: *453 examples: - default: *522 + default: *521 headers: Link: *65 '404': *6 @@ -92993,9 +95642,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: + - *324 - *325 - - *326 - - *581 + - *580 requestBody: required: true content: @@ -93025,16 +95674,16 @@ paths: description: Reaction exists content: application/json: - schema: *454 + schema: *453 examples: - default: *455 + default: *454 '201': description: Reaction created content: application/json: - schema: *454 + schema: *453 examples: - default: *455 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -93056,10 +95705,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: + - *324 - *325 - - *326 - - *581 - - *523 + - *580 + - *522 responses: '204': description: Response @@ -93083,9 +95732,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: + - *324 - *325 - - *326 - - *392 + - *391 - *17 - *19 responses: @@ -93101,8 +95750,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *287 - - &582 + - *286 + - &581 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -93121,69 +95770,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. + - allOf: + - *287 + - *581 - allOf: - *288 - - *582 + - *581 - allOf: - *289 - - *582 + - *581 - allOf: - - *290 - *582 + - *581 - allOf: - - *583 - - *582 + - *290 + - *581 - allOf: - *291 - - *582 + - *581 - allOf: - *292 - - *582 + - *581 - allOf: - *293 - - *582 + - *581 - allOf: - *294 - - *582 + - *581 - allOf: - *295 - - *582 + - *581 - allOf: - *296 - - *582 + - *581 - allOf: - *297 - - *582 + - *581 - allOf: - *298 - - *582 + - *581 - allOf: - *299 - - *582 + - *581 - allOf: - *300 - - *582 + - *581 - allOf: - *301 - - *582 + - *581 - allOf: - *302 - - *582 + - *581 - allOf: - *303 - - *582 + - *581 - allOf: - *304 - - *582 + - *581 - allOf: - *305 - - *582 + - *581 - allOf: - *306 - - *582 - - allOf: - - *307 - - *582 + - *581 examples: default: value: @@ -93222,8 +95871,8 @@ paths: category: repos subcategory: rules parameters: + - *324 - *325 - - *326 - *17 - *19 - name: includes_parents @@ -93234,7 +95883,7 @@ paths: schema: type: boolean default: true - - *584 + - *583 responses: '200': description: Response @@ -93242,7 +95891,7 @@ paths: application/json: schema: type: array - items: *308 + items: *307 examples: default: value: @@ -93289,8 +95938,8 @@ paths: category: repos subcategory: rules parameters: + - *324 - *325 - - *326 requestBody: description: Request body required: true @@ -93310,16 +95959,16 @@ paths: - tag - push default: branch - enforcement: *284 + enforcement: *283 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *285 - conditions: *282 + items: *284 + conditions: *281 rules: type: array description: An array of rules within the ruleset. - items: *585 + items: *584 required: - name - enforcement @@ -93350,9 +95999,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *307 examples: - default: &595 + default: &594 value: id: 42 name: super cool ruleset @@ -93400,12 +96049,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: + - *324 - *325 - - *326 + - *585 - *586 - *587 - *588 - - *589 - *17 - *19 responses: @@ -93413,9 +96062,9 @@ paths: description: Response content: application/json: - schema: *590 + schema: *589 examples: - default: *591 + default: *590 '404': *6 '500': *53 x-github: @@ -93436,17 +96085,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: + - *324 - *325 - - *326 - - *592 + - *591 responses: '200': description: Response content: application/json: - schema: *593 + schema: *592 examples: - default: *594 + default: *593 '404': *6 '500': *53 x-github: @@ -93474,8 +96123,8 @@ paths: category: repos subcategory: rules parameters: + - *324 - *325 - - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -93495,9 +96144,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *307 examples: - default: *595 + default: *594 '404': *6 '500': *53 put: @@ -93515,8 +96164,8 @@ paths: category: repos subcategory: rules parameters: + - *324 - *325 - - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -93541,16 +96190,16 @@ paths: - branch - tag - push - enforcement: *284 + enforcement: *283 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *285 - conditions: *282 + items: *284 + conditions: *281 rules: description: An array of rules within the ruleset. type: array - items: *585 + items: *584 examples: default: value: @@ -93578,9 +96227,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *307 examples: - default: *595 + default: *594 '404': *6 '422': *15 '500': *53 @@ -93599,8 +96248,8 @@ paths: category: repos subcategory: rules parameters: + - *324 - *325 - - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -93623,8 +96272,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: + - *324 - *325 - - *326 - *17 - *19 - name: ruleset_id @@ -93640,9 +96289,9 @@ paths: application/json: schema: type: array - items: *311 + items: *310 examples: - default: *596 + default: *595 '404': *6 '500': *53 x-github: @@ -93661,8 +96310,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: + - *324 - *325 - - *326 - name: ruleset_id description: The ID of the ruleset. in: path @@ -93680,7 +96329,7 @@ paths: description: Response content: application/json: - schema: *597 + schema: *596 examples: default: value: @@ -93735,22 +96384,22 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: + - *324 - *325 - - *326 + - *597 - *598 - *599 - *600 - *601 - - *602 - *59 - *19 - *17 + - *602 - *603 - *604 - *605 - *606 - *607 - - *608 responses: '200': description: Response @@ -93758,24 +96407,24 @@ paths: application/json: schema: type: array - items: &612 + items: &611 type: object properties: - number: *171 - created_at: *172 + number: *170 + created_at: *171 updated_at: anyOf: - type: 'null' - - *173 - url: *174 - html_url: *175 + - *172 + url: *173 + html_url: *174 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *609 - resolution: *610 + state: *608 + resolution: *609 resolved_at: type: - string @@ -93869,7 +96518,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *611 + - *610 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -94014,16 +96663,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: + - *324 - *325 - - *326 - - *422 - - *608 + - *421 + - *607 responses: '200': description: Response content: application/json: - schema: *612 + schema: *611 examples: default: value: @@ -94077,9 +96726,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: + - *324 - *325 - - *326 - - *422 + - *421 requestBody: required: true content: @@ -94087,8 +96736,8 @@ paths: schema: type: object properties: - state: *609 - resolution: *610 + state: *608 + resolution: *609 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -94126,7 +96775,7 @@ paths: description: Response content: application/json: - schema: *612 + schema: *611 examples: default: value: @@ -94221,9 +96870,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: + - *324 - *325 - - *326 - - *422 + - *421 - *19 - *17 responses: @@ -94234,7 +96883,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &762 + items: &761 type: object properties: type: @@ -94261,6 +96910,7 @@ paths: - commit details: oneOf: + - *612 - *613 - *614 - *615 @@ -94273,7 +96923,6 @@ paths: - *622 - *623 - *624 - - *625 examples: default: value: @@ -94359,8 +97008,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -94368,14 +97017,14 @@ paths: schema: type: object properties: - reason: &627 + reason: &626 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *626 + placeholder_id: *625 required: - reason - placeholder_id @@ -94392,7 +97041,7 @@ paths: schema: type: object properties: - reason: *627 + reason: *626 expire_at: type: - string @@ -94439,8 +97088,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: + - *324 - *325 - - *326 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -94455,7 +97104,7 @@ paths: properties: incremental_scans: type: array - items: &628 + items: &627 description: Information on a single scan performed by secret scanning on the repository type: object @@ -94483,15 +97132,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *628 + items: *627 backfill_scans: type: array - items: *628 + items: *627 custom_pattern_backfill_scans: type: array items: allOf: - - *628 + - *627 - type: object properties: pattern_name: @@ -94561,8 +97210,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: + - *324 - *325 - - *326 - *59 - name: sort description: The property to sort the results by. @@ -94606,9 +97255,9 @@ paths: application/json: schema: type: array - items: *629 + items: *628 examples: - default: *630 + default: *629 '400': *14 '404': *6 x-github: @@ -94631,8 +97280,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -94712,7 +97361,7 @@ paths: login: type: string description: The username of the user credited. - type: *314 + type: *313 required: - login - type @@ -94802,9 +97451,9 @@ paths: description: Response content: application/json: - schema: *629 + schema: *628 examples: - default: &632 + default: &631 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -95037,8 +97686,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -95151,7 +97800,7 @@ paths: description: Response content: application/json: - schema: *629 + schema: *628 examples: default: value: @@ -95298,17 +97947,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: + - *324 - *325 - - *326 - - *631 + - *630 responses: '200': description: Response content: application/json: - schema: *629 + schema: *628 examples: - default: *632 + default: *631 '403': *27 '404': *6 x-github: @@ -95332,9 +97981,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: + - *324 - *325 - - *326 - - *631 + - *630 requestBody: required: true content: @@ -95414,7 +98063,7 @@ paths: login: type: string description: The username of the user credited. - type: *314 + type: *313 required: - login - type @@ -95505,10 +98154,10 @@ paths: description: Response content: application/json: - schema: *629 + schema: *628 examples: - default: *632 - add_credit: *632 + default: *631 + add_credit: *631 '403': *27 '404': *6 '422': @@ -95546,9 +98195,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: + - *324 - *325 - - *326 - - *631 + - *630 responses: '202': *37 '400': *14 @@ -95575,17 +98224,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: + - *324 - *325 - - *326 - - *631 + - *630 responses: '202': description: Response content: application/json: - schema: *328 + schema: *327 examples: - default: *330 + default: *329 '400': *14 '422': *15 '403': *27 @@ -95611,8 +98260,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -95708,8 +98357,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: + - *324 - *325 - - *326 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -95718,7 +98367,7 @@ paths: application/json: schema: type: array - items: &633 + items: &632 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -95731,7 +98380,7 @@ paths: - 1124 - -435 '202': *37 - '204': *184 + '204': *183 '422': description: Repository contains more than 10,000 commits x-github: @@ -95751,8 +98400,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -95803,7 +98452,7 @@ paths: total: 89 week: 1336280400 '202': *37 - '204': *184 + '204': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95830,8 +98479,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -95903,7 +98552,7 @@ paths: d: 77 c: 10 '202': *37 - '204': *184 + '204': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95925,8 +98574,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: + - *324 - *325 - - *326 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -96080,8 +98729,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: + - *324 - *325 - - *326 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -96091,7 +98740,7 @@ paths: application/json: schema: type: array - items: *633 + items: *632 examples: default: value: @@ -96104,7 +98753,7 @@ paths: - - 0 - 2 - 21 - '204': *184 + '204': *183 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96124,8 +98773,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: + - *324 - *325 - - *326 - name: sha in: path required: true @@ -96181,7 +98830,7 @@ paths: description: Response content: application/json: - schema: *634 + schema: *633 examples: default: value: @@ -96235,8 +98884,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -96268,14 +98917,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: + - *324 - *325 - - *326 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &635 + schema: &634 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -96348,8 +98997,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: + - *324 - *325 - - *326 requestBody: required: false content: @@ -96375,7 +99024,7 @@ paths: description: Response content: application/json: - schema: *635 + schema: *634 examples: default: value: @@ -96402,8 +99051,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -96423,8 +99072,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -96506,8 +99155,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: + - *324 - *325 - - *326 - name: ref in: path required: true @@ -96543,8 +99192,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: + - *324 - *325 - - *326 - *17 - *19 responses: @@ -96554,9 +99203,9 @@ paths: application/json: schema: type: array - items: *188 + items: *187 examples: - default: *246 + default: *245 headers: Link: *65 '404': *6 @@ -96576,8 +99225,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: + - *324 - *325 - - *326 - *19 - *17 responses: @@ -96585,7 +99234,7 @@ paths: description: Response content: application/json: - schema: &636 + schema: &635 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -96597,7 +99246,7 @@ paths: required: - names examples: - default: &637 + default: &636 value: names: - octocat @@ -96620,8 +99269,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -96652,9 +99301,9 @@ paths: description: Response content: application/json: - schema: *636 + schema: *635 examples: - default: *637 + default: *636 '404': *6 '422': *7 x-github: @@ -96675,9 +99324,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: + - *324 - *325 - - *326 - - &638 + - &637 name: per description: The time frame to display results for. in: query @@ -96708,7 +99357,7 @@ paths: - 128 clones: type: array - items: &639 + items: &638 title: Traffic type: object properties: @@ -96795,8 +99444,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -96890,8 +99539,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: + - *324 - *325 - - *326 responses: '200': description: Response @@ -96954,9 +99603,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: + - *324 - *325 - - *326 - - *638 + - *637 responses: '200': description: Response @@ -96977,7 +99626,7 @@ paths: - 3782 views: type: array - items: *639 + items: *638 required: - uniques - count @@ -97054,8 +99703,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: + - *324 - *325 - - *326 requestBody: required: true content: @@ -97091,7 +99740,7 @@ paths: description: Response content: application/json: - schema: *153 + schema: *152 examples: default: value: @@ -97329,8 +99978,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: + - *324 - *325 - - *326 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -97353,8 +100002,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -97376,8 +100025,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -97403,8 +100052,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: + - *324 - *325 - - *326 - name: ref in: path required: true @@ -97496,9 +100145,9 @@ paths: description: Response content: application/json: - schema: *328 + schema: *327 examples: - default: *330 + default: *329 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -97539,7 +100188,7 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: default: value: @@ -97645,8 +100294,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *142 - - *526 + - *141 + - *525 requestBody: required: true content: @@ -97712,9 +100361,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *529 + items: *528 examples: - default: *640 + default: *639 '400': *14 '403': *27 '404': *6 @@ -97750,8 +100399,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *142 - - *526 + - *141 + - *525 requestBody: required: true content: @@ -97818,9 +100467,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *529 + items: *528 examples: - default: *640 + default: *639 '400': *14 '403': *27 '404': *6 @@ -97851,9 +100500,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue parameters: - - *142 - - *526 - - *229 + - *141 + - *525 + - *228 responses: '204': description: Issue field value deleted successfully @@ -97974,7 +100623,7 @@ paths: html_url: type: string format: uri - repository: *153 + repository: *152 score: type: number file_size: @@ -97993,7 +100642,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &641 + text_matches: &640 title: Search Result Text Matches type: array items: @@ -98156,7 +100805,7 @@ paths: enum: - author-date - committer-date - - &642 + - &641 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 @@ -98225,7 +100874,7 @@ paths: committer: anyOf: - type: 'null' - - *390 + - *389 comment_count: type: integer message: @@ -98244,7 +100893,7 @@ paths: url: type: string format: uri - verification: *506 + verification: *505 required: - author - committer @@ -98259,7 +100908,7 @@ paths: committer: anyOf: - type: 'null' - - *390 + - *389 parents: type: array items: @@ -98271,12 +100920,12 @@ paths: type: string sha: type: string - repository: *153 + repository: *152 score: type: number node_id: type: string - text_matches: *641 + text_matches: *640 required: - sha - node_id @@ -98468,7 +101117,7 @@ paths: - interactions - created - updated - - *642 + - *641 - *17 - *19 - name: advanced_search @@ -98582,11 +101231,11 @@ paths: type: - string - 'null' - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: type: string state_reason: @@ -98596,7 +101245,7 @@ paths: milestone: anyOf: - type: 'null' - - *266 + - *265 comments: type: integer created_at: @@ -98610,7 +101259,7 @@ paths: - string - 'null' format: date-time - text_matches: *641 + text_matches: *640 pull_request: type: object properties: @@ -98659,7 +101308,7 @@ paths: timeline_url: type: string format: uri - type: *230 + type: *229 performed_via_github_app: anyOf: - type: 'null' @@ -98875,7 +101524,7 @@ paths: enum: - created - updated - - *642 + - *641 - *17 - *19 responses: @@ -98920,7 +101569,7 @@ paths: - 'null' score: type: number - text_matches: *641 + text_matches: *640 required: - id - node_id @@ -99005,7 +101654,7 @@ paths: - forks - help-wanted-issues - updated - - *642 + - *641 - *17 - *19 responses: @@ -99251,7 +101900,7 @@ paths: - admin - pull - push - text_matches: *641 + text_matches: *640 temp_clone_token: type: string allow_merge_commit: @@ -99559,7 +102208,7 @@ paths: - string - 'null' format: uri - text_matches: *641 + text_matches: *640 related: type: - array @@ -99752,7 +102401,7 @@ paths: - followers - repositories - joined - - *642 + - *641 - *17 - *19 responses: @@ -99862,7 +102511,7 @@ paths: type: - boolean - 'null' - text_matches: *641 + text_matches: *640 blog: type: - string @@ -99944,7 +102593,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &645 + - &644 name: team_id description: The unique identifier of the team. in: path @@ -99956,9 +102605,9 @@ paths: description: Response content: application/json: - schema: *321 + schema: *320 examples: - default: *322 + default: *321 '404': *6 x-github: githubCloudOnly: false @@ -99985,7 +102634,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *645 + - *644 requestBody: required: true content: @@ -100049,16 +102698,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *321 + schema: *320 examples: - default: *322 + default: *321 '201': description: Response content: application/json: - schema: *321 + schema: *320 examples: - default: *322 + default: *321 '404': *6 '422': *15 '403': *27 @@ -100086,7 +102735,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *645 + - *644 responses: '204': description: Response @@ -100115,7 +102764,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *645 + - *644 - *17 - *19 responses: @@ -100125,9 +102774,9 @@ paths: application/json: schema: type: array - items: *224 + items: *223 examples: - default: *225 + default: *224 headers: Link: *65 x-github: @@ -100153,7 +102802,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *645 + - *644 - name: role description: Filters members returned by their role in the team. in: query @@ -100204,7 +102853,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *645 + - *644 - *69 responses: '204': @@ -100241,7 +102890,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *645 + - *644 - *69 responses: '204': @@ -100281,7 +102930,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *645 + - *644 - *69 responses: '204': @@ -100318,16 +102967,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *645 + - *644 - *69 responses: '200': description: Response content: application/json: - schema: *324 + schema: *323 examples: - response-if-user-is-a-team-maintainer: *646 + response-if-user-is-a-team-maintainer: *645 '404': *6 x-github: githubCloudOnly: false @@ -100360,7 +103009,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *645 + - *644 - *69 requestBody: required: false @@ -100386,9 +103035,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *323 examples: - response-if-users-membership-with-team-is-now-pending: *647 + response-if-users-membership-with-team-is-now-pending: *646 '403': description: Forbidden if team synchronization is set up '422': @@ -100422,7 +103071,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *645 + - *644 - *69 responses: '204': @@ -100450,7 +103099,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *645 + - *644 - *17 - *19 responses: @@ -100460,9 +103109,9 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: - default: *260 + default: *259 headers: Link: *65 '404': *6 @@ -100492,15 +103141,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *645 + - *644 + - *324 - *325 - - *326 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *648 + schema: *647 examples: alternative-response-with-extra-repository-information: value: @@ -100651,9 +103300,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *645 + - *644 + - *324 - *325 - - *326 requestBody: required: false content: @@ -100703,9 +103352,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *645 + - *644 + - *324 - *325 - - *326 responses: '204': description: Response @@ -100730,7 +103379,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *645 + - *644 - *17 - *19 responses: @@ -100740,9 +103389,9 @@ paths: application/json: schema: type: array - items: *188 + items: *187 examples: - response-if-child-teams-exist: *649 + response-if-child-teams-exist: *648 headers: Link: *65 '404': *6 @@ -100775,7 +103424,7 @@ paths: application/json: schema: oneOf: - - &650 + - &649 title: Private User description: Private User type: object @@ -101025,7 +103674,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - &675 + - &674 title: Public User description: Public User type: object @@ -101359,7 +104008,7 @@ paths: description: Response content: application/json: - schema: *650 + schema: *649 examples: default: value: @@ -101562,9 +104211,9 @@ paths: type: integer codespaces: type: array - items: *235 + items: *234 examples: - default: *236 + default: *235 '304': *35 '500': *53 '401': *23 @@ -101703,17 +104352,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '401': *23 '403': *27 '404': *6 @@ -101757,7 +104406,7 @@ paths: type: integer secrets: type: array - items: &651 + items: &650 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -101799,7 +104448,7 @@ paths: - visibility - selected_repositories_url examples: - default: *447 + default: *446 headers: Link: *65 x-github: @@ -101871,13 +104520,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *161 + - *160 responses: '200': description: Response content: application/json: - schema: *651 + schema: *650 examples: default: value: @@ -101907,7 +104556,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *161 + - *160 requestBody: required: true content: @@ -101952,7 +104601,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -101980,7 +104629,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *161 + - *160 responses: '204': description: Response @@ -102005,7 +104654,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *161 + - *160 responses: '200': description: Response @@ -102021,9 +104670,9 @@ paths: type: integer repositories: type: array - items: *153 + items: *152 examples: - default: *189 + default: *188 '401': *23 '403': *27 '404': *6 @@ -102048,7 +104697,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *161 + - *160 requestBody: required: true content: @@ -102102,7 +104751,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *161 + - *160 - name: repository_id in: path required: true @@ -102135,7 +104784,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *161 + - *160 - name: repository_id in: path required: true @@ -102167,15 +104816,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *237 + - *236 responses: '200': description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '304': *35 '500': *53 '401': *23 @@ -102201,7 +104850,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *237 + - *236 requestBody: required: false content: @@ -102231,9 +104880,9 @@ paths: description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '401': *23 '403': *27 '404': *6 @@ -102255,7 +104904,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *237 + - *236 responses: '202': *37 '304': *35 @@ -102284,13 +104933,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *237 + - *236 responses: '202': description: Response content: application/json: - schema: &652 + schema: &651 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -102343,7 +104992,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &653 + default: &652 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -102375,7 +105024,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *237 + - *236 - name: export_id in: path required: true @@ -102388,9 +105037,9 @@ paths: description: Response content: application/json: - schema: *652 + schema: *651 examples: - default: *653 + default: *652 '404': *6 x-github: githubCloudOnly: false @@ -102411,7 +105060,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *237 + - *236 responses: '200': description: Response @@ -102427,9 +105076,9 @@ paths: type: integer machines: type: array - items: *446 + items: *445 examples: - default: *654 + default: *653 '304': *35 '500': *53 '401': *23 @@ -102458,7 +105107,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *237 + - *236 requestBody: required: true content: @@ -102514,11 +105163,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *328 + repository: *327 machine: anyOf: - type: 'null' - - *446 + - *445 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -103315,15 +105964,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *237 + - *236 responses: '200': description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '304': *35 '500': *53 '400': *14 @@ -103355,15 +106004,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *237 + - *236 responses: '200': description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *445 + default: *444 '500': *53 '401': *23 '403': *27 @@ -103393,9 +106042,9 @@ paths: application/json: schema: type: array - items: *247 + items: *246 examples: - default: &665 + default: &664 value: - id: 197 name: hello_docker @@ -103496,7 +106145,7 @@ paths: application/json: schema: type: array - items: &655 + items: &654 title: Email description: Email type: object @@ -103566,9 +106215,9 @@ paths: application/json: schema: type: array - items: *655 + items: *654 examples: - default: &667 + default: &666 value: - email: octocat@github.com verified: true @@ -103645,7 +106294,7 @@ paths: application/json: schema: type: array - items: *655 + items: *654 examples: default: value: @@ -103903,7 +106552,7 @@ paths: application/json: schema: type: array - items: &656 + items: &655 title: GPG Key description: A unique encryption key type: object @@ -104048,7 +106697,7 @@ paths: - subkeys - revoked examples: - default: &684 + default: &683 value: - id: 3 name: Octocat's GPG Key @@ -104133,9 +106782,9 @@ paths: description: Response content: application/json: - schema: *656 + schema: *655 examples: - default: &657 + default: &656 value: id: 3 name: Octocat's GPG Key @@ -104192,7 +106841,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &658 + - &657 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -104204,9 +106853,9 @@ paths: description: Response content: application/json: - schema: *656 + schema: *655 examples: - default: *657 + default: *656 '404': *6 '304': *35 '403': *27 @@ -104229,7 +106878,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *658 + - *657 responses: '204': description: Response @@ -104422,7 +107071,7 @@ paths: allOf: - *77 examples: - default: *145 + default: *144 headers: Link: *65 '404': *6 @@ -104448,7 +107097,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *142 + - *141 responses: '204': description: Response @@ -104474,7 +107123,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *142 + - *141 responses: '204': description: Response @@ -104508,12 +107157,12 @@ paths: application/json: schema: anyOf: - - *222 + - *221 - type: object properties: {} additionalProperties: false examples: - default: *223 + default: *222 '204': description: Response when there are no restrictions x-github: @@ -104537,7 +107186,7 @@ paths: required: true content: application/json: - schema: *517 + schema: *516 examples: default: value: @@ -104548,7 +107197,7 @@ paths: description: Response content: application/json: - schema: *222 + schema: *221 examples: default: value: @@ -104629,7 +107278,7 @@ paths: - closed - all default: open - - *233 + - *232 - name: sort description: What to sort results by. in: query @@ -104654,7 +107303,7 @@ paths: type: array items: *81 examples: - default: *234 + default: *233 headers: Link: *65 '404': *6 @@ -104687,7 +107336,7 @@ paths: application/json: schema: type: array - items: &659 + items: &658 title: Key description: Key type: object @@ -104790,9 +107439,9 @@ paths: description: Response content: application/json: - schema: *659 + schema: *658 examples: - default: &660 + default: &659 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -104825,15 +107474,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *547 + - *546 responses: '200': description: Response content: application/json: - schema: *659 + schema: *658 examples: - default: *660 + default: *659 '404': *6 '304': *35 '403': *27 @@ -104856,7 +107505,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *547 + - *546 responses: '204': description: Response @@ -104889,7 +107538,7 @@ paths: application/json: schema: type: array - items: &661 + items: &660 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -104968,7 +107617,7 @@ paths: - account - plan examples: - default: &662 + default: &661 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -105030,9 +107679,9 @@ paths: application/json: schema: type: array - items: *661 + items: *660 examples: - default: *662 + default: *661 headers: Link: *65 '304': *35 @@ -105072,7 +107721,7 @@ paths: application/json: schema: type: array - items: *239 + items: *238 examples: default: value: @@ -105186,7 +107835,7 @@ paths: description: Response content: application/json: - schema: *239 + schema: *238 examples: default: value: @@ -105273,7 +107922,7 @@ paths: description: Response content: application/json: - schema: *239 + schema: *238 examples: default: value: @@ -105345,7 +107994,7 @@ paths: application/json: schema: type: array - items: *241 + items: *240 examples: default: value: @@ -105607,7 +108256,7 @@ paths: description: Response content: application/json: - schema: *241 + schema: *240 examples: default: value: @@ -105787,7 +108436,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *242 + - *241 - name: exclude in: query required: false @@ -105800,7 +108449,7 @@ paths: description: Response content: application/json: - schema: *241 + schema: *240 examples: default: value: @@ -105994,7 +108643,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *242 + - *241 responses: '302': description: Response @@ -106020,7 +108669,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *242 + - *241 responses: '204': description: Response @@ -106049,8 +108698,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *242 - - *663 + - *241 + - *662 responses: '204': description: Response @@ -106074,7 +108723,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *242 + - *241 - *17 - *19 responses: @@ -106163,7 +108812,7 @@ paths: - docker - nuget - container - - *664 + - *663 - *19 - *17 responses: @@ -106173,10 +108822,10 @@ paths: application/json: schema: type: array - items: *247 + items: *246 examples: - default: *665 - '400': *666 + default: *664 + '400': *665 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106196,16 +108845,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: + - *248 - *249 - - *250 responses: '200': description: Response content: application/json: - schema: *247 + schema: *246 examples: - default: &685 + default: &684 value: id: 40201 name: octo-name @@ -106318,8 +108967,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: + - *248 - *249 - - *250 responses: '204': description: Response @@ -106349,8 +108998,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: + - *248 - *249 - - *250 - name: token description: package token schema: @@ -106382,8 +109031,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: + - *248 - *249 - - *250 - *19 - *17 - name: state @@ -106403,7 +109052,7 @@ paths: application/json: schema: type: array - items: *251 + items: *250 examples: default: value: @@ -106452,15 +109101,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: + - *248 - *249 - - *250 - - *252 + - *251 responses: '200': description: Response content: application/json: - schema: *251 + schema: *250 examples: default: value: @@ -106496,9 +109145,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: + - *248 - *249 - - *250 - - *252 + - *251 responses: '204': description: Response @@ -106528,9 +109177,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: + - *248 - *249 - - *250 - - *252 + - *251 responses: '204': description: Response @@ -106567,9 +109216,9 @@ paths: application/json: schema: type: array - items: *655 + items: *654 examples: - default: *667 + default: *666 headers: Link: *65 '304': *35 @@ -106682,7 +109331,7 @@ paths: type: array items: *77 examples: - default: &674 + default: &673 summary: Default response value: - id: 1296269 @@ -107000,9 +109649,9 @@ paths: description: Response content: application/json: - schema: *328 + schema: *327 examples: - default: *330 + default: *329 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -107041,9 +109690,9 @@ paths: application/json: schema: type: array - items: *519 + items: *518 examples: - default: *668 + default: *667 headers: Link: *65 '304': *35 @@ -107066,7 +109715,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *226 + - *225 responses: '204': description: Response @@ -107090,7 +109739,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *226 + - *225 responses: '204': description: Response @@ -107123,7 +109772,7 @@ paths: application/json: schema: type: array - items: &669 + items: &668 title: Social account description: Social media account type: object @@ -107140,7 +109789,7 @@ paths: - provider - url examples: - default: &670 + default: &669 value: - provider: twitter url: https://twitter.com/github @@ -107203,9 +109852,9 @@ paths: application/json: schema: type: array - items: *669 + items: *668 examples: - default: *670 + default: *669 '422': *15 '304': *35 '404': *6 @@ -107293,7 +109942,7 @@ paths: application/json: schema: type: array - items: &671 + items: &670 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -107313,7 +109962,7 @@ paths: - title - created_at examples: - default: &703 + default: &702 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -107378,9 +110027,9 @@ paths: description: Response content: application/json: - schema: *671 + schema: *670 examples: - default: &672 + default: &671 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -107410,7 +110059,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: - - &673 + - &672 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -107422,9 +110071,9 @@ paths: description: Response content: application/json: - schema: *671 + schema: *670 examples: - default: *672 + default: *671 '404': *6 '304': *35 '403': *27 @@ -107447,7 +110096,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: - - *673 + - *672 responses: '204': description: Response @@ -107476,7 +110125,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &704 + - &703 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 @@ -107501,11 +110150,11 @@ paths: type: array items: *77 examples: - default-response: *674 + default-response: *673 application/vnd.github.v3.star+json: schema: type: array - items: &705 + items: &704 title: Starred Repository description: Starred Repository type: object @@ -107661,8 +110310,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: + - *324 - *325 - - *326 responses: '204': description: Response if this repository is starred by you @@ -107690,8 +110339,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -107715,8 +110364,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: + - *324 - *325 - - *326 responses: '204': description: Response @@ -107749,9 +110398,9 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: - default: *260 + default: *259 headers: Link: *65 '304': *35 @@ -107788,7 +110437,7 @@ paths: application/json: schema: type: array - items: *321 + items: *320 examples: default: value: @@ -107874,10 +110523,10 @@ paths: application/json: schema: oneOf: - - *650 - - *675 + - *649 + - *674 examples: - default-response: &679 + default-response: &678 summary: Default response value: login: octocat @@ -107912,7 +110561,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &680 + response-with-git-hub-plan-information: &679 summary: Response with GitHub plan information value: login: octocat @@ -107969,14 +110618,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &677 + - &676 name: user_id description: The unique identifier of the user. in: path required: true schema: type: string - - *265 + - *264 requestBody: required: true description: Details of the draft item to create in the project. @@ -108010,9 +110659,9 @@ paths: description: Response content: application/json: - schema: *270 + schema: *269 examples: - draft_issue: *271 + draft_issue: *270 '304': *35 '403': *27 '401': *23 @@ -108035,7 +110684,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *676 + - *675 - *17 responses: '200': @@ -108070,8 +110719,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *677 - - *265 + - *676 + - *264 requestBody: required: true content: @@ -108145,17 +110794,17 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *678 + schema: *677 examples: table_view: summary: Response for creating a table view - value: *275 + value: *274 board_view: summary: Response for creating a board view with filter - value: *275 + value: *274 roadmap_view: summary: Response for creating a roadmap view - value: *275 + value: *274 '304': *35 '403': *27 '401': *23 @@ -108197,11 +110846,11 @@ paths: application/json: schema: oneOf: - - *650 - - *675 + - *649 + - *674 examples: - default-response: *679 - response-with-git-hub-plan-information: *680 + default-response: *678 + response-with-git-hub-plan-information: *679 '404': *6 x-github: githubCloudOnly: false @@ -108251,8 +110900,8 @@ paths: required: - subject_digests examples: - default: *681 - withPredicateType: *682 + default: *680 + withPredicateType: *681 responses: '200': description: Response @@ -108292,7 +110941,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *683 + default: *682 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108481,12 +111130,12 @@ paths: initiator: type: string examples: - default: *386 + default: *385 '201': description: Response content: application/json: - schema: *162 + schema: *161 examples: default: value: @@ -108520,9 +111169,9 @@ paths: application/json: schema: type: array - items: *247 + items: *246 examples: - default: *665 + default: *664 '403': *27 '401': *23 x-github: @@ -108906,9 +111555,9 @@ paths: application/json: schema: type: array - items: *656 + items: *655 examples: - default: *684 + default: *683 headers: Link: *65 x-github: @@ -109012,7 +111661,7 @@ paths: application/json: schema: *20 examples: - default: *516 + default: *515 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -109137,7 +111786,7 @@ paths: - docker - nuget - container - - *664 + - *663 - *69 - *19 - *17 @@ -109148,12 +111797,12 @@ paths: application/json: schema: type: array - items: *247 + items: *246 examples: - default: *665 + default: *664 '403': *27 '401': *23 - '400': *666 + '400': *665 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -109173,17 +111822,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: + - *248 - *249 - - *250 - *69 responses: '200': description: Response content: application/json: - schema: *247 + schema: *246 examples: - default: *685 + default: *684 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -109204,8 +111853,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: + - *248 - *249 - - *250 - *69 responses: '204': @@ -109238,8 +111887,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: + - *248 - *249 - - *250 - *69 - name: token description: package token @@ -109272,8 +111921,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: + - *248 - *249 - - *250 - *69 responses: '200': @@ -109282,7 +111931,7 @@ paths: application/json: schema: type: array - items: *251 + items: *250 examples: default: value: @@ -109340,16 +111989,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: + - *248 - *249 - - *250 - - *252 + - *251 - *69 responses: '200': description: Response content: application/json: - schema: *251 + schema: *250 examples: default: value: @@ -109384,10 +112033,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: + - *248 - *249 - - *250 - *69 - - *252 + - *251 responses: '204': description: Response @@ -109419,10 +112068,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: + - *248 - *249 - - *250 - *69 - - *252 + - *251 responses: '204': description: Response @@ -109463,9 +112112,9 @@ paths: application/json: schema: type: array - items: *263 + items: *262 examples: - default: *264 + default: *263 headers: Link: *65 '304': *35 @@ -109487,16 +112136,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *265 + - *264 - *69 responses: '200': description: Response content: application/json: - schema: *263 + schema: *262 examples: - default: *264 + default: *263 headers: Link: *65 '304': *35 @@ -109518,7 +112167,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *265 + - *264 - *69 - *17 - *45 @@ -109530,9 +112179,9 @@ paths: application/json: schema: type: array - items: *268 + items: *267 examples: - default: *686 + default: *685 headers: Link: *65 '304': *35 @@ -109554,7 +112203,7 @@ paths: url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project parameters: - *69 - - *265 + - *264 requestBody: required: true content: @@ -109592,7 +112241,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *687 + items: *686 required: - name - data_type @@ -109608,7 +112257,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *688 + iteration_configuration: *687 required: - name - data_type @@ -109630,20 +112279,20 @@ paths: value: name: Due date data_type: date - single_select_field: *689 - iteration_field: *690 + single_select_field: *688 + iteration_field: *689 responses: '201': description: Response content: application/json: - schema: *268 + schema: *267 examples: - text_field: *691 - number_field: *692 - date_field: *693 - single_select_field: *694 - iteration_field: *695 + text_field: *690 + number_field: *691 + date_field: *692 + single_select_field: *693 + iteration_field: *694 '304': *35 '403': *27 '401': *23 @@ -109664,17 +112313,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *265 - - *696 + - *264 + - *695 - *69 responses: '200': description: Response content: application/json: - schema: *268 + schema: *267 examples: - default: *697 + default: *696 headers: Link: *65 '304': *35 @@ -109697,7 +112346,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *265 + - *264 - *69 - *45 - *46 @@ -109730,9 +112379,9 @@ paths: application/json: schema: type: array - items: *272 + items: *271 examples: - default: *273 + default: *272 headers: Link: *65 '304': *35 @@ -109754,7 +112403,7 @@ paths: url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - *69 - - *265 + - *264 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -109824,22 +112473,22 @@ paths: description: Response content: application/json: - schema: *270 + schema: *269 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *271 + value: *270 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *271 + value: *270 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *271 + value: *270 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *271 + value: *270 '304': *35 '403': *27 '401': *23 @@ -109859,9 +112508,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *265 + - *264 - *69 - - *274 + - *273 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -109881,9 +112530,9 @@ paths: description: Response content: application/json: - schema: *272 + schema: *271 examples: - default: *273 + default: *272 headers: Link: *65 '304': *35 @@ -109904,9 +112553,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *265 + - *264 - *69 - - *274 + - *273 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -109979,13 +112628,13 @@ paths: description: Response content: application/json: - schema: *272 + schema: *271 examples: - text_field: *273 - number_field: *273 - date_field: *273 - single_select_field: *273 - iteration_field: *273 + text_field: *272 + number_field: *272 + date_field: *272 + single_select_field: *272 + iteration_field: *272 '401': *23 '403': *27 '404': *6 @@ -110005,9 +112654,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *265 + - *264 - *69 - - *274 + - *273 responses: '204': description: Response @@ -110029,9 +112678,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-project-view parameters: - - *265 + - *264 - *69 - - *698 + - *697 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -110057,9 +112706,9 @@ paths: application/json: schema: type: array - items: *272 + items: *271 examples: - default: *273 + default: *272 headers: Link: *65 '304': *35 @@ -110278,9 +112927,9 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: - default: *260 + default: *259 headers: Link: *65 x-github: @@ -110306,7 +112955,7 @@ paths: - *115 - *117 - *116 - - *699 + - *698 - *118 responses: '200': @@ -110437,7 +113086,7 @@ paths: parameters: - *69 - *115 - - *700 + - *699 - *116 responses: '200': @@ -110536,9 +113185,9 @@ paths: - *115 - *117 - *116 - - *701 + - *700 - *118 - - *702 + - *701 responses: '200': description: Response when getting a billing usage summary @@ -110672,9 +113321,9 @@ paths: application/json: schema: type: array - items: *669 + items: *668 examples: - default: *670 + default: *669 headers: Link: *65 x-github: @@ -110704,9 +113353,9 @@ paths: application/json: schema: type: array - items: *671 + items: *670 examples: - default: *703 + default: *702 headers: Link: *65 x-github: @@ -110731,7 +113380,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *69 - - *704 + - *703 - *59 - *17 - *19 @@ -110743,11 +113392,11 @@ paths: schema: anyOf: - type: array - items: *705 + items: *704 - type: array items: *77 examples: - default-response: *674 + default-response: *673 headers: Link: *65 x-github: @@ -110776,9 +113425,9 @@ paths: application/json: schema: type: array - items: *153 + items: *152 examples: - default: *260 + default: *259 headers: Link: *65 x-github: @@ -110907,7 +113556,7 @@ webhooks: type: string enum: - disabled - enterprise: &706 + enterprise: &705 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -110976,7 +113625,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &707 + installation: &706 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -110997,7 +113646,7 @@ webhooks: required: - id - node_id - organization: &708 + organization: &707 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -111070,7 +113719,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &709 + repository: &708 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -111985,10 +114634,10 @@ webhooks: type: string enum: - enabled - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -112064,11 +114713,11 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - rule: &710 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + rule: &709 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) @@ -112291,11 +114940,11 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - rule: *710 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + rule: *709 sender: *4 required: - action @@ -112483,11 +115132,11 @@ webhooks: - everyone required: - from - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - rule: *710 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + rule: *709 sender: *4 required: - action @@ -112571,7 +115220,7 @@ webhooks: type: string enum: - completed - check_run: &712 + check_run: &711 title: CheckRun description: A check performed on the code of a given code change type: object @@ -112637,7 +115286,7 @@ webhooks: pull_requests: type: array items: *84 - repository: *153 + repository: *152 status: type: string enum: @@ -112681,7 +115330,7 @@ webhooks: - examples: - neutral - deployment: *711 + deployment: *710 details_url: type: string examples: @@ -112779,10 +115428,10 @@ webhooks: - output - app - pull_requests - installation: *707 - enterprise: *706 - organization: *708 - repository: *709 + installation: *706 + enterprise: *705 + organization: *707 + repository: *708 sender: *4 required: - check_run @@ -113173,11 +115822,11 @@ webhooks: type: string enum: - created - check_run: *712 - installation: *707 - enterprise: *706 - organization: *708 - repository: *709 + check_run: *711 + installation: *706 + enterprise: *705 + organization: *707 + repository: *708 sender: *4 required: - check_run @@ -113571,11 +116220,11 @@ webhooks: type: string enum: - requested_action - check_run: *712 - installation: *707 - enterprise: *706 - organization: *708 - repository: *709 + check_run: *711 + installation: *706 + enterprise: *705 + organization: *707 + repository: *708 requested_action: description: The action requested by the user. type: object @@ -113978,11 +116627,11 @@ webhooks: type: string enum: - rerequested - check_run: *712 - installation: *707 - enterprise: *706 - organization: *708 - repository: *709 + check_run: *711 + installation: *706 + enterprise: *705 + organization: *707 + repository: *708 sender: *4 required: - check_run @@ -114967,10 +117616,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -115674,10 +118323,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -116375,10 +119024,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -116547,7 +119196,7 @@ webhooks: required: - login - id - dismissed_comment: *417 + dismissed_comment: *416 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -116699,20 +119348,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &713 + commit_oid: &712 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: *706 - installation: *707 - organization: *708 - ref: &714 + enterprise: *705 + installation: *706 + organization: *707 + ref: &713 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: *709 + repository: *708 sender: *4 required: - action @@ -116879,7 +119528,7 @@ webhooks: required: - login - id - dismissed_comment: *417 + dismissed_comment: *416 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -117120,12 +119769,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *713 - enterprise: *706 - installation: *707 - organization: *708 - ref: *714 - repository: *709 + commit_oid: *712 + enterprise: *705 + installation: *706 + organization: *707 + ref: *713 + repository: *708 sender: *4 required: - action @@ -117223,7 +119872,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *417 + dismissed_comment: *416 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -117408,12 +120057,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *713 - enterprise: *706 - installation: *707 - organization: *708 - ref: *714 - repository: *709 + commit_oid: *712 + enterprise: *705 + installation: *706 + organization: *707 + ref: *713 + repository: *708 sender: *4 required: - action @@ -117582,7 +120231,7 @@ webhooks: required: - login - id - dismissed_comment: *417 + dismissed_comment: *416 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -117759,12 +120408,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *713 - enterprise: *706 - installation: *707 - organization: *708 - ref: *714 - repository: *709 + commit_oid: *712 + enterprise: *705 + installation: *706 + organization: *707 + ref: *713 + repository: *708 sender: *4 required: - action @@ -117865,7 +120514,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *417 + dismissed_comment: *416 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -118054,9 +120703,9 @@ webhooks: type: - string - 'null' - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -118064,7 +120713,7 @@ webhooks: type: - string - 'null' - repository: *709 + repository: *708 sender: *4 required: - action @@ -118163,7 +120812,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *417 + dismissed_comment: *416 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -118310,12 +120959,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *713 - enterprise: *706 - installation: *707 - organization: *708 - ref: *714 - repository: *709 + commit_oid: *712 + enterprise: *705 + installation: *706 + organization: *707 + ref: *713 + repository: *708 sender: *4 required: - action @@ -118484,7 +121133,7 @@ webhooks: required: - login - id - dismissed_comment: *417 + dismissed_comment: *416 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -118636,10 +121285,10 @@ webhooks: - dismissed_reason - rule - tool - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -118899,10 +121548,10 @@ webhooks: - updated_at - author_association - body - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -118983,18 +121632,18 @@ webhooks: type: - string - 'null' - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *708 - pusher_type: &715 + organization: *707 + pusher_type: &714 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &716 + ref: &715 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -119004,7 +121653,7 @@ webhooks: enum: - tag - branch - repository: *709 + repository: *708 sender: *4 required: - ref @@ -119086,10 +121735,10 @@ webhooks: type: string enum: - created - definition: *276 - enterprise: *706 - installation: *707 - organization: *708 + definition: *275 + enterprise: *705 + installation: *706 + organization: *707 sender: *4 required: - action @@ -119174,9 +121823,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 sender: *4 required: - action @@ -119253,10 +121902,10 @@ webhooks: type: string enum: - promote_to_enterprise - definition: *276 - enterprise: *706 - installation: *707 - organization: *708 + definition: *275 + enterprise: *705 + installation: *706 + organization: *707 sender: *4 required: - action @@ -119333,10 +121982,10 @@ webhooks: type: string enum: - updated - definition: *276 - enterprise: *706 - installation: *707 - organization: *708 + definition: *275 + enterprise: *705 + installation: *706 + organization: *707 sender: *4 required: - action @@ -119413,19 +122062,19 @@ webhooks: type: string enum: - updated - enterprise: *706 - installation: *707 - repository: *709 - organization: *708 + enterprise: *705 + installation: *706 + repository: *708 + organization: *707 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *280 + items: *279 old_property_values: type: array description: The old custom property values for the repository. - items: *280 + items: *279 required: - action - repository @@ -119501,18 +122150,18 @@ webhooks: title: delete event type: object properties: - enterprise: *706 - installation: *707 - organization: *708 - pusher_type: *715 - ref: *716 + enterprise: *705 + installation: *706 + organization: *707 + pusher_type: *714 + ref: *715 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *709 + repository: *708 sender: *4 required: - ref @@ -119592,11 +122241,11 @@ webhooks: type: string enum: - assignees_changed - alert: *475 - installation: *707 - organization: *708 - enterprise: *706 - repository: *709 + alert: *474 + installation: *706 + organization: *707 + enterprise: *705 + repository: *708 sender: *4 required: - action @@ -119676,11 +122325,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *475 - installation: *707 - organization: *708 - enterprise: *706 - repository: *709 + alert: *474 + installation: *706 + organization: *707 + enterprise: *705 + repository: *708 sender: *4 required: - action @@ -119761,11 +122410,11 @@ webhooks: type: string enum: - auto_reopened - alert: *475 - installation: *707 - organization: *708 - enterprise: *706 - repository: *709 + alert: *474 + installation: *706 + organization: *707 + enterprise: *705 + repository: *708 sender: *4 required: - action @@ -119846,11 +122495,11 @@ webhooks: type: string enum: - created - alert: *475 - installation: *707 - organization: *708 - enterprise: *706 - repository: *709 + alert: *474 + installation: *706 + organization: *707 + enterprise: *705 + repository: *708 sender: *4 required: - action @@ -119929,11 +122578,11 @@ webhooks: type: string enum: - dismissed - alert: *475 - installation: *707 - organization: *708 - enterprise: *706 - repository: *709 + alert: *474 + installation: *706 + organization: *707 + enterprise: *705 + repository: *708 sender: *4 required: - action @@ -120012,11 +122661,11 @@ webhooks: type: string enum: - fixed - alert: *475 - installation: *707 - organization: *708 - enterprise: *706 - repository: *709 + alert: *474 + installation: *706 + organization: *707 + enterprise: *705 + repository: *708 sender: *4 required: - action @@ -120096,11 +122745,11 @@ webhooks: type: string enum: - reintroduced - alert: *475 - installation: *707 - organization: *708 - enterprise: *706 - repository: *709 + alert: *474 + installation: *706 + organization: *707 + enterprise: *705 + repository: *708 sender: *4 required: - action @@ -120179,11 +122828,11 @@ webhooks: type: string enum: - reopened - alert: *475 - installation: *707 - organization: *708 - enterprise: *706 - repository: *709 + alert: *474 + installation: *706 + organization: *707 + enterprise: *705 + repository: *708 sender: *4 required: - action @@ -120260,9 +122909,9 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - key: &717 + enterprise: *705 + installation: *706 + key: &716 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -120300,8 +122949,8 @@ webhooks: - verified - created_at - read_only - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -120378,11 +123027,11 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - key: *717 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + key: *716 + organization: *707 + repository: *708 sender: *4 required: - action @@ -120949,12 +123598,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - workflow: &721 + workflow: &720 title: Workflow type: - object @@ -121705,13 +124354,13 @@ webhooks: deployment: anyOf: - type: 'null' - - *481 + - *480 pull_requests: type: array - items: *565 - repository: *709 - organization: *708 - installation: *707 + items: *564 + repository: *708 + organization: *707 + installation: *706 sender: *4 responses: '200': @@ -121782,7 +124431,7 @@ webhooks: type: string enum: - approved - approver: &718 + approver: &717 type: object properties: avatar_url: @@ -121825,11 +124474,11 @@ webhooks: type: string comment: type: string - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - reviewers: &719 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + reviewers: &718 type: array items: type: object @@ -121910,7 +124559,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &720 + workflow_job_run: &719 type: object properties: conclusion: @@ -122656,18 +125305,18 @@ webhooks: type: string enum: - rejected - approver: *718 + approver: *717 comment: type: string - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - reviewers: *719 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + reviewers: *718 sender: *4 since: type: string - workflow_job_run: *720 + workflow_job_run: *719 workflow_job_runs: type: array items: @@ -123384,13 +126033,13 @@ webhooks: type: string enum: - requested - enterprise: *706 + enterprise: *705 environment: type: string - installation: *707 - organization: *708 - repository: *709 - requestor: &726 + installation: *706 + organization: *707 + repository: *708 + requestor: &725 title: User type: - object @@ -125323,12 +127972,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - workflow: *721 + workflow: *720 workflow_run: title: Deployment Workflow Run type: @@ -126019,7 +128668,7 @@ webhooks: type: string enum: - answered - answer: &724 + answer: &723 type: object properties: author_association: @@ -126179,11 +128828,11 @@ webhooks: - created_at - updated_at - body - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -126310,11 +128959,11 @@ webhooks: - from required: - category - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -126397,11 +129046,11 @@ webhooks: type: string enum: - closed - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -126483,7 +129132,7 @@ webhooks: type: string enum: - created - comment: &723 + comment: &722 type: object properties: author_association: @@ -126643,11 +129292,11 @@ webhooks: - updated_at - body - reactions - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -126730,12 +129379,12 @@ webhooks: type: string enum: - deleted - comment: *723 - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + comment: *722 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -126830,12 +129479,12 @@ webhooks: - from required: - body - comment: *723 - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + comment: *722 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -126919,11 +129568,11 @@ webhooks: type: string enum: - created - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127005,11 +129654,11 @@ webhooks: type: string enum: - deleted - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127109,11 +129758,11 @@ webhooks: type: string required: - from - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127195,10 +129844,10 @@ webhooks: type: string enum: - labeled - discussion: *722 - enterprise: *706 - installation: *707 - label: &725 + discussion: *721 + enterprise: *705 + installation: *706 + label: &724 title: Label type: object properties: @@ -127231,8 +129880,8 @@ webhooks: - color - default - description - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127315,11 +129964,11 @@ webhooks: type: string enum: - locked - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127401,11 +130050,11 @@ webhooks: type: string enum: - pinned - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127487,11 +130136,11 @@ webhooks: type: string enum: - reopened - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127576,16 +130225,16 @@ webhooks: changes: type: object properties: - new_discussion: *722 - new_repository: *709 + new_discussion: *721 + new_repository: *708 required: - new_discussion - new_repository - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127668,10 +130317,10 @@ webhooks: type: string enum: - unanswered - discussion: *722 - old_answer: *724 - organization: *708 - repository: *709 + discussion: *721 + old_answer: *723 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127753,12 +130402,12 @@ webhooks: type: string enum: - unlabeled - discussion: *722 - enterprise: *706 - installation: *707 - label: *725 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + label: *724 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127841,11 +130490,11 @@ webhooks: type: string enum: - unlocked - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -127927,11 +130576,11 @@ webhooks: type: string enum: - unpinned - discussion: *722 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + discussion: *721 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -128004,7 +130653,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *706 + enterprise: *705 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -128682,9 +131331,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - forkee @@ -128830,9 +131479,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 pages: description: The pages that were updated. type: array @@ -128870,7 +131519,7 @@ webhooks: - action - sha - html_url - repository: *709 + repository: *708 sender: *4 required: - pages @@ -128946,10 +131595,10 @@ webhooks: type: string enum: - created - enterprise: *706 + enterprise: *705 installation: *20 - organization: *708 - repositories: &727 + organization: *707 + repositories: &726 description: An array of repository objects that the installation can access. type: array @@ -128975,8 +131624,8 @@ webhooks: - name - full_name - private - repository: *709 - requester: *726 + repository: *708 + requester: *725 sender: *4 required: - action @@ -129051,11 +131700,11 @@ webhooks: type: string enum: - deleted - enterprise: *706 + enterprise: *705 installation: *20 - organization: *708 - repositories: *727 - repository: *709 + organization: *707 + repositories: *726 + repository: *708 requester: type: - 'null' @@ -129132,11 +131781,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *706 + enterprise: *705 installation: *20 - organization: *708 - repositories: *727 - repository: *709 + organization: *707 + repositories: *726 + repository: *708 requester: type: - 'null' @@ -129213,10 +131862,10 @@ webhooks: type: string enum: - added - enterprise: *706 + enterprise: *705 installation: *20 - organization: *708 - repositories_added: &728 + organization: *707 + repositories_added: &727 description: An array of repository objects, which were added to the installation. type: array @@ -129262,15 +131911,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *709 - repository_selection: &729 + repository: *708 + repository_selection: &728 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *726 + requester: *725 sender: *4 required: - action @@ -129349,10 +131998,10 @@ webhooks: type: string enum: - removed - enterprise: *706 + enterprise: *705 installation: *20 - organization: *708 - repositories_added: *728 + organization: *707 + repositories_added: *727 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -129379,9 +132028,9 @@ webhooks: - name - full_name - private - repository: *709 - repository_selection: *729 - requester: *726 + repository: *708 + repository_selection: *728 + requester: *725 sender: *4 required: - action @@ -129460,11 +132109,11 @@ webhooks: type: string enum: - suspend - enterprise: *706 + enterprise: *705 installation: *20 - organization: *708 - repositories: *727 - repository: *709 + organization: *707 + repositories: *726 + repository: *708 requester: type: - 'null' @@ -129646,10 +132295,10 @@ webhooks: type: string required: - from - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 target_type: type: string @@ -129728,11 +132377,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *706 + enterprise: *705 installation: *20 - organization: *708 - repositories: *727 - repository: *709 + organization: *707 + repositories: *726 + repository: *708 requester: type: - 'null' @@ -129898,7 +132547,7 @@ webhooks: pin: anyOf: - type: 'null' - - *544 + - *543 user: title: User type: @@ -129984,8 +132633,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -130797,8 +133446,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130815,7 +133464,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -131159,8 +133808,8 @@ webhooks: - state - locked - assignee - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -131240,7 +133889,7 @@ webhooks: type: string enum: - deleted - comment: &730 + comment: &729 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -131397,7 +134046,7 @@ webhooks: pin: anyOf: - type: 'null' - - *544 + - *543 required: - url - html_url @@ -131411,8 +134060,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -132220,8 +134869,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132238,7 +134887,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -132584,8 +135233,8 @@ webhooks: - state - locked - assignee - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -132665,7 +135314,7 @@ webhooks: type: string enum: - edited - changes: &754 + changes: &753 description: The changes to the comment. type: object properties: @@ -132677,9 +135326,9 @@ webhooks: type: string required: - from - comment: *730 - enterprise: *706 - installation: *707 + comment: *729 + enterprise: *705 + installation: *706 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -133490,8 +136139,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133508,7 +136157,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -133852,8 +136501,8 @@ webhooks: - state - locked - assignee - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -133934,9 +136583,9 @@ webhooks: type: string enum: - pinned - comment: *730 - enterprise: *706 - installation: *707 + comment: *729 + enterprise: *705 + installation: *706 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -134749,8 +137398,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134767,7 +137416,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -135113,8 +137762,8 @@ webhooks: - state - locked - assignee - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -135194,9 +137843,9 @@ webhooks: type: string enum: - unpinned - comment: *730 - enterprise: *706 - installation: *707 + comment: *729 + enterprise: *705 + installation: *706 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -136009,8 +138658,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136027,7 +138676,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -136373,8 +139022,8 @@ webhooks: - state - locked - assignee - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -136463,9 +139112,9 @@ webhooks: type: number blocking_issue: *81 blocking_issue_repo: *77 - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -136554,9 +139203,9 @@ webhooks: type: number blocking_issue: *81 blocking_issue_repo: *77 - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -136644,9 +139293,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *81 - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -136735,9 +139384,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *81 - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -136817,10 +139466,10 @@ webhooks: type: string enum: - assigned - assignee: *726 - enterprise: *706 - installation: *707 - issue: &733 + assignee: *725 + enterprise: *705 + installation: *706 + issue: &732 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -137631,11 +140280,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137652,7 +140301,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -137755,8 +140404,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -137836,8 +140485,8 @@ webhooks: type: string enum: - closed - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -138653,11 +141302,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138674,7 +141323,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -138920,8 +141569,8 @@ webhooks: required: - state - closed_at - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -139000,8 +141649,8 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139808,11 +142457,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139829,7 +142478,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -139931,8 +142580,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -140011,8 +142660,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -140842,11 +143491,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140863,7 +143512,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -140944,7 +143593,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &731 + milestone: &730 title: Milestone description: A collection of related issues and pull requests. type: object @@ -141087,8 +143736,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -141187,8 +143836,8 @@ webhooks: type: string required: - from - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141999,11 +144648,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142017,7 +144666,7 @@ webhooks: timeline_url: type: string format: uri - type: *230 + type: *229 title: description: Title of the issue type: string @@ -142123,9 +144772,9 @@ webhooks: - active_lock_reason - body - reactions - label: *725 - organization: *708 - repository: *709 + label: *724 + organization: *707 + repository: *708 sender: *4 required: - action @@ -142205,8 +144854,8 @@ webhooks: type: string enum: - labeled - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -143016,11 +145665,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143034,7 +145683,7 @@ webhooks: timeline_url: type: string format: uri - type: *230 + type: *229 title: description: Title of the issue type: string @@ -143140,9 +145789,9 @@ webhooks: - active_lock_reason - body - reactions - label: *725 - organization: *708 - repository: *709 + label: *724 + organization: *707 + repository: *708 sender: *4 required: - action @@ -143222,8 +145871,8 @@ webhooks: type: string enum: - locked - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144058,11 +146707,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144076,7 +146725,7 @@ webhooks: timeline_url: type: string format: uri - type: *230 + type: *229 title: description: Title of the issue type: string @@ -144159,8 +146808,8 @@ webhooks: format: uri user_view_type: type: string - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -144239,8 +146888,8 @@ webhooks: type: string enum: - milestoned - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -145069,11 +147718,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145090,7 +147739,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -145170,9 +147819,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *731 - organization: *708 - repository: *709 + milestone: *730 + organization: *707 + repository: *708 sender: *4 required: - action @@ -146059,11 +148708,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146163,7 +148812,7 @@ webhooks: required: - login - id - type: *230 + type: *229 required: - id - number @@ -146655,8 +149304,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147463,11 +150112,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147484,7 +150133,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -147590,8 +150239,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -147671,9 +150320,9 @@ webhooks: type: string enum: - pinned - enterprise: *706 - installation: *707 - issue: &732 + enterprise: *705 + installation: *706 + issue: &731 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -148478,11 +151127,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148499,7 +151148,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -148601,8 +151250,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -148681,8 +151330,8 @@ webhooks: type: string enum: - reopened - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -149515,11 +152164,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149616,9 +152265,9 @@ webhooks: format: uri user_view_type: type: string - type: *230 - organization: *708 - repository: *709 + type: *229 + organization: *707 + repository: *708 sender: *4 required: - action @@ -150506,11 +153155,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150527,7 +153176,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -151120,11 +153769,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *706 - installation: *707 - issue: *732 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + issue: *731 + organization: *707 + repository: *708 sender: *4 required: - action @@ -151204,12 +153853,12 @@ webhooks: type: string enum: - typed - enterprise: *706 - installation: *707 - issue: *733 - type: *230 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + issue: *732 + type: *229 + organization: *707 + repository: *708 sender: *4 required: - action @@ -151290,7 +153939,7 @@ webhooks: type: string enum: - unassigned - assignee: &757 + assignee: &756 title: User type: - object @@ -151362,11 +154011,11 @@ webhooks: required: - login - id - enterprise: *706 - installation: *707 - issue: *733 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + issue: *732 + organization: *707 + repository: *708 sender: *4 required: - action @@ -151445,12 +154094,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *706 - installation: *707 - issue: *733 - label: *725 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + issue: *732 + label: *724 + organization: *707 + repository: *708 sender: *4 required: - action @@ -151530,8 +154179,8 @@ webhooks: type: string enum: - unlocked - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -152364,11 +155013,11 @@ webhooks: anyOf: - type: 'null' - *82 - sub_issues_summary: *643 - issue_dependencies_summary: *644 + sub_issues_summary: *642 + issue_dependencies_summary: *643 issue_field_values: type: array - items: *529 + items: *528 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152385,7 +155034,7 @@ webhooks: title: description: Title of the issue type: string - type: *230 + type: *229 updated_at: type: string format: date-time @@ -152465,8 +155114,8 @@ webhooks: format: uri user_view_type: type: string - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -152546,11 +155195,11 @@ webhooks: type: string enum: - unpinned - enterprise: *706 - installation: *707 - issue: *732 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + issue: *731 + organization: *707 + repository: *708 sender: *4 required: - action @@ -152629,12 +155278,12 @@ webhooks: type: string enum: - untyped - enterprise: *706 - installation: *707 - issue: *733 - type: *230 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + issue: *732 + type: *229 + organization: *707 + repository: *708 sender: *4 required: - action @@ -152714,11 +155363,11 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - label: *725 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + label: *724 + organization: *707 + repository: *708 sender: *4 required: - action @@ -152796,11 +155445,11 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - label: *725 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + label: *724 + organization: *707 + repository: *708 sender: *4 required: - action @@ -152910,11 +155559,11 @@ webhooks: type: string required: - from - enterprise: *706 - installation: *707 - label: *725 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + label: *724 + organization: *707 + repository: *708 sender: *4 required: - action @@ -152996,9 +155645,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *706 - installation: *707 - marketplace_purchase: &734 + enterprise: *705 + installation: *706 + marketplace_purchase: &733 title: Marketplace Purchase type: object required: @@ -153086,8 +155735,8 @@ webhooks: type: integer unit_count: type: integer - organization: *708 - previous_marketplace_purchase: &735 + organization: *707 + previous_marketplace_purchase: &734 title: Marketplace Purchase type: object properties: @@ -153171,7 +155820,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *709 + repository: *708 sender: *4 required: - action @@ -153251,10 +155900,10 @@ webhooks: - changed effective_date: type: string - enterprise: *706 - installation: *707 - marketplace_purchase: *734 - organization: *708 + enterprise: *705 + installation: *706 + marketplace_purchase: *733 + organization: *707 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -153342,7 +155991,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *709 + repository: *708 sender: *4 required: - action @@ -153424,10 +156073,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *706 - installation: *707 - marketplace_purchase: *734 - organization: *708 + enterprise: *705 + installation: *706 + marketplace_purchase: *733 + organization: *707 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -153513,7 +156162,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *709 + repository: *708 sender: *4 required: - action @@ -153594,8 +156243,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 marketplace_purchase: title: Marketplace Purchase type: object @@ -153681,9 +156330,9 @@ webhooks: type: integer unit_count: type: integer - organization: *708 - previous_marketplace_purchase: *735 - repository: *709 + organization: *707 + previous_marketplace_purchase: *734 + repository: *708 sender: *4 required: - action @@ -153763,12 +156412,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *706 - installation: *707 - marketplace_purchase: *734 - organization: *708 - previous_marketplace_purchase: *735 - repository: *709 + enterprise: *705 + installation: *706 + marketplace_purchase: *733 + organization: *707 + previous_marketplace_purchase: *734 + repository: *708 sender: *4 required: - action @@ -153870,11 +156519,11 @@ webhooks: type: string required: - to - enterprise: *706 - installation: *707 - member: *726 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + member: *725 + organization: *707 + repository: *708 sender: *4 required: - action @@ -153976,11 +156625,11 @@ webhooks: type: - string - 'null' - enterprise: *706 - installation: *707 - member: *726 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + member: *725 + organization: *707 + repository: *708 sender: *4 required: - action @@ -154059,11 +156708,11 @@ webhooks: type: string enum: - removed - enterprise: *706 - installation: *707 - member: *726 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + member: *725 + organization: *707 + repository: *708 sender: *4 required: - action @@ -154141,11 +156790,11 @@ webhooks: type: string enum: - added - enterprise: *706 - installation: *707 - member: *726 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + member: *725 + organization: *707 + repository: *708 scope: description: The scope of the membership. Currently, can only be `team`. @@ -154223,7 +156872,7 @@ webhooks: required: - login - id - team: &736 + team: &735 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -154453,11 +157102,11 @@ webhooks: type: string enum: - removed - enterprise: *706 - installation: *707 - member: *726 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + member: *725 + organization: *707 + repository: *708 scope: description: The scope of the membership. Currently, can only be `team`. @@ -154536,7 +157185,7 @@ webhooks: required: - login - id - team: *736 + team: *735 required: - action - scope @@ -154618,8 +157267,8 @@ webhooks: type: string enum: - checks_requested - installation: *707 - merge_group: &737 + installation: *706 + merge_group: &736 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -154638,15 +157287,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *406 + head_commit: *405 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -154732,10 +157381,10 @@ webhooks: - merged - invalidated - dequeued - installation: *707 - merge_group: *737 - organization: *708 - repository: *709 + installation: *706 + merge_group: *736 + organization: *707 + repository: *708 sender: *4 required: - action @@ -154808,7 +157457,7 @@ webhooks: type: string enum: - deleted - enterprise: *706 + enterprise: *705 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -154917,12 +157566,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *707 - organization: *708 + installation: *706 + organization: *707 repository: anyOf: - type: 'null' - - *709 + - *708 sender: *4 required: - action @@ -155002,11 +157651,11 @@ webhooks: type: string enum: - closed - enterprise: *706 - installation: *707 - milestone: *731 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + milestone: *730 + organization: *707 + repository: *708 sender: *4 required: - action @@ -155085,9 +157734,9 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - milestone: &738 + enterprise: *705 + installation: *706 + milestone: &737 title: Milestone description: A collection of related issues and pull requests. type: object @@ -155229,8 +157878,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -155309,11 +157958,11 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - milestone: *731 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + milestone: *730 + organization: *707 + repository: *708 sender: *4 required: - action @@ -155423,11 +158072,11 @@ webhooks: type: string required: - from - enterprise: *706 - installation: *707 - milestone: *731 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + milestone: *730 + organization: *707 + repository: *708 sender: *4 required: - action @@ -155507,11 +158156,11 @@ webhooks: type: string enum: - opened - enterprise: *706 - installation: *707 - milestone: *738 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + milestone: *737 + organization: *707 + repository: *708 sender: *4 required: - action @@ -155590,11 +158239,11 @@ webhooks: type: string enum: - blocked - blocked_user: *726 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + blocked_user: *725 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -155673,11 +158322,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *726 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + blocked_user: *725 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -155756,9 +158405,9 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - membership: &739 + enterprise: *705 + installation: *706 + membership: &738 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -155868,8 +158517,8 @@ webhooks: - role - organization_url - user - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 required: - action @@ -155947,11 +158596,11 @@ webhooks: type: string enum: - member_added - enterprise: *706 - installation: *707 - membership: *739 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + membership: *738 + organization: *707 + repository: *708 sender: *4 required: - action @@ -156030,8 +158679,8 @@ webhooks: type: string enum: - member_invited - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -156153,10 +158802,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 - user: *726 + user: *725 required: - action - invitation @@ -156234,11 +158883,11 @@ webhooks: type: string enum: - member_removed - enterprise: *706 - installation: *707 - membership: *739 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + membership: *738 + organization: *707 + repository: *708 sender: *4 required: - action @@ -156325,11 +158974,11 @@ webhooks: properties: from: type: string - enterprise: *706 - installation: *707 - membership: *739 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + membership: *738 + organization: *707 + repository: *708 sender: *4 required: - action @@ -156406,9 +159055,9 @@ webhooks: type: string enum: - published - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 package: description: Information about the package. type: object @@ -156931,7 +159580,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &740 + items: &739 title: Ruby Gems metadata type: object properties: @@ -157028,7 +159677,7 @@ webhooks: - owner - package_version - registry - repository: *709 + repository: *708 sender: *4 required: - action @@ -157104,9 +159753,9 @@ webhooks: type: string enum: - updated - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 package: description: Information about the package. type: object @@ -157468,7 +160117,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *740 + items: *739 source_url: type: string format: uri @@ -157539,7 +160188,7 @@ webhooks: - owner - package_version - registry - repository: *709 + repository: *708 sender: *4 required: - action @@ -157719,12 +160368,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *706 + enterprise: *705 id: type: integer - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - id @@ -157801,7 +160450,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &741 + personal_access_token_request: &740 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -157951,10 +160600,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *706 - organization: *708 + enterprise: *705 + organization: *707 sender: *4 - installation: *707 + installation: *706 required: - action - personal_access_token_request @@ -158031,11 +160680,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *741 - enterprise: *706 - organization: *708 + personal_access_token_request: *740 + enterprise: *705 + organization: *707 sender: *4 - installation: *707 + installation: *706 required: - action - personal_access_token_request @@ -158111,11 +160760,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *741 - enterprise: *706 - organization: *708 + personal_access_token_request: *740 + enterprise: *705 + organization: *707 sender: *4 - installation: *707 + installation: *706 required: - action - personal_access_token_request @@ -158190,11 +160839,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *741 - organization: *708 - enterprise: *706 + personal_access_token_request: *740 + organization: *707 + enterprise: *705 sender: *4 - installation: *707 + installation: *706 required: - action - personal_access_token_request @@ -158299,7 +160948,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *742 + last_response: *741 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -158331,8 +160980,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 zen: description: Random string of GitHub zen. @@ -158577,10 +161226,10 @@ webhooks: - from required: - note - enterprise: *706 - installation: *707 - organization: *708 - project_card: &743 + enterprise: *705 + installation: *706 + organization: *707 + project_card: &742 title: Project Card type: object properties: @@ -158703,7 +161352,7 @@ webhooks: - creator - created_at - updated_at - repository: *709 + repository: *708 sender: *4 required: - action @@ -158784,11 +161433,11 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 - project_card: *743 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + project_card: *742 + repository: *708 sender: *4 required: - action @@ -158868,9 +161517,9 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 project_card: title: Project Card type: object @@ -159000,7 +161649,7 @@ webhooks: repository: anyOf: - type: 'null' - - *709 + - *708 sender: *4 required: - action @@ -159094,11 +161743,11 @@ webhooks: - from required: - note - enterprise: *706 - installation: *707 - organization: *708 - project_card: *743 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + project_card: *742 + repository: *708 sender: *4 required: - action @@ -159192,9 +161841,9 @@ webhooks: - from required: - column_id - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 project_card: allOf: - title: Project Card @@ -159391,7 +162040,7 @@ webhooks: type: string required: - after_id - repository: *709 + repository: *708 sender: *4 required: - action @@ -159471,10 +162120,10 @@ webhooks: type: string enum: - closed - enterprise: *706 - installation: *707 - organization: *708 - project: &745 + enterprise: *705 + installation: *706 + organization: *707 + project: &744 title: Project type: object properties: @@ -159601,7 +162250,7 @@ webhooks: - creator - created_at - updated_at - repository: *709 + repository: *708 sender: *4 required: - action @@ -159681,10 +162330,10 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 - project_column: &744 + enterprise: *705 + installation: *706 + organization: *707 + project_column: &743 title: Project Column type: object properties: @@ -159724,7 +162373,7 @@ webhooks: - name - created_at - updated_at - repository: *709 + repository: *708 sender: *4 required: - action @@ -159803,14 +162452,14 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - organization: *708 - project_column: *744 + enterprise: *705 + installation: *706 + organization: *707 + project_column: *743 repository: anyOf: - type: 'null' - - *709 + - *708 sender: *4 required: - action @@ -159899,11 +162548,11 @@ webhooks: type: string required: - from - enterprise: *706 - installation: *707 - organization: *708 - project_column: *744 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + project_column: *743 + repository: *708 sender: *4 required: - action @@ -159983,11 +162632,11 @@ webhooks: type: string enum: - moved - enterprise: *706 - installation: *707 - organization: *708 - project_column: *744 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + project_column: *743 + repository: *708 sender: *4 required: - action @@ -160067,11 +162716,11 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 - project: *745 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + project: *744 + repository: *708 sender: *4 required: - action @@ -160151,14 +162800,14 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - organization: *708 - project: *745 + enterprise: *705 + installation: *706 + organization: *707 + project: *744 repository: anyOf: - type: 'null' - - *709 + - *708 sender: *4 required: - action @@ -160259,11 +162908,11 @@ webhooks: type: string required: - from - enterprise: *706 - installation: *707 - organization: *708 - project: *745 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + project: *744 + repository: *708 sender: *4 required: - action @@ -160342,11 +162991,11 @@ webhooks: type: string enum: - reopened - enterprise: *706 - installation: *707 - organization: *708 - project: *745 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + project: *744 + repository: *708 sender: *4 required: - action @@ -160427,9 +163076,9 @@ webhooks: type: string enum: - closed - installation: *707 - organization: *708 - projects_v2: *263 + installation: *706 + organization: *707 + projects_v2: *262 sender: *4 required: - action @@ -160510,9 +163159,9 @@ webhooks: type: string enum: - created - installation: *707 - organization: *708 - projects_v2: *263 + installation: *706 + organization: *707 + projects_v2: *262 sender: *4 required: - action @@ -160593,9 +163242,9 @@ webhooks: type: string enum: - deleted - installation: *707 - organization: *708 - projects_v2: *263 + installation: *706 + organization: *707 + projects_v2: *262 sender: *4 required: - action @@ -160716,9 +163365,9 @@ webhooks: type: string to: type: string - installation: *707 - organization: *708 - projects_v2: *263 + installation: *706 + organization: *707 + projects_v2: *262 sender: *4 required: - action @@ -160801,7 +163450,7 @@ webhooks: type: string enum: - archived - changes: &749 + changes: &748 type: object properties: archived_at: @@ -160817,9 +163466,9 @@ webhooks: - string - 'null' format: date-time - installation: *707 - organization: *708 - projects_v2_item: &746 + installation: *706 + organization: *707 + projects_v2_item: &745 title: Projects v2 Item description: An item belonging to a project type: object @@ -160837,7 +163486,7 @@ webhooks: type: string description: The node ID of the content represented by this item. - content_type: *269 + content_type: *268 creator: *4 created_at: type: string @@ -160959,9 +163608,9 @@ webhooks: - 'null' to: type: string - installation: *707 - organization: *708 - projects_v2_item: *746 + installation: *706 + organization: *707 + projects_v2_item: *745 sender: *4 required: - action @@ -161043,9 +163692,9 @@ webhooks: type: string enum: - created - installation: *707 - organization: *708 - projects_v2_item: *746 + installation: *706 + organization: *707 + projects_v2_item: *745 sender: *4 required: - action @@ -161126,9 +163775,9 @@ webhooks: type: string enum: - deleted - installation: *707 - organization: *708 - projects_v2_item: *746 + installation: *706 + organization: *707 + projects_v2_item: *745 sender: *4 required: - action @@ -161233,7 +163882,7 @@ webhooks: oneOf: - type: string - type: integer - - &747 + - &746 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -161257,7 +163906,7 @@ webhooks: required: - id - name - - &748 + - &747 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -161297,8 +163946,8 @@ webhooks: oneOf: - type: string - type: integer + - *746 - *747 - - *748 type: - 'null' - string @@ -161321,9 +163970,9 @@ webhooks: - 'null' required: - body - installation: *707 - organization: *708 - projects_v2_item: *746 + installation: *706 + organization: *707 + projects_v2_item: *745 sender: *4 required: - action @@ -161420,9 +164069,9 @@ webhooks: type: - string - 'null' - installation: *707 - organization: *708 - projects_v2_item: *746 + installation: *706 + organization: *707 + projects_v2_item: *745 sender: *4 required: - action @@ -161505,10 +164154,10 @@ webhooks: type: string enum: - restored - changes: *749 - installation: *707 - organization: *708 - projects_v2_item: *746 + changes: *748 + installation: *706 + organization: *707 + projects_v2_item: *745 sender: *4 required: - action @@ -161590,9 +164239,9 @@ webhooks: type: string enum: - reopened - installation: *707 - organization: *708 - projects_v2: *263 + installation: *706 + organization: *707 + projects_v2: *262 sender: *4 required: - action @@ -161673,9 +164322,9 @@ webhooks: type: string enum: - created - installation: *707 - organization: *708 - projects_v2_status_update: *750 + installation: *706 + organization: *707 + projects_v2_status_update: *749 sender: *4 required: - action @@ -161756,9 +164405,9 @@ webhooks: type: string enum: - deleted - installation: *707 - organization: *708 - projects_v2_status_update: *750 + installation: *706 + organization: *707 + projects_v2_status_update: *749 sender: *4 required: - action @@ -161904,9 +164553,9 @@ webhooks: - string - 'null' format: date - installation: *707 - organization: *708 - projects_v2_status_update: *750 + installation: *706 + organization: *707 + projects_v2_status_update: *749 sender: *4 required: - action @@ -161977,10 +164626,10 @@ webhooks: title: public event type: object properties: - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - repository @@ -162057,13 +164706,13 @@ webhooks: type: string enum: - assigned - assignee: *726 - enterprise: *706 - installation: *707 - number: &751 + assignee: *725 + enterprise: *705 + installation: *706 + number: &750 description: The pull request number. type: integer - organization: *708 + organization: *707 pull_request: title: Pull Request type: object @@ -164415,7 +167064,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 sender: *4 required: - action @@ -164497,11 +167146,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 number: type: integer - organization: *708 + organization: *707 pull_request: title: Pull Request type: object @@ -166846,7 +169495,7 @@ webhooks: - draft reason: type: string - repository: *709 + repository: *708 sender: *4 required: - action @@ -166928,11 +169577,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 number: type: integer - organization: *708 + organization: *707 pull_request: title: Pull Request type: object @@ -169277,7 +171926,7 @@ webhooks: - draft reason: type: string - repository: *709 + repository: *708 sender: *4 required: - action @@ -169359,13 +172008,13 @@ webhooks: type: string enum: - closed - enterprise: *706 - installation: *707 - number: *751 - organization: *708 - pull_request: &752 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 + pull_request: &751 allOf: - - *565 + - *564 - type: object properties: allow_auto_merge: @@ -169427,7 +172076,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *709 + repository: *708 sender: *4 required: - action @@ -169508,12 +172157,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *706 - installation: *707 - number: *751 - organization: *708 - pull_request: *752 - repository: *709 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 + pull_request: *751 + repository: *708 sender: *4 required: - action @@ -169593,11 +172242,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *706 - milestone: *266 - number: *751 - organization: *708 - pull_request: &753 + enterprise: *705 + milestone: *265 + number: *750 + organization: *707 + pull_request: &752 title: Pull Request type: object properties: @@ -171941,7 +174590,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 sender: *4 required: - action @@ -172020,11 +174669,11 @@ webhooks: type: string enum: - dequeued - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 number: type: integer - organization: *708 + organization: *707 pull_request: title: Pull Request type: object @@ -174387,7 +177036,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *709 + repository: *708 sender: *4 required: - action @@ -174511,12 +177160,12 @@ webhooks: type: string required: - from - enterprise: *706 - installation: *707 - number: *751 - organization: *708 - pull_request: *752 - repository: *709 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 + pull_request: *751 + repository: *708 sender: *4 required: - action @@ -174596,11 +177245,11 @@ webhooks: type: string enum: - enqueued - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 number: type: integer - organization: *708 + organization: *707 pull_request: title: Pull Request type: object @@ -176948,7 +179597,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 sender: *4 required: - action @@ -177028,11 +179677,11 @@ webhooks: type: string enum: - labeled - enterprise: *706 - installation: *707 - label: *725 - number: *751 - organization: *708 + enterprise: *705 + installation: *706 + label: *724 + number: *750 + organization: *707 pull_request: title: Pull Request type: object @@ -179383,7 +182032,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 sender: *4 required: - action @@ -179464,10 +182113,10 @@ webhooks: type: string enum: - locked - enterprise: *706 - installation: *707 - number: *751 - organization: *708 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 pull_request: title: Pull Request type: object @@ -181816,7 +184465,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 sender: *4 required: - action @@ -181896,12 +184545,12 @@ webhooks: type: string enum: - milestoned - enterprise: *706 - milestone: *266 - number: *751 - organization: *708 - pull_request: *753 - repository: *709 + enterprise: *705 + milestone: *265 + number: *750 + organization: *707 + pull_request: *752 + repository: *708 sender: *4 required: - action @@ -181980,12 +184629,12 @@ webhooks: type: string enum: - opened - enterprise: *706 - installation: *707 - number: *751 - organization: *708 - pull_request: *752 - repository: *709 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 + pull_request: *751 + repository: *708 sender: *4 required: - action @@ -182066,12 +184715,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *706 - installation: *707 - number: *751 - organization: *708 - pull_request: *752 - repository: *709 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 + pull_request: *751 + repository: *708 sender: *4 required: - action @@ -182151,12 +184800,12 @@ webhooks: type: string enum: - reopened - enterprise: *706 - installation: *707 - number: *751 - organization: *708 - pull_request: *752 - repository: *709 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 + pull_request: *751 + repository: *708 sender: *4 required: - action @@ -182531,9 +185180,9 @@ webhooks: - start_side - side - reactions - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 pull_request: type: object properties: @@ -184766,7 +187415,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *709 + repository: *708 sender: *4 required: - action @@ -184846,7 +187495,7 @@ webhooks: type: string enum: - deleted - comment: &755 + comment: &754 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -185139,9 +187788,9 @@ webhooks: - start_side - side - reactions - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 pull_request: type: object properties: @@ -187362,7 +190011,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *709 + repository: *708 sender: *4 required: - action @@ -187442,11 +190091,11 @@ webhooks: type: string enum: - edited - changes: *754 - comment: *755 - enterprise: *706 - installation: *707 - organization: *708 + changes: *753 + comment: *754 + enterprise: *705 + installation: *706 + organization: *707 pull_request: type: object properties: @@ -189670,7 +192319,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *709 + repository: *708 sender: *4 required: - action @@ -189751,9 +192400,9 @@ webhooks: type: string enum: - dismissed - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 pull_request: title: Simple Pull Request type: object @@ -191989,7 +194638,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *709 + repository: *708 review: description: The review that was affected. type: object @@ -192240,9 +194889,9 @@ webhooks: type: string required: - from - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 pull_request: title: Simple Pull Request type: object @@ -194351,8 +197000,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *709 - review: &756 + repository: *708 + review: &755 description: The review that was affected. type: object properties: @@ -194590,12 +197239,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 number: description: The pull request number. type: integer - organization: *708 + organization: *707 pull_request: title: Pull Request type: object @@ -196945,7 +199594,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 requested_reviewer: title: User type: @@ -197031,12 +199680,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 number: description: The pull request number. type: integer - organization: *708 + organization: *707 pull_request: title: Pull Request type: object @@ -199393,7 +202042,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 requested_team: title: Team description: Groups of organization members that gives permissions @@ -199588,12 +202237,12 @@ webhooks: type: string enum: - review_requested - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 number: description: The pull request number. type: integer - organization: *708 + organization: *707 pull_request: title: Pull Request type: object @@ -201945,7 +204594,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 requested_reviewer: title: User type: @@ -202032,12 +204681,12 @@ webhooks: type: string enum: - review_requested - enterprise: *706 - installation: *707 + enterprise: *705 + installation: *706 number: description: The pull request number. type: integer - organization: *708 + organization: *707 pull_request: title: Pull Request type: object @@ -204380,7 +207029,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 requested_team: title: Team description: Groups of organization members that gives permissions @@ -204564,9 +207213,9 @@ webhooks: type: string enum: - submitted - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 pull_request: title: Simple Pull Request type: object @@ -206805,8 +209454,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *709 - review: *756 + repository: *708 + review: *755 sender: *4 required: - action @@ -206886,9 +209535,9 @@ webhooks: type: string enum: - resolved - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 pull_request: title: Simple Pull Request type: object @@ -209036,7 +211685,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *709 + repository: *708 sender: *4 thread: type: object @@ -209433,9 +212082,9 @@ webhooks: type: string enum: - unresolved - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 pull_request: title: Simple Pull Request type: object @@ -211566,7 +214215,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *709 + repository: *708 sender: *4 thread: type: object @@ -211965,10 +214614,10 @@ webhooks: type: string before: type: string - enterprise: *706 - installation: *707 - number: *751 - organization: *708 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 pull_request: title: Pull Request type: object @@ -214306,7 +216955,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 sender: *4 required: - action @@ -214388,11 +217037,11 @@ webhooks: type: string enum: - unassigned - assignee: *757 - enterprise: *706 - installation: *707 - number: *751 - organization: *708 + assignee: *756 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 pull_request: title: Pull Request type: object @@ -216745,7 +219394,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 sender: *4 required: - action @@ -216824,11 +219473,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *706 - installation: *707 - label: *725 - number: *751 - organization: *708 + enterprise: *705 + installation: *706 + label: *724 + number: *750 + organization: *707 pull_request: title: Pull Request type: object @@ -219170,7 +221819,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 sender: *4 required: - action @@ -219251,10 +221900,10 @@ webhooks: type: string enum: - unlocked - enterprise: *706 - installation: *707 - number: *751 - organization: *708 + enterprise: *705 + installation: *706 + number: *750 + organization: *707 pull_request: title: Pull Request type: object @@ -221586,7 +224235,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *709 + repository: *708 sender: *4 required: - action @@ -221789,7 +224438,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *706 + enterprise: *705 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -221884,8 +224533,8 @@ webhooks: - url - author - committer - installation: *707 - organization: *708 + installation: *706 + organization: *707 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -222484,9 +225133,9 @@ webhooks: type: string enum: - published - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 registry_package: type: object properties: @@ -222963,7 +225612,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *740 + items: *739 summary: type: string tag_name: @@ -223019,7 +225668,7 @@ webhooks: - owner - package_version - registry - repository: *709 + repository: *708 sender: *4 required: - action @@ -223097,9 +225746,9 @@ webhooks: type: string enum: - updated - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 registry_package: type: object properties: @@ -223411,7 +226060,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *740 + items: *739 summary: type: string tag_name: @@ -223461,7 +226110,7 @@ webhooks: - owner - package_version - registry - repository: *709 + repository: *708 sender: *4 required: - action @@ -223538,10 +226187,10 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 - release: &758 + enterprise: *705 + installation: *706 + organization: *707 + release: &757 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -223872,7 +226521,7 @@ webhooks: - updated_at - zipball_url - body - repository: *709 + repository: *708 sender: *4 required: - action @@ -223949,11 +226598,11 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - organization: *708 - release: *758 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + release: *757 + repository: *708 sender: *4 required: - action @@ -224070,11 +226719,11 @@ webhooks: type: boolean required: - to - enterprise: *706 - installation: *707 - organization: *708 - release: *758 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + release: *757 + repository: *708 sender: *4 required: - action @@ -224152,9 +226801,9 @@ webhooks: type: string enum: - prereleased - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -224490,7 +227139,7 @@ webhooks: - string - 'null' format: uri - repository: *709 + repository: *708 sender: *4 required: - action @@ -224566,10 +227215,10 @@ webhooks: type: string enum: - published - enterprise: *706 - installation: *707 - organization: *708 - release: &759 + enterprise: *705 + installation: *706 + organization: *707 + release: &758 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -224902,7 +227551,7 @@ webhooks: - string - 'null' format: uri - repository: *709 + repository: *708 sender: *4 required: - action @@ -224978,11 +227627,11 @@ webhooks: type: string enum: - released - enterprise: *706 - installation: *707 - organization: *708 - release: *758 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + release: *757 + repository: *708 sender: *4 required: - action @@ -225058,11 +227707,11 @@ webhooks: type: string enum: - unpublished - enterprise: *706 - installation: *707 - organization: *708 - release: *759 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + release: *758 + repository: *708 sender: *4 required: - action @@ -225138,11 +227787,11 @@ webhooks: type: string enum: - published - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - repository_advisory: *629 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + repository_advisory: *628 sender: *4 required: - action @@ -225218,11 +227867,11 @@ webhooks: type: string enum: - reported - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - repository_advisory: *629 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + repository_advisory: *628 sender: *4 required: - action @@ -225298,10 +227947,10 @@ webhooks: type: string enum: - archived - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -225378,10 +228027,10 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -225459,10 +228108,10 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -225547,10 +228196,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -225665,10 +228314,10 @@ webhooks: - 'null' items: type: string - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -225740,10 +228389,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 status: type: string @@ -225824,10 +228473,10 @@ webhooks: type: string enum: - privatized - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -225904,10 +228553,10 @@ webhooks: type: string enum: - publicized - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -226001,10 +228650,10 @@ webhooks: - name required: - repository - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -226084,11 +228733,11 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - repository_ruleset: *308 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + repository_ruleset: *307 sender: *4 required: - action @@ -226166,11 +228815,11 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - repository_ruleset: *308 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + repository_ruleset: *307 sender: *4 required: - action @@ -226248,11 +228897,11 @@ webhooks: type: string enum: - edited - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - repository_ruleset: *308 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + repository_ruleset: *307 changes: type: object properties: @@ -226271,16 +228920,16 @@ webhooks: properties: added: type: array - items: *282 + items: *281 deleted: type: array - items: *282 + items: *281 updated: type: array items: type: object properties: - condition: *282 + condition: *281 changes: type: object properties: @@ -226313,16 +228962,16 @@ webhooks: properties: added: type: array - items: *585 + items: *584 deleted: type: array - items: *585 + items: *584 updated: type: array items: type: object properties: - rule: *585 + rule: *584 changes: type: object properties: @@ -226559,10 +229208,10 @@ webhooks: - from required: - owner - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -226640,10 +229289,10 @@ webhooks: type: string enum: - unarchived - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -226721,7 +229370,7 @@ webhooks: type: string enum: - create - alert: &760 + alert: &759 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -226846,10 +229495,10 @@ webhooks: enum: - auto_dismissed - open - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -227059,10 +229708,10 @@ webhooks: type: string enum: - dismissed - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -227140,11 +229789,11 @@ webhooks: type: string enum: - reopen - alert: *760 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + alert: *759 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -227346,10 +229995,10 @@ webhooks: enum: - fixed - open - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -227427,17 +230076,17 @@ webhooks: type: string enum: - assigned - alert: &761 + alert: &760 type: object properties: - number: *171 - created_at: *172 + number: *170 + created_at: *171 updated_at: anyOf: - type: 'null' - - *173 - url: *174 - html_url: *175 + - *172 + url: *173 + html_url: *174 locations_url: type: string format: uri @@ -227542,10 +230191,10 @@ webhooks: - type: 'null' - *4 assignee: *4 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -227623,11 +230272,11 @@ webhooks: type: string enum: - created - alert: *761 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + alert: *760 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -227708,11 +230357,11 @@ webhooks: type: string enum: - created - alert: *761 - installation: *707 - location: *762 - organization: *708 - repository: *709 + alert: *760 + installation: *706 + location: *761 + organization: *707 + repository: *708 sender: *4 required: - location @@ -227950,11 +230599,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *761 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + alert: *760 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -228032,11 +230681,11 @@ webhooks: type: string enum: - reopened - alert: *761 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + alert: *760 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -228114,11 +230763,11 @@ webhooks: type: string enum: - resolved - alert: *761 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + alert: *760 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -228196,12 +230845,12 @@ webhooks: type: string enum: - unassigned - alert: *761 + alert: *760 assignee: *4 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -228279,11 +230928,11 @@ webhooks: type: string enum: - validated - alert: *761 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + alert: *760 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -228413,10 +231062,10 @@ webhooks: - organization - enterprise - - repository: *709 - enterprise: *706 - installation: *707 - organization: *708 + repository: *708 + enterprise: *705 + installation: *706 + organization: *707 sender: *4 required: - action @@ -228494,11 +231143,11 @@ webhooks: type: string enum: - published - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - security_advisory: &763 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + security_advisory: &762 description: The details of the security advisory, including summary, description, and severity. type: object @@ -228671,11 +231320,11 @@ webhooks: type: string enum: - updated - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 - security_advisory: *763 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 + security_advisory: *762 sender: *4 required: - action @@ -228748,10 +231397,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -228924,11 +231573,11 @@ webhooks: from: type: object properties: - security_and_analysis: *281 - enterprise: *706 - installation: *707 - organization: *708 - repository: *328 + security_and_analysis: *280 + enterprise: *705 + installation: *706 + organization: *707 + repository: *327 sender: *4 required: - changes @@ -229006,12 +231655,12 @@ webhooks: type: string enum: - cancelled - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - sponsorship: &764 + sponsorship: &763 type: object properties: created_at: @@ -229316,12 +231965,12 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - sponsorship: *764 + sponsorship: *763 required: - action - sponsorship @@ -229409,12 +232058,12 @@ webhooks: type: string required: - from - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - sponsorship: *764 + sponsorship: *763 required: - action - changes @@ -229491,17 +232140,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &765 + effective_date: &764 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: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - sponsorship: *764 + sponsorship: *763 required: - action - sponsorship @@ -229575,7 +232224,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &766 + changes: &765 type: object properties: tier: @@ -229619,13 +232268,13 @@ webhooks: - from required: - tier - effective_date: *765 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + effective_date: *764 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - sponsorship: *764 + sponsorship: *763 required: - action - changes @@ -229702,13 +232351,13 @@ webhooks: type: string enum: - tier_changed - changes: *766 - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + changes: *765 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - sponsorship: *764 + sponsorship: *763 required: - action - changes @@ -229782,10 +232431,10 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -229869,10 +232518,10 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -230306,15 +232955,15 @@ webhooks: type: - string - 'null' - enterprise: *706 + enterprise: *705 id: description: The unique identifier of the status. type: integer - installation: *707 + installation: *706 name: type: string - organization: *708 - repository: *709 + organization: *707 + repository: *708 sender: *4 sha: description: The Commit SHA. @@ -230430,9 +233079,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *81 - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -230522,9 +233171,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *81 - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -230614,9 +233263,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *81 - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -230706,9 +233355,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *81 - installation: *707 - organization: *708 - repository: *709 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -230785,12 +233434,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 - team: &767 + team: &766 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -231020,9 +233669,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 repository: title: Repository description: A git repository @@ -231492,7 +234141,7 @@ webhooks: - topics - visibility sender: *4 - team: *767 + team: *766 required: - action - team @@ -231568,9 +234217,9 @@ webhooks: type: string enum: - created - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 repository: title: Repository description: A git repository @@ -232040,7 +234689,7 @@ webhooks: - topics - visibility sender: *4 - team: *767 + team: *766 required: - action - team @@ -232117,9 +234766,9 @@ webhooks: type: string enum: - deleted - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 repository: title: Repository description: A git repository @@ -232589,7 +235238,7 @@ webhooks: - topics - visibility sender: *4 - team: *767 + team: *766 required: - action - team @@ -232733,9 +235382,9 @@ webhooks: - from required: - permissions - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 repository: title: Repository description: A git repository @@ -233205,7 +235854,7 @@ webhooks: - topics - visibility sender: *4 - team: *767 + team: *766 required: - action - changes @@ -233283,9 +235932,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *706 - installation: *707 - organization: *708 + enterprise: *705 + installation: *706 + organization: *707 repository: title: Repository description: A git repository @@ -233755,7 +236404,7 @@ webhooks: - topics - visibility sender: *4 - team: *767 + team: *766 required: - action - team @@ -233831,10 +236480,10 @@ webhooks: type: string enum: - started - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 required: - action @@ -233907,17 +236556,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *706 + enterprise: *705 inputs: type: - object - 'null' additionalProperties: true - installation: *707 - organization: *708 + installation: *706 + organization: *707 ref: type: string - repository: *709 + repository: *708 sender: *4 workflow: type: string @@ -233999,10 +236648,10 @@ webhooks: type: string enum: - completed - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 workflow_job: allOf: @@ -234258,7 +236907,7 @@ webhooks: type: string required: - conclusion - deployment: *481 + deployment: *480 required: - action - repository @@ -234337,10 +236986,10 @@ webhooks: type: string enum: - in_progress - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 workflow_job: allOf: @@ -234622,7 +237271,7 @@ webhooks: required: - status - steps - deployment: *481 + deployment: *480 required: - action - repository @@ -234701,10 +237350,10 @@ webhooks: type: string enum: - queued - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 workflow_job: type: object @@ -234850,7 +237499,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *481 + deployment: *480 required: - action - repository @@ -234929,10 +237578,10 @@ webhooks: type: string enum: - waiting - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + installation: *706 + organization: *707 + repository: *708 sender: *4 workflow_job: type: object @@ -235079,7 +237728,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *481 + deployment: *480 required: - action - repository @@ -235159,12 +237808,12 @@ webhooks: type: string enum: - completed - enterprise: *706 - installation: *707 - organization: *708 - repository: *709 + enterprise: *705 + i{"code":"deadline_exceeded","msg":"operation timed out"}