diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 06d803d914..febc269a8d 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -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,3481 @@ "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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" } } }, @@ -10505,7 +13794,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": { @@ -14332,206 +17632,226 @@ } }, "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, - "example": "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.\\-_]+$", - "example": "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, + "example": "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.\\-_]+$", + "example": "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" } @@ -23923,7 +27243,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" ], @@ -24202,7 +27522,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" ], @@ -30304,6 +33624,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": [ @@ -30445,6 +33778,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." } } }, @@ -107134,7 +110480,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -122010,6 +125357,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -122091,6 +125444,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -122106,6 +125465,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -122121,6 +125486,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -122181,6 +125552,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -122196,6 +125573,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -122211,6 +125594,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -122226,6 +125615,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -122241,6 +125636,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ @@ -130286,7 +133687,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -284395,12 +287797,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { @@ -287550,12 +290950,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -304273,12 +307671,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -304566,12 +307962,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/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index 6c892c6261..966a3269eb 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -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,2534 @@ 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 @@ -7524,7 +10054,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" @@ -10524,7 +13063,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: @@ -17418,7 +19970,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: @@ -17636,7 +20188,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: @@ -21990,6 +24542,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 @@ -22091,6 +24656,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: @@ -77813,6 +80391,7 @@ components: - unknown - direct - transitive + - inconclusive security_advisory: "$ref": "#/components/schemas/dependabot-alert-security-advisory" security_vulnerability: @@ -89514,6 +92093,11 @@ 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. + example: https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1 required: - path - start_line @@ -89584,6 +92168,11 @@ components: format: uri description: The API URL to get the issue where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url secret-scanning-location-issue-body: @@ -89596,6 +92185,11 @@ components: format: uri description: The API URL to get the issue where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url secret-scanning-location-issue-comment: @@ -89608,6 +92202,11 @@ components: format: uri description: The API URL to get the issue comment where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url secret-scanning-location-discussion-title: @@ -89658,6 +92257,11 @@ components: format: uri description: The API URL to get the pull request where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url secret-scanning-location-pull-request-body: @@ -89671,6 +92275,11 @@ components: format: uri description: The API URL to get the pull request where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url secret-scanning-location-pull-request-comment: @@ -89685,6 +92294,12 @@ components: description: The API URL to get the pull request comment where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url secret-scanning-location-pull-request-review: @@ -89699,6 +92314,12 @@ components: description: The API URL to get the pull request review where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url secret-scanning-location-pull-request-review-comment: @@ -89713,6 +92334,12 @@ components: description: The API URL to get the pull request review comment where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846#discussion_r12 required: - pull_request_review_comment_url nullable-secret-scanning-first-detected-location: @@ -95954,6 +98581,7 @@ components: - unknown - direct - transitive + - inconclusive security_advisory: "$ref": "#/components/schemas/dependabot-alert-security-advisory" security_vulnerability: @@ -212089,7 +214717,7 @@ components: - cwe_id: CWE-400 name: Uncontrolled Resource Consumption epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 credits: - user: @@ -215119,7 +217747,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 @@ -229395,7 +232023,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 @@ -229604,7 +232232,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/api.github.com/api.github.com.2026-03-10.json b/descriptions/api.github.com/api.github.com.2026-03-10.json index 3a13e16173..12a1ad22b2 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions/api.github.com/api.github.com.2026-03-10.json @@ -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": [ @@ -251,270 +255,3555 @@ "tags": [ "security-advisories" ], - "operationId": "security-advisories/list-global-advisories", + "operationId": "security-advisories/list-global-advisories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/security-advisories/global-advisories#list-global-security-advisories" + }, + "parameters": [ + { + "name": "ghsa_id", + "in": "query", + "description": "If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "type", + "in": "query", + "description": "If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware.", + "schema": { + "type": "string", + "enum": [ + "reviewed", + "malware", + "unreviewed" + ], + "default": "reviewed" + } + }, + { + "name": "cve_id", + "description": "If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "ecosystem", + "in": "query", + "description": "If specified, only advisories for these ecosystems will be returned.", + "schema": { + "$ref": "#/components/schemas/security-advisory-ecosystems" + } + }, + { + "name": "severity", + "in": "query", + "description": "If specified, only advisories with these severities will be returned.", + "schema": { + "type": "string", + "enum": [ + "unknown", + "low", + "medium", + "high", + "critical" + ] + } + }, + { + "name": "cwes", + "in": "query", + "description": "If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.\n\nExample: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22`", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + }, + { + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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/security-advisories/global-advisories#list-global-security-advisories" + "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": "ghsa_id", - "in": "query", - "description": "If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.", - "schema": { - "type": "string" - } - }, - { - "name": "type", - "in": "query", - "description": "If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware.", - "schema": { - "type": "string", - "enum": [ - "reviewed", - "malware", - "unreviewed" - ], - "default": "reviewed" - } - }, - { - "name": "cve_id", - "description": "If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.", + "name": "per_page", "in": "query", "schema": { - "type": "string" - } + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." }, { - "name": "ecosystem", + "name": "page", "in": "query", - "description": "If specified, only advisories for these ecosystems will be returned.", "schema": { - "$ref": "#/components/schemas/security-advisory-ecosystems" - } + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." }, { - "name": "severity", + "name": "sort", "in": "query", - "description": "If specified, only advisories with these severities will be returned.", "schema": { "type": "string", + "default": "updated_at", "enum": [ - "unknown", - "low", - "medium", - "high", - "critical" - ] - } - }, - { - "name": "cwes", - "in": "query", - "description": "If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.\n\nExample: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22`", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } + "updated_at", + "created_at" ] - } - }, - { - "name": "is_withdrawn", - "in": "query", - "description": "Whether to only return advisories that have been withdrawn.", - "schema": { - "type": "boolean" - } + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." }, { - "name": "affects", + "name": "direction", "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" - } - } + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" ] - } - }, - { - "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" - } + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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" } } }, @@ -10504,7 +13793,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": { @@ -14331,206 +17631,226 @@ } }, "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, - "example": "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.\\-_]+$", - "example": "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, + "example": "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.\\-_]+$", + "example": "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" } @@ -23877,7 +27197,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" ], @@ -24156,7 +27476,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" ], @@ -30261,6 +33581,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": [ @@ -30402,6 +33735,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." } } }, @@ -106932,7 +110278,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -121466,6 +124813,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -121547,6 +124900,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -121562,6 +124921,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -121577,6 +124942,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -121637,6 +125008,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -121652,6 +125029,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -121667,6 +125050,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -121682,6 +125071,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -121697,6 +125092,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ @@ -129705,7 +133106,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -283645,12 +287047,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { @@ -286800,12 +290200,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -303522,12 +306920,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -303815,12 +307211,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/api.github.com/api.github.com.2026-03-10.yaml b/descriptions/api.github.com/api.github.com.2026-03-10.yaml index 3368588465..de38c24217 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions/api.github.com/api.github.com.2026-03-10.yaml @@ -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,2534 @@ 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 @@ -7522,7 +10052,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" @@ -10522,7 +13061,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: @@ -17384,7 +19936,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: @@ -17602,7 +20154,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: @@ -21958,6 +24510,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 @@ -22059,6 +24624,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: @@ -77645,6 +80223,7 @@ components: - unknown - direct - transitive + - inconclusive security_advisory: "$ref": "#/components/schemas/dependabot-alert-security-advisory" security_vulnerability: @@ -89085,6 +91664,11 @@ 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. + example: https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1 required: - path - start_line @@ -89155,6 +91739,11 @@ components: format: uri description: The API URL to get the issue where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url secret-scanning-location-issue-body: @@ -89167,6 +91756,11 @@ components: format: uri description: The API URL to get the issue where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url secret-scanning-location-issue-comment: @@ -89179,6 +91773,11 @@ components: format: uri description: The API URL to get the issue comment where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url secret-scanning-location-discussion-title: @@ -89229,6 +91828,11 @@ components: format: uri description: The API URL to get the pull request where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url secret-scanning-location-pull-request-body: @@ -89242,6 +91846,11 @@ components: format: uri description: The API URL to get the pull request where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url secret-scanning-location-pull-request-comment: @@ -89256,6 +91865,12 @@ components: description: The API URL to get the pull request comment where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url secret-scanning-location-pull-request-review: @@ -89270,6 +91885,12 @@ components: description: The API URL to get the pull request review where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url secret-scanning-location-pull-request-review-comment: @@ -89284,6 +91905,12 @@ components: description: The API URL to get the pull request review comment where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846#discussion_r12 required: - pull_request_review_comment_url nullable-secret-scanning-first-detected-location: @@ -95495,6 +98122,7 @@ components: - unknown - direct - transitive + - inconclusive security_advisory: "$ref": "#/components/schemas/dependabot-alert-security-advisory" security_vulnerability: @@ -211416,7 +214044,7 @@ components: - cwe_id: CWE-400 name: Uncontrolled Resource Consumption epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 credits: - user: @@ -214446,7 +217074,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 @@ -228721,7 +231349,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 @@ -228930,7 +231558,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/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index ddc4f2d845..aa8994f335 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/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,3481 @@ "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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" } } }, @@ -10551,7 +13840,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": { @@ -14378,206 +17678,226 @@ } }, "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, - "example": "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.\\-_]+$", - "example": "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, + "example": "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.\\-_]+$", + "example": "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" } @@ -24102,7 +27422,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" ], @@ -24381,7 +27701,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" ], @@ -30496,6 +33816,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": [ @@ -30637,6 +33970,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." } } }, @@ -107740,7 +111086,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -122993,6 +126340,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -123074,6 +126427,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -123089,6 +126448,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -123104,6 +126469,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -123164,6 +126535,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -123179,6 +126556,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -123194,6 +126577,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -123209,6 +126598,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -123224,6 +126619,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ @@ -131431,7 +134832,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -286490,12 +289892,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { @@ -289645,12 +293045,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -306380,12 +309778,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -306673,12 +310069,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/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 3e340ede77..f5f933a8cb 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/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,2534 @@ 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 +10079,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" @@ -10549,7 +13088,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: @@ -17513,7 +20065,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: @@ -17731,7 +20283,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: @@ -22092,6 +24644,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 @@ -22193,6 +24758,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: @@ -78208,6 +80786,7 @@ components: - unknown - direct - transitive + - inconclusive security_advisory: "$ref": "#/components/schemas/dependabot-alert-security-advisory" security_vulnerability: @@ -90191,6 +92770,11 @@ 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. + example: https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1 required: - path - start_line @@ -90261,6 +92845,11 @@ components: format: uri description: The API URL to get the issue where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url secret-scanning-location-issue-body: @@ -90273,6 +92862,11 @@ components: format: uri description: The API URL to get the issue where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url secret-scanning-location-issue-comment: @@ -90285,6 +92879,11 @@ components: format: uri description: The API URL to get the issue comment where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url secret-scanning-location-discussion-title: @@ -90335,6 +92934,11 @@ components: format: uri description: The API URL to get the pull request where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url secret-scanning-location-pull-request-body: @@ -90348,6 +92952,11 @@ components: format: uri description: The API URL to get the pull request where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url secret-scanning-location-pull-request-comment: @@ -90362,6 +92971,12 @@ components: description: The API URL to get the pull request comment where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url secret-scanning-location-pull-request-review: @@ -90376,6 +92991,12 @@ components: description: The API URL to get the pull request review where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url secret-scanning-location-pull-request-review-comment: @@ -90390,6 +93011,12 @@ components: description: The API URL to get the pull request review comment where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846#discussion_r12 required: - pull_request_review_comment_url nullable-secret-scanning-first-detected-location: @@ -96767,6 +99394,7 @@ components: - unknown - direct - transitive + - inconclusive security_advisory: "$ref": "#/components/schemas/dependabot-alert-security-advisory" security_vulnerability: @@ -213470,7 +216098,7 @@ components: - cwe_id: CWE-400 name: Uncontrolled Resource Consumption epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 credits: - user: @@ -216500,7 +219128,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 @@ -230782,7 +233410,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 @@ -230991,7 +233619,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/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 6319c96fa0..4ff930c236 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -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": [ @@ -1252,12 +1256,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { @@ -2018,6 +2020,3291 @@ } } }, + "/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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", @@ -22721,7 +26008,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -23980,12 +27268,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -78048,10 +81334,7 @@ "type": "string" } } - }, - "required": [ - "include_claim_keys" - ] + } }, "examples": { "default": { @@ -92472,6 +95755,19 @@ "type": "string" } } + }, + "examples": { + "insufficient_repo_permissions": { + "value": { + "message": { + "cause": "artifact metadata write permission required on one or more repositories", + "repositories": [ + 123, + 345 + ] + } + } + } } } } @@ -113781,7 +117077,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -115040,12 +118337,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -152063,7 +155358,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" ], @@ -152790,7 +156085,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" ], @@ -206359,6 +209654,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -206440,6 +209741,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -206455,6 +209762,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -206470,6 +209783,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -206530,6 +209849,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -206545,6 +209870,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -206560,6 +209891,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -206575,6 +209912,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -206590,6 +209933,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ @@ -211512,6 +214861,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": [ @@ -211810,6 +215172,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." } } }, @@ -325815,7 +329190,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -326654,12 +330030,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -327157,7 +330531,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -328005,12 +331380,10 @@ "score": 8.5 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-532", @@ -328336,7 +331709,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -525130,6 +528504,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -525211,6 +528591,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -525226,6 +528612,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -525241,6 +528633,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -525301,6 +528699,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -525316,6 +528720,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -525331,6 +528741,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -525346,6 +528762,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -525361,6 +528783,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ @@ -526268,6 +529696,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -526349,6 +529783,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -526364,6 +529804,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -526379,6 +529825,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -526439,6 +529891,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -526454,6 +529912,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -526469,6 +529933,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -526484,6 +529954,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -526499,6 +529975,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ @@ -527382,6 +530864,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -527463,6 +530951,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -527478,6 +530972,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -527493,6 +530993,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -527553,6 +531059,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -527568,6 +531080,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -527583,6 +531101,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -527598,6 +531122,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -527613,6 +531143,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ @@ -527999,6 +531535,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -528080,6 +531622,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -528095,6 +531643,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -528110,6 +531664,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -528170,6 +531730,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -528185,6 +531751,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -528200,6 +531772,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -528215,6 +531793,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -528230,6 +531814,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ @@ -770848,7 +774438,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -773323,7 +776914,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -775798,7 +779390,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -778273,7 +781866,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -780748,7 +784342,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -783223,7 +786818,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -785698,7 +789294,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -788173,7 +791770,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -1318484,6 +1322082,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -1318565,6 +1322169,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -1318580,6 +1322190,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -1318595,6 +1322211,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -1318655,6 +1322277,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -1318670,6 +1322298,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -1318685,6 +1322319,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -1318700,6 +1322340,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -1318715,6 +1322361,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 536d83013c..16a036b78c 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -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: @@ -855,7 +857,7 @@ paths: - subscriptions_url - type - url - type: &330 + type: &329 type: string description: The type of credit the user is receiving. enum: @@ -944,7 +946,7 @@ paths: - cwe_id: CWE-400 name: Uncontrolled Resource Consumption epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 credits: - user: @@ -1021,7 +1023,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &658 + - &657 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1111,6 +1113,2534 @@ 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 @@ -1577,7 +4107,7 @@ paths: schema: type: integer default: 30 - - &216 + - &215 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 @@ -1586,7 +4116,7 @@ paths: required: false schema: type: string - - &217 + - &216 name: status description: Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries @@ -1606,7 +4136,7 @@ paths: application/json: schema: type: array - items: &218 + items: &217 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1686,7 +4216,7 @@ paths: - installation_id - repository_id examples: - default: &219 + default: &218 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1814,7 +4344,7 @@ paths: description: Response content: application/json: - schema: &220 + schema: &219 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1928,7 +4458,7 @@ paths: - request - response examples: - default: &221 + default: &220 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2905,7 +5435,7 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: &295 + properties: &294 id: description: Unique identifier of the repository example: 42 @@ -3356,7 +5886,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &296 + required: &295 - archive_url - assignees_url - blobs_url @@ -7990,7 +10520,7 @@ paths: description: Response content: application/json: - schema: &190 + schema: &189 type: array description: A list of default code security configurations items: @@ -8006,7 +10536,7 @@ paths: default configuration: *49 examples: - default: &191 + default: &190 value: - default_for_new_repos: public configuration: @@ -8346,7 +10876,7 @@ paths: - *40 - *51 responses: - '204': &192 + '204': &191 description: A header with no content is returned. '400': *14 '403': *29 @@ -8473,7 +11003,7 @@ paths: default: value: default_for_new_repos: all - configuration: &189 + configuration: &188 value: id: 1325 target_type: organization @@ -8558,7 +11088,7 @@ paths: application/json: schema: type: array - items: &193 + items: &192 type: object description: Repositories associated with a code security configuration and attachment status @@ -8859,7 +11389,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &194 + repository: &193 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -9159,7 +11689,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &200 + - &199 name: state in: query description: |- @@ -9168,7 +11698,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &201 + - &200 name: severity in: query description: |- @@ -9177,7 +11707,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &202 + - &201 name: ecosystem in: query description: |- @@ -9186,14 +11716,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &203 + - &202 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 - - &204 + - &203 name: epss_percentage in: query description: |- @@ -9205,7 +11735,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 - - &493 + - &492 name: has in: query description: |- @@ -9219,7 +11749,7 @@ paths: type: string enum: - patch - - &205 + - &204 name: assignee in: query description: |- @@ -9228,7 +11758,7 @@ paths: Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. schema: type: string - - &206 + - &205 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -9238,7 +11768,7 @@ paths: enum: - development - runtime - - &207 + - &206 name: sort in: query description: |- @@ -9264,11 +11794,11 @@ paths: application/json: schema: type: array - items: &208 + items: &207 type: object description: A Dependabot alert. properties: - number: &179 + number: &178 type: integer description: The security alert number. readOnly: true @@ -9330,7 +11860,8 @@ paths: - unknown - direct - transitive - security_advisory: &494 + - inconclusive + security_advisory: &493 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9533,29 +12064,29 @@ paths: - withdrawn_at additionalProperties: false security_vulnerability: *65 - url: &182 + url: &181 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &183 + html_url: &182 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &180 + created_at: &179 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: &181 + updated_at: &180 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: &185 + dismissed_at: &184 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -9585,21 +12116,21 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: &184 + fixed_at: &183 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - auto_dismissed_at: &495 + auto_dismissed_at: &494 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissal_request: &496 + dismissal_request: &495 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -9661,7 +12192,7 @@ paths: - repository additionalProperties: false examples: - default: &209 + default: &208 value: - number: 2 state: dismissed @@ -9710,7 +12241,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 @@ -10476,7 +13007,7 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: &196 + properties: &195 login: type: string example: github @@ -10517,7 +13048,7 @@ paths: type: string example: A great organization nullable: true - required: &197 + required: &196 - login - url - id @@ -10997,7 +13528,7 @@ paths: properties: action: type: string - discussion: &752 + discussion: &751 title: Discussion description: A Discussion in a repository. type: object @@ -11364,7 +13895,7 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &547 + properties: &546 id: type: integer format: int64 @@ -11477,7 +14008,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &279 + properties: &278 url: type: string format: uri @@ -11547,7 +14078,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &280 + required: &279 - closed_issues - creator - description @@ -11626,7 +14157,7 @@ paths: timeline_url: type: string format: uri - type: &242 + type: &241 title: Issue Type description: The type of issue. type: object @@ -11740,7 +14271,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &670 + sub_issues_summary: &669 title: Sub-issues Summary type: object properties: @@ -11827,7 +14358,7 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: &569 + properties: &568 pinned_at: type: string format: date-time @@ -11839,7 +14370,7 @@ paths: properties: *20 required: *21 nullable: true - required: &570 + required: &569 - pinned_at - pinned_by nullable: true @@ -11853,7 +14384,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &671 + issue_dependencies_summary: &670 title: Issue Dependencies Summary type: object properties: @@ -11872,7 +14403,7 @@ paths: - total_blocking issue_field_values: type: array - items: &554 + items: &553 title: Issue Field Value description: A value assigned to an issue field type: object @@ -11933,7 +14464,7 @@ paths: - node_id - data_type - value - required: &548 + required: &547 - assignee - closed_at - comments @@ -11971,7 +14502,7 @@ paths: action: type: string issue: *85 - comment: &543 + comment: &542 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -12635,7 +15166,7 @@ paths: type: string release: allOf: - - &603 + - &602 title: Release description: A release. type: object @@ -12706,7 +15237,7 @@ paths: author: *4 assets: type: array - items: &604 + items: &603 title: Release Asset description: Data related to a release. type: object @@ -13297,7 +15828,7 @@ paths: url: type: string format: uri - user: &677 + user: &676 title: Public User description: Public User type: object @@ -15169,7 +17700,7 @@ paths: - closed - all default: open - - &245 + - &244 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -15220,7 +17751,7 @@ paths: type: array items: *85 examples: - default: &246 + default: &245 value: - id: 1 node_id: MDU6SXNzdWUx @@ -16605,14 +19136,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &342 + - &341 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &343 + - &342 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -16674,7 +19205,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &346 + '301': &345 description: Moved permanently content: application/json: @@ -16696,7 +19227,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &579 + - &578 name: all description: If `true`, show notifications marked as read. in: query @@ -16704,7 +19235,7 @@ paths: schema: type: boolean default: false - - &580 + - &579 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -16714,7 +19245,7 @@ paths: type: boolean default: false - *92 - - &581 + - &580 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: @@ -16746,11 +19277,11 @@ paths: properties: id: type: string - repository: &161 + repository: &160 title: Minimal Repository description: Minimal Repository type: object - properties: &211 + properties: &210 id: type: integer format: int64 @@ -17036,7 +19567,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &297 + security_and_analysis: &296 nullable: true type: object properties: @@ -17149,7 +19680,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &212 + required: &211 - archive_url - assignees_url - blobs_url @@ -17237,7 +19768,7 @@ paths: - url - subscription_url examples: - default: &582 + default: &581 value: - id: '1' repository: @@ -18784,7 +21315,7 @@ paths: required: false schema: type: string - - &727 + - &726 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -18930,7 +21461,7 @@ paths: parameters: - *75 - *123 - - &728 + - &727 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 @@ -19042,7 +21573,7 @@ paths: - *123 - *125 - *124 - - &729 + - &728 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -19050,7 +21581,7 @@ paths: schema: type: string - *126 - - &730 + - &729 name: sku description: The SKU to query for usage. in: query @@ -19952,7 +22483,7 @@ paths: type: integer repository_cache_usages: type: array - items: &353 + items: &352 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -20175,7 +22706,7 @@ paths: - public_ip_enabled - platform examples: - default: &160 + default: &159 value: total_count: 2 runners: @@ -21149,7 +23680,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &143 + schema: title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -21163,7 +23694,7 @@ paths: required: - include_claim_keys examples: - default: &144 + default: &143 value: include_claim_keys: - repo @@ -21190,15 +23721,25 @@ paths: required: true content: application/json: - schema: *143 + 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: *144 + default: *143 responses: '201': description: Empty response content: application/json: - schema: &170 + schema: &169 title: Empty Object description: An object without any properties. type: object @@ -21237,7 +23778,7 @@ paths: schema: type: object properties: - enabled_repositories: &145 + enabled_repositories: &144 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -21250,7 +23791,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: &146 + allowed_actions: &145 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -21258,12 +23799,12 @@ paths: - all - local_only - selected - selected_actions_url: &359 + selected_actions_url: &358 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: &147 + sha_pinning_required: &146 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -21305,9 +23846,9 @@ paths: schema: type: object properties: - enabled_repositories: *145 - allowed_actions: *146 - sha_pinning_required: *147 + enabled_repositories: *144 + allowed_actions: *145 + sha_pinning_required: *146 required: - enabled_repositories examples: @@ -21341,7 +23882,7 @@ paths: description: Response content: application/json: - schema: &363 + schema: &362 type: object properties: days: @@ -21383,7 +23924,7 @@ paths: required: true content: application/json: - schema: &364 + schema: &363 type: object properties: days: @@ -21426,7 +23967,7 @@ paths: description: Response content: application/json: - schema: &148 + schema: &147 type: object properties: approval_policy: @@ -21440,7 +23981,7 @@ paths: required: - approval_policy examples: - default: &365 + default: &364 value: approval_policy: first_time_contributors '404': *6 @@ -21471,7 +24012,7 @@ paths: required: true content: application/json: - schema: *148 + schema: *147 examples: default: summary: Set approval policy to first time contributors @@ -21499,7 +24040,7 @@ paths: description: Response content: application/json: - schema: &366 + schema: &365 type: object required: - run_workflows_from_fork_pull_requests @@ -21525,7 +24066,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &149 + default: &148 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -21553,7 +24094,7 @@ paths: required: true content: application/json: - schema: &367 + schema: &366 type: object required: - run_workflows_from_fork_pull_requests @@ -21576,7 +24117,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *149 + default: *148 responses: '204': description: Empty response for successful settings update @@ -21626,7 +24167,7 @@ paths: type: array items: *79 examples: - default: &153 + default: &152 value: total_count: 1 repositories: @@ -21811,7 +24352,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *75 - - &150 + - &149 name: repository_id description: The unique identifier of the repository. in: path @@ -21840,7 +24381,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *75 - - *150 + - *149 responses: '204': description: Response @@ -21869,7 +24410,7 @@ paths: description: Response content: application/json: - schema: &151 + schema: &150 type: object properties: github_owned_allowed: @@ -21891,7 +24432,7 @@ paths: items: type: string examples: - default: &152 + default: &151 value: github_owned_allowed: true verified_allowed: false @@ -21924,9 +24465,9 @@ paths: required: false content: application/json: - schema: *151 + schema: *150 examples: - selected_actions: *152 + selected_actions: *151 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22058,7 +24599,7 @@ paths: type: array items: *79 examples: - default: *153 + default: *152 '403': *29 '404': *6 x-github: @@ -22127,7 +24668,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: - *75 - - *150 + - *149 responses: '204': description: No content @@ -22154,7 +24695,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: - *75 - - *150 + - *149 responses: '204': description: No content @@ -22188,17 +24729,17 @@ paths: description: Response content: application/json: - schema: &368 + schema: &367 type: object properties: - default_workflow_permissions: &154 + default_workflow_permissions: &153 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &155 + can_approve_pull_request_reviews: &154 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -22206,7 +24747,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &156 + default: &155 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -22239,13 +24780,13 @@ paths: required: false content: application/json: - schema: &369 + schema: &368 type: object properties: - default_workflow_permissions: *154 - can_approve_pull_request_reviews: *155 + default_workflow_permissions: *153 + can_approve_pull_request_reviews: *154 examples: - default: *156 + default: *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22290,7 +24831,7 @@ paths: type: number runner_groups: type: array - items: &157 + items: &156 type: object properties: id: @@ -22478,9 +25019,9 @@ paths: description: Response content: application/json: - schema: *157 + schema: *156 examples: - default: &159 + default: &158 value: id: 2 name: octo-runner-group @@ -22516,7 +25057,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - *75 - - &158 + - &157 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -22528,7 +25069,7 @@ paths: description: Response content: application/json: - schema: *157 + schema: *156 examples: default: value: @@ -22565,7 +25106,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - *75 - - *158 + - *157 requestBody: required: true content: @@ -22619,9 +25160,9 @@ paths: description: Response content: application/json: - schema: *157 + schema: *156 examples: - default: *159 + default: *158 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22641,7 +25182,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - *75 - - *158 + - *157 responses: '204': description: Response @@ -22665,7 +25206,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - *75 - - *158 + - *157 - *17 - *19 responses: @@ -22685,7 +25226,7 @@ paths: type: array items: *131 examples: - default: *160 + default: *159 headers: Link: *67 x-github: @@ -22708,7 +25249,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: - *75 - - *158 + - *157 - *19 - *17 responses: @@ -22726,9 +25267,9 @@ paths: type: number repositories: type: array - items: *161 + items: *160 examples: - default: &199 + default: &198 value: total_count: 1 repositories: @@ -22981,7 +25522,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: - *75 - - *158 + - *157 requestBody: required: true content: @@ -23026,8 +25567,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: - *75 - - *158 - - *150 + - *157 + - *149 responses: '204': description: Response @@ -23050,8 +25591,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: - *75 - - *158 - - *150 + - *157 + - *149 responses: '204': description: Response @@ -23075,7 +25616,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - *75 - - *158 + - *157 - *17 - *19 responses: @@ -23093,7 +25634,7 @@ paths: type: number runners: type: array - items: &163 + items: &162 title: Self hosted runners description: A self hosted runner type: object @@ -23122,7 +25663,7 @@ paths: type: boolean labels: type: array - items: &166 + items: &165 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -23152,7 +25693,7 @@ paths: - busy - labels examples: - default: &164 + default: &163 value: total_count: 2 runners: @@ -23212,7 +25753,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - *75 - - *158 + - *157 requestBody: required: true content: @@ -23257,8 +25798,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: - *75 - - *158 - - &162 + - *157 + - &161 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -23287,8 +25828,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: - *75 - - *158 - - *162 + - *157 + - *161 responses: '204': description: Response @@ -23336,9 +25877,9 @@ paths: type: integer runners: type: array - items: *163 + items: *162 examples: - default: *164 + default: *163 headers: Link: *67 x-github: @@ -23370,7 +25911,7 @@ paths: application/json: schema: type: array - items: &370 + items: &369 title: Runner Application description: Runner Application type: object @@ -23395,7 +25936,7 @@ paths: - download_url - filename examples: - default: &371 + default: &370 value: - os: osx architecture: x64 @@ -23481,7 +26022,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &372 + '201': &371 description: Response content: application/json: @@ -23491,7 +26032,7 @@ paths: - runner - encoded_jit_config properties: - runner: *163 + runner: *162 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -23554,7 +26095,7 @@ paths: description: Response content: application/json: - schema: &165 + schema: &164 title: Authentication Token description: Authentication Token type: object @@ -23592,7 +26133,7 @@ paths: - token - expires_at examples: - default: &373 + default: &372 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -23629,9 +26170,9 @@ paths: description: Response content: application/json: - schema: *165 + schema: *164 examples: - default: &374 + default: &373 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -23657,15 +26198,15 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - *75 - - *162 + - *161 responses: '200': description: Response content: application/json: - schema: *163 + schema: *162 examples: - default: &375 + default: &374 value: id: 23 name: MBP @@ -23707,7 +26248,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - *75 - - *162 + - *161 responses: '204': description: Response @@ -23734,9 +26275,9 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - *75 - - *162 + - *161 responses: - '200': &167 + '200': &166 description: Response content: application/json: @@ -23750,7 +26291,7 @@ paths: type: integer labels: type: array - items: *166 + items: *165 examples: default: value: @@ -23790,7 +26331,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - *75 - - *162 + - *161 requestBody: required: true content: @@ -23814,7 +26355,7 @@ paths: - gpu - accelerated responses: - '200': *167 + '200': *166 '404': *6 '422': *7 x-github: @@ -23839,7 +26380,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - *75 - - *162 + - *161 requestBody: required: true content: @@ -23864,7 +26405,7 @@ paths: - gpu - accelerated responses: - '200': *167 + '200': *166 '404': *6 '422': *7 x-github: @@ -23889,9 +26430,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: - *75 - - *162 + - *161 responses: - '200': &376 + '200': &375 description: Response content: application/json: @@ -23905,7 +26446,7 @@ paths: type: integer labels: type: array - items: *166 + items: *165 examples: default: value: @@ -23947,8 +26488,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: - *75 - - *162 - - &377 + - *161 + - &376 name: name description: The name of a self-hosted runner's custom label. in: path @@ -23956,7 +26497,7 @@ paths: schema: type: string responses: - '200': *167 + '200': *166 '404': *6 '422': *7 x-github: @@ -23999,7 +26540,7 @@ paths: type: integer secrets: type: array - items: &168 + items: &167 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -24078,7 +26619,7 @@ paths: description: Response content: application/json: - schema: &389 + schema: &388 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -24107,7 +26648,7 @@ paths: - key_id - key examples: - default: &390 + default: &389 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -24133,7 +26674,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - *75 - - &169 + - &168 name: secret_name description: The name of the secret. in: path @@ -24145,7 +26686,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *167 examples: default: value: @@ -24176,7 +26717,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -24233,7 +26774,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -24260,7 +26801,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - *75 - - *169 + - *168 responses: '204': description: Response @@ -24287,7 +26828,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - *75 - - *169 + - *168 - *19 - *17 responses: @@ -24305,9 +26846,9 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 examples: - default: &173 + default: &172 value: total_count: 1 repositories: @@ -24400,7 +26941,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -24453,7 +26994,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - *75 - - *169 + - *168 - name: repository_id in: path required: true @@ -24487,7 +27028,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - *75 - - *169 + - *168 - name: repository_id in: path required: true @@ -24520,7 +27061,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *75 - - &358 + - &357 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)." @@ -24544,7 +27085,7 @@ paths: type: integer variables: type: array - items: &171 + items: &170 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -24677,7 +27218,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -24703,7 +27244,7 @@ paths: url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - *75 - - &172 + - &171 name: name description: The name of the variable. in: path @@ -24715,7 +27256,7 @@ paths: description: Response content: application/json: - schema: *171 + schema: *170 examples: default: value: @@ -24746,7 +27287,7 @@ paths: url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - *75 - - *172 + - *171 requestBody: required: true content: @@ -24809,7 +27350,7 @@ paths: url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - *75 - - *172 + - *171 responses: '204': description: Response @@ -24836,7 +27377,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - *75 - - *172 + - *171 - *19 - *17 responses: @@ -24854,9 +27395,9 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 examples: - default: *173 + default: *172 '409': description: Response when the visibility of the variable is not set to `selected` @@ -24883,7 +27424,7 @@ paths: url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - *75 - - *172 + - *171 requestBody: required: true content: @@ -24933,7 +27474,7 @@ paths: url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - *75 - - *172 + - *171 - name: repository_id in: path required: true @@ -24968,7 +27509,7 @@ paths: url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - *75 - - *172 + - *171 - name: repository_id in: path required: true @@ -25125,7 +27666,7 @@ paths: type: integer deployment_records: type: array - items: &174 + items: &173 title: Artifact Deployment Record description: Artifact Metadata Deployment Record type: object @@ -25169,7 +27710,7 @@ paths: with the deployment record. nullable: true examples: - default: &175 + default: &174 value: total_count: 1 deployment_records: @@ -25342,10 +27883,23 @@ paths: type: integer deployment_records: type: array - items: *174 + items: *173 examples: - default: *175 - '403': *29 + default: *174 + '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 @@ -25545,9 +28099,9 @@ paths: type: integer deployment_records: type: array - items: *174 + items: *173 examples: - default: *175 + default: *174 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25676,12 +28230,12 @@ paths: required: - subject_digests examples: - default: &709 + default: &708 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &710 + withPredicateType: &709 value: subject_digests: - sha256:abc123 @@ -25739,7 +28293,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &711 + default: &710 value: attestations_subject_digests: - sha256:abc: @@ -26089,7 +28643,7 @@ paths: initiator: type: string examples: - default: &403 + default: &402 value: attestations: - bundle: @@ -26308,7 +28862,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &176 + schema: &175 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -26334,7 +28888,7 @@ paths: application/json: schema: type: array - items: &177 + items: &176 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -26365,7 +28919,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &198 + items: &197 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -26440,7 +28994,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &257 + properties: &256 id: description: Unique identifier of the team type: integer @@ -26512,7 +29066,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &258 + required: &257 - id - node_id - url @@ -26555,7 +29109,7 @@ paths: type: string format: date-time nullable: true - state: *176 + state: *175 contact_link: description: The contact link of the campaign. type: string @@ -26775,9 +29329,9 @@ paths: description: Response content: application/json: - schema: *177 + schema: *176 examples: - default: &178 + default: &177 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -26860,9 +29414,9 @@ paths: description: Response content: application/json: - schema: *177 + schema: *176 examples: - default: *178 + default: *177 '404': *6 '422': description: Unprocessable Entity @@ -26939,7 +29493,7 @@ paths: type: string format: uri nullable: true - state: *176 + state: *175 examples: default: value: @@ -26949,9 +29503,9 @@ paths: description: Response content: application/json: - schema: *177 + schema: *176 examples: - default: *178 + default: *177 '400': description: Bad Request content: @@ -27018,17 +29572,17 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *75 - - &428 + - &427 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: &186 + schema: &185 type: string description: The name of the tool used to generate the code scanning analysis. - - &429 + - &428 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 @@ -27036,7 +29590,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &187 + schema: &186 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, @@ -27051,7 +29605,7 @@ paths: be returned. in: query required: false - schema: &431 + schema: &430 type: string description: State of a code scanning alert. enum: @@ -27074,7 +29628,7 @@ paths: be returned. in: query required: false - schema: &432 + schema: &431 type: string description: Severity of a code scanning alert. enum: @@ -27103,18 +29657,18 @@ paths: items: type: object properties: - number: *179 - created_at: *180 - updated_at: *181 - url: *182 - html_url: *183 - instances_url: &433 + number: *178 + created_at: *179 + updated_at: *180 + url: *181 + html_url: *182 + instances_url: &432 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &188 + state: &187 type: string description: State of a code scanning alert. nullable: true @@ -27122,7 +29676,7 @@ paths: - open - dismissed - fixed - fixed_at: *184 + fixed_at: *183 dismissed_by: title: Simple User description: A GitHub user. @@ -27130,8 +29684,8 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *185 - dismissed_reason: &434 + dismissed_at: *184 + dismissed_reason: &433 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -27140,13 +29694,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &435 + dismissed_comment: &434 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &436 + rule: &435 type: object properties: id: @@ -27199,42 +29753,42 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &437 + tool: &436 type: object properties: - name: *186 + name: *185 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *187 - most_recent_instance: &438 + guid: *186 + most_recent_instance: &437 type: object properties: - ref: &430 + ref: &429 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &448 + analysis_key: &447 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: &449 + environment: &448 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: &450 + category: &449 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: *188 + state: *187 commit_sha: type: string message: @@ -27248,7 +29802,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: &451 + location: &450 type: object description: Describe a region within a file for the alert. properties: @@ -27269,7 +29823,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: &452 + items: &451 type: string description: A classification of the file. For example to identify it as generated. @@ -27906,7 +30460,7 @@ paths: application/json: schema: *49 examples: - default: *189 + default: *188 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27934,9 +30488,9 @@ paths: description: Response content: application/json: - schema: *190 + schema: *189 examples: - default: *191 + default: *190 '304': *37 '403': *29 '404': *6 @@ -27988,7 +30542,7 @@ paths: - 32 - 91 responses: - '204': *192 + '204': *191 '400': *14 '403': *29 '404': *6 @@ -28023,7 +30577,7 @@ paths: application/json: schema: *49 examples: - default: *189 + default: *188 '304': *37 '403': *29 '404': *6 @@ -28323,7 +30877,7 @@ paths: - *75 - *51 responses: - '204': *192 + '204': *191 '400': *14 '403': *29 '404': *6 @@ -28461,7 +31015,7 @@ paths: default: value: default_for_new_repos: all - configuration: *189 + configuration: *188 '403': *29 '404': *6 x-github: @@ -28514,13 +31068,13 @@ paths: application/json: schema: type: array - items: *193 + items: *192 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *194 + repository: *193 '403': *29 '404': *6 x-github: @@ -28560,7 +31114,7 @@ paths: type: integer codespaces: type: array - items: &247 + items: &246 type: object title: Codespace description: A codespace. @@ -28585,12 +31139,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *161 + repository: *160 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &464 + properties: &463 name: type: string description: The name of the machine. @@ -28632,7 +31186,7 @@ paths: - ready - in_progress nullable: true - required: &465 + required: &464 - name - display_name - operating_system @@ -28837,7 +31391,7 @@ paths: - pulls_url - recent_folders examples: - default: &248 + default: &247 value: total_count: 3 codespaces: @@ -29461,7 +32015,7 @@ paths: type: integer secrets: type: array - items: &195 + items: &194 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -29500,7 +32054,7 @@ paths: - updated_at - visibility examples: - default: &466 + default: &465 value: total_count: 2 secrets: @@ -29538,7 +32092,7 @@ paths: description: Response content: application/json: - schema: &467 + schema: &466 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -29567,7 +32121,7 @@ paths: - key_id - key examples: - default: &468 + default: &467 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -29591,15 +32145,15 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - *75 - - *169 + - *168 responses: '200': description: Response content: application/json: - schema: *195 + schema: *194 examples: - default: &470 + default: &469 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -29627,7 +32181,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -29682,7 +32236,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -29709,7 +32263,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - *75 - - *169 + - *168 responses: '204': description: Response @@ -29735,7 +32289,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - *75 - - *169 + - *168 - *19 - *17 responses: @@ -29753,9 +32307,9 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 examples: - default: *173 + default: *172 '404': *6 x-github: githubCloudOnly: false @@ -29778,7 +32332,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -29829,7 +32383,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - *75 - - *169 + - *168 - name: repository_id in: path required: true @@ -29863,7 +32417,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - *75 - - *169 + - *168 - name: repository_id in: path required: true @@ -30066,7 +32620,7 @@ paths: currently being billed. seats: type: array - items: &250 + items: &249 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -30083,14 +32637,14 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *196 - required: *197 + properties: *195 + required: *196 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *198 + - *197 - *68 nullable: true pending_cancellation_date: @@ -30697,12 +33251,12 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 required: - total_count - repositories examples: - default: *199 + default: *198 '500': *55 '401': *25 '403': *29 @@ -30788,7 +33342,7 @@ paths: url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization parameters: - *75 - - *150 + - *149 responses: '204': description: No Content @@ -30822,7 +33376,7 @@ paths: url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization parameters: - *75 - - *150 + - *149 responses: '204': description: No Content @@ -31037,7 +33591,7 @@ paths: application/json: schema: type: array - items: &335 + items: &334 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -31344,7 +33898,7 @@ paths: - date additionalProperties: true examples: - default: &336 + default: &335 value: - date: '2024-06-24' total_active_users: 24 @@ -31446,7 +34000,7 @@ paths: '500': *55 '403': *29 '404': *6 - '422': &337 + '422': &336 description: Copilot Usage Metrics API setting is disabled at the organization or enterprise level. content: @@ -31487,7 +34041,7 @@ paths: schema: *57 examples: default: *58 - '204': *192 + '204': *191 '500': *55 '403': *29 '404': *6 @@ -31563,7 +34117,7 @@ paths: schema: *57 examples: default: *58 - '204': *192 + '204': *191 '500': *55 '403': *29 '404': *6 @@ -31626,11 +34180,11 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *75 + - *199 - *200 - *201 - *202 - *203 - - *204 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -31660,7 +34214,7 @@ paths: enum: - patch - deployment - - *205 + - *204 - name: runtime_risk in: query description: |- @@ -31669,8 +34223,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string + - *205 - *206 - - *207 - *61 - *47 - *48 @@ -31682,9 +34236,9 @@ paths: application/json: schema: type: array - items: *208 + items: *207 examples: - default: *209 + default: *208 '304': *37 '400': *14 '403': *29 @@ -31728,7 +34282,7 @@ paths: type: integer secrets: type: array - items: &210 + items: &209 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -31805,7 +34359,7 @@ paths: description: Response content: application/json: - schema: &499 + schema: &498 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -31822,7 +34376,7 @@ paths: - key_id - key examples: - default: &500 + default: &499 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -31846,13 +34400,13 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - *75 - - *169 + - *168 responses: '200': description: Response content: application/json: - schema: *210 + schema: *209 examples: default: value: @@ -31881,7 +34435,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -31938,7 +34492,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -31963,7 +34517,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - *75 - - *169 + - *168 responses: '204': description: Response @@ -31988,7 +34542,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - *75 - - *169 + - *168 - *19 - *17 responses: @@ -32006,9 +34560,9 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 examples: - default: *173 + default: *172 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32030,7 +34584,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -32081,7 +34635,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - *75 - - *169 + - *168 - name: repository_id in: path required: true @@ -32113,7 +34667,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - *75 - - *169 + - *168 - name: repository_id in: path required: true @@ -32151,7 +34705,7 @@ paths: application/json: schema: type: array - items: &260 + items: &259 title: Package description: A software package type: object @@ -32201,8 +34755,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *211 - required: *212 + properties: *210 + required: *211 nullable: true created_at: type: string @@ -32221,7 +34775,7 @@ paths: - created_at - updated_at examples: - default: &261 + default: &260 value: - id: 197 name: hello_docker @@ -32391,7 +34945,7 @@ paths: application/json: schema: type: array - items: &236 + items: &235 title: Organization Invitation description: Organization Invitation type: object @@ -32438,7 +34992,7 @@ paths: - invitation_teams_url - node_id examples: - default: &237 + default: &236 value: - id: 1 login: monalisa @@ -32505,7 +35059,7 @@ paths: application/json: schema: type: array - items: &213 + items: &212 title: Org Hook description: Org Hook type: object @@ -32676,9 +35230,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *212 examples: - default: &214 + default: &213 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -32726,7 +35280,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - *75 - - &215 + - &214 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. @@ -32739,9 +35293,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *212 examples: - default: *214 + default: *213 '404': *6 x-github: githubCloudOnly: false @@ -32769,7 +35323,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - *75 - - *215 + - *214 requestBody: required: false content: @@ -32814,7 +35368,7 @@ paths: description: Response content: application/json: - schema: *213 + schema: *212 examples: default: value: @@ -32856,7 +35410,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - *75 - - *215 + - *214 responses: '204': description: Response @@ -32884,7 +35438,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *75 - - *215 + - *214 responses: '200': description: Response @@ -32915,7 +35469,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *75 - - *215 + - *214 requestBody: required: false content: @@ -32966,10 +35520,10 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *75 - - *215 + - *214 - *17 + - *215 - *216 - - *217 responses: '200': description: Response @@ -32977,9 +35531,9 @@ paths: application/json: schema: type: array - items: *218 + items: *217 examples: - default: *219 + default: *218 '400': *14 '422': *15 x-github: @@ -33005,16 +35559,16 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *75 - - *215 + - *214 - *16 responses: '200': description: Response content: application/json: - schema: *220 + schema: *219 examples: - default: *221 + default: *220 '400': *14 '422': *15 x-github: @@ -33040,7 +35594,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *75 - - *215 + - *214 - *16 responses: '202': *39 @@ -33070,7 +35624,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - *75 - - *215 + - *214 responses: '204': description: Response @@ -33093,7 +35647,7 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - *75 - - &226 + - &225 name: actor_type in: path description: The type of the actor @@ -33106,14 +35660,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &227 + - &226 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &222 + - &221 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`.' @@ -33121,7 +35675,7 @@ paths: required: true schema: type: string - - &223 + - &222 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) @@ -33215,12 +35769,12 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - *75 + - *221 - *222 - - *223 - *19 - *17 - *61 - - &232 + - &231 name: sort description: The property to sort the results by. in: query @@ -33298,14 +35852,14 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - *75 + - *221 - *222 - - *223 responses: '200': description: Response content: application/json: - schema: &224 + schema: &223 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -33321,7 +35875,7 @@ paths: type: integer format: int64 examples: - default: &225 + default: &224 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -33342,23 +35896,23 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - *75 - - &228 + - &227 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string + - *221 - *222 - - *223 responses: '200': description: Response content: application/json: - schema: *224 + schema: *223 examples: - default: *225 + default: *224 x-github: enabledForGitHubApps: true category: orgs @@ -33377,18 +35931,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *75 + - *221 - *222 - - *223 + - *225 - *226 - - *227 responses: '200': description: Response content: application/json: - schema: *224 + schema: *223 examples: - default: *225 + default: *224 x-github: enabledForGitHubApps: true category: orgs @@ -33406,9 +35960,9 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - *75 + - *221 - *222 - - *223 - - &229 + - &228 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -33421,7 +35975,7 @@ paths: description: Response content: application/json: - schema: &230 + schema: &229 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -33437,7 +35991,7 @@ paths: type: integer format: int64 examples: - default: &231 + default: &230 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -33474,18 +36028,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - *75 - - *228 + - *227 + - *221 - *222 - - *223 - - *229 + - *228 responses: '200': description: Response content: application/json: - schema: *230 + schema: *229 examples: - default: *231 + default: *230 x-github: enabledForGitHubApps: true category: orgs @@ -33503,19 +36057,19 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - *75 + - *225 - *226 - - *227 + - *221 - *222 - - *223 - - *229 + - *228 responses: '200': description: Response content: application/json: - schema: *230 + schema: *229 examples: - default: *231 + default: *230 x-github: enabledForGitHubApps: true category: orgs @@ -33533,13 +36087,13 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - *75 - - *228 + - *227 + - *221 - *222 - - *223 - *19 - *17 - *61 - - *232 + - *231 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -33620,7 +36174,7 @@ paths: application/json: schema: *22 examples: - default: &538 + default: &537 value: id: 1 account: @@ -33786,12 +36340,12 @@ paths: application/json: schema: anyOf: - - &234 + - &233 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &233 + limit: &232 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -33816,7 +36370,7 @@ paths: properties: {} additionalProperties: false examples: - default: &235 + default: &234 value: limit: collaborators_only origin: organization @@ -33845,13 +36399,13 @@ paths: required: true content: application/json: - schema: &539 + schema: &538 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *233 + limit: *232 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -33875,9 +36429,9 @@ paths: description: Response content: application/json: - schema: *234 + schema: *233 examples: - default: *235 + default: *234 '422': *15 x-github: githubCloudOnly: false @@ -33953,9 +36507,9 @@ paths: application/json: schema: type: array - items: *236 + items: *235 examples: - default: *237 + default: *236 headers: Link: *67 '404': *6 @@ -34032,7 +36586,7 @@ paths: description: Response content: application/json: - schema: *236 + schema: *235 examples: default: value: @@ -34087,7 +36641,7 @@ paths: url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - *75 - - &238 + - &237 name: invitation_id description: The unique identifier of the invitation. in: path @@ -34118,7 +36672,7 @@ paths: url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - *75 - - *238 + - *237 - *17 - *19 responses: @@ -34128,9 +36682,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: &259 + default: &258 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -34173,7 +36727,7 @@ paths: application/json: schema: type: array - items: &239 + items: &238 title: Issue Field description: A custom attribute defined at the organization level for attaching structured data to issues. @@ -34406,9 +36960,9 @@ paths: description: Response content: application/json: - schema: *239 + schema: *238 examples: - default: &240 + default: &239 value: id: 512 node_id: IF_kwDNAd3NAZr @@ -34464,7 +37018,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-fields#update-issue-field-for-an-organization parameters: - *75 - - &241 + - &240 name: issue_field_id description: The unique identifier of the issue field. in: path @@ -34563,9 +37117,9 @@ paths: description: Response content: application/json: - schema: *239 + schema: *238 examples: - default: *240 + default: *239 '404': *6 '422': *7 x-github: @@ -34590,9 +37144,9 @@ paths: url: https://docs.github.com/rest/orgs/issue-fields#delete-issue-field-for-an-organization parameters: - *75 - - *241 + - *240 responses: - '204': *192 + '204': *191 '404': *6 '422': *7 x-github: @@ -34620,7 +37174,7 @@ paths: application/json: schema: type: array - items: *242 + items: *241 examples: default: value: @@ -34705,9 +37259,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *241 examples: - default: &243 + default: &242 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -34740,7 +37294,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *75 - - &244 + - &243 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -34793,9 +37347,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *241 examples: - default: *243 + default: *242 '404': *6 '422': *7 x-github: @@ -34820,7 +37374,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *75 - - *244 + - *243 responses: '204': description: Response @@ -34883,7 +37437,7 @@ paths: - closed - all default: open - - *245 + - *244 - name: type description: Can be the name of an issue type. in: query @@ -34914,7 +37468,7 @@ paths: type: array items: *85 examples: - default: *246 + default: *245 headers: Link: *67 '404': *6 @@ -35073,9 +37627,9 @@ paths: type: integer codespaces: type: array - items: *247 + items: *246 examples: - default: *248 + default: *247 '304': *37 '500': *55 '401': *25 @@ -35102,7 +37656,7 @@ paths: parameters: - *75 - *71 - - &249 + - &248 name: codespace_name in: path required: true @@ -35137,15 +37691,15 @@ paths: parameters: - *75 - *71 - - *249 + - *248 responses: '200': description: Response content: application/json: - schema: *247 + schema: *246 examples: - default: &463 + default: &462 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -35325,7 +37879,7 @@ paths: description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *250 + schema: *249 examples: default: value: @@ -35401,7 +37955,7 @@ paths: description: Response content: application/json: - schema: &251 + schema: &250 title: Org Membership description: Org Membership type: object @@ -35468,7 +38022,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &252 + response-if-user-has-an-active-admin-membership-with-organization: &251 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -35569,9 +38123,9 @@ paths: description: Response content: application/json: - schema: *251 + schema: *250 examples: - response-if-user-already-had-membership-with-organization: *252 + response-if-user-already-had-membership-with-organization: *251 '422': *15 '403': *29 x-github: @@ -35642,7 +38196,7 @@ paths: application/json: schema: type: array - items: &253 + items: &252 title: Migration description: A migration. type: object @@ -35971,7 +38525,7 @@ paths: description: Response content: application/json: - schema: *253 + schema: *252 examples: default: value: @@ -36150,7 +38704,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - *75 - - &254 + - &253 name: migration_id description: The unique identifier of the migration. in: path @@ -36177,7 +38731,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *253 + schema: *252 examples: default: value: @@ -36347,7 +38901,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - *75 - - *254 + - *253 responses: '302': description: Response @@ -36369,7 +38923,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *75 - - *254 + - *253 responses: '204': description: Response @@ -36393,8 +38947,8 @@ paths: url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - *75 - - *254 - - &692 + - *253 + - &691 name: repo_name description: repo_name parameter in: path @@ -36422,7 +38976,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *75 - - *254 + - *253 - *17 - *19 responses: @@ -36432,9 +38986,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: &266 + default: &265 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -36563,7 +39117,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: @@ -36589,7 +39143,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &256 + items: &255 title: Organization Role description: Organization roles type: object @@ -36764,7 +39318,7 @@ paths: parameters: - *75 - *77 - - &255 + - &254 name: role_id description: The unique identifier of the role. in: path @@ -36801,7 +39355,7 @@ paths: parameters: - *75 - *77 - - *255 + - *254 responses: '204': description: Response @@ -36854,7 +39408,7 @@ paths: parameters: - *75 - *71 - - *255 + - *254 responses: '204': description: Response @@ -36886,7 +39440,7 @@ paths: parameters: - *75 - *71 - - *255 + - *254 responses: '204': description: Response @@ -36904,7 +39458,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: @@ -36915,13 +39469,13 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - *75 - - *255 + - *254 responses: '200': description: Response content: application/json: - schema: *256 + schema: *255 examples: default: value: @@ -36972,7 +39526,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - *75 - - *255 + - *254 - *17 - *19 responses: @@ -37050,8 +39604,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *257 - required: *258 + properties: *256 + required: *257 nullable: true type: description: The ownership type of the team @@ -37083,7 +39637,7 @@ paths: - type - parent examples: - default: *259 + default: *258 headers: Link: *67 '404': @@ -37113,7 +39667,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - *75 - - *255 + - *254 - *17 - *19 responses: @@ -37141,13 +39695,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &331 + items: &330 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *257 - required: *258 + properties: *256 + required: *257 name: nullable: true type: string @@ -37435,7 +39989,7 @@ paths: - nuget - container - *75 - - &693 + - &692 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -37471,12 +40025,12 @@ paths: application/json: schema: type: array - items: *260 + items: *259 examples: - default: *261 + default: *260 '403': *29 '401': *25 - '400': &695 + '400': &694 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -37498,7 +40052,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &262 + - &261 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 @@ -37516,7 +40070,7 @@ paths: - docker - nuget - container - - &263 + - &262 name: package_name description: The name of the package. in: path @@ -37529,7 +40083,7 @@ paths: description: Response content: application/json: - schema: *260 + schema: *259 examples: default: value: @@ -37581,8 +40135,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: + - *261 - *262 - - *263 - *75 responses: '204': @@ -37615,8 +40169,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: + - *261 - *262 - - *263 - *75 - name: token description: package token @@ -37649,8 +40203,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: + - *261 - *262 - - *263 - *75 - *19 - *17 @@ -37671,7 +40225,7 @@ paths: application/json: schema: type: array - items: &264 + items: &263 title: Package Version description: A version of a software package type: object @@ -37796,10 +40350,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: + - *261 - *262 - - *263 - *75 - - &265 + - &264 name: package_version_id description: Unique identifier of the package version. in: path @@ -37811,7 +40365,7 @@ paths: description: Response content: application/json: - schema: *264 + schema: *263 examples: default: value: @@ -37847,10 +40401,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: + - *261 - *262 - - *263 - *75 - - *265 + - *264 responses: '204': description: Response @@ -37882,10 +40436,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: + - *261 - *262 - - *263 - *75 - - *265 + - *264 responses: '204': description: Response @@ -37915,7 +40469,7 @@ paths: - *75 - *17 - *19 - - &267 + - &266 name: sort description: The property by which to sort the results. in: query @@ -37926,7 +40480,7 @@ paths: - created_at default: created_at - *61 - - &268 + - &267 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -37937,7 +40491,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &269 + - &268 name: repository description: The name of the repository to use to filter the results. in: query @@ -37945,7 +40499,7 @@ paths: schema: type: string example: Hello-World - - &270 + - &269 name: permission description: The permission to use to filter the results. in: query @@ -37953,7 +40507,7 @@ paths: schema: type: string example: issues_read - - &271 + - &270 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) @@ -37963,7 +40517,7 @@ paths: schema: type: string format: date-time - - &272 + - &271 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) @@ -37973,7 +40527,7 @@ paths: schema: type: string format: date-time - - &273 + - &272 name: token_id description: The ID of the token in: query @@ -38243,7 +40797,7 @@ paths: '422': *15 '404': *6 '403': *29 - '204': *192 + '204': *191 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38284,9 +40838,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *266 + default: *265 headers: Link: *67 x-github: @@ -38312,14 +40866,14 @@ paths: - *75 - *17 - *19 - - *267 + - *266 - *61 + - *267 - *268 - *269 - *270 - *271 - *272 - - *273 responses: '500': *55 '422': *15 @@ -38558,7 +41112,7 @@ paths: responses: '500': *55 '404': *6 - '204': *192 + '204': *191 '403': *29 '422': *15 x-github: @@ -38599,9 +41153,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *266 + default: *265 headers: Link: *67 x-github: @@ -38643,7 +41197,7 @@ paths: type: integer configurations: type: array - items: &274 + items: &273 title: Organization private registry description: Private registry configuration for an organization type: object @@ -39071,7 +41625,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &275 + org-private-registry-with-selected-visibility: &274 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -39161,15 +41715,15 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - *75 - - *169 + - *168 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *274 + schema: *273 examples: - default: *275 + default: *274 '404': *6 x-github: githubCloudOnly: false @@ -39192,7 +41746,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -39356,7 +41910,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - *75 - - *169 + - *168 responses: '204': description: Response @@ -39396,7 +41950,7 @@ paths: application/json: schema: type: array - items: &276 + items: &275 title: Projects v2 Project description: A projects v2 project type: object @@ -39466,7 +42020,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &783 + properties: &782 id: type: number description: The unique identifier of the status update. @@ -39514,7 +42068,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &784 + required: &783 - id - node_id - created_at @@ -39539,7 +42093,7 @@ paths: - deleted_at - deleted_by examples: - default: &277 + default: &276 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -39642,7 +42196,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &278 + - &277 name: project_number description: The project's number. in: path @@ -39655,9 +42209,9 @@ paths: description: Response content: application/json: - schema: *276 + schema: *275 examples: - default: *277 + default: *276 headers: Link: *67 '304': *37 @@ -39680,7 +42234,7 @@ paths: url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - *75 - - *278 + - *277 requestBody: required: true description: Details of the draft item to create in the project. @@ -39714,7 +42268,7 @@ paths: description: Response content: application/json: - schema: &284 + schema: &283 title: Projects v2 Item description: An item belonging to a project type: object @@ -39728,7 +42282,7 @@ paths: content: oneOf: - *85 - - &480 + - &479 title: Pull Request Simple description: Pull Request Simple type: object @@ -39834,8 +42388,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *279 - required: *280 + properties: *278 + required: *279 nullable: true active_lock_reason: type: string @@ -39878,7 +42432,7 @@ paths: items: *4 requested_teams: type: array - items: *198 + items: *197 head: type: object properties: @@ -39928,7 +42482,7 @@ paths: _links: type: object properties: - comments: &281 + comments: &280 title: Link description: Hypermedia Link type: object @@ -39937,13 +42491,13 @@ paths: type: string required: - href - commits: *281 - statuses: *281 - html: *281 - issue: *281 - review_comments: *281 - review_comment: *281 - self: *281 + commits: *280 + statuses: *280 + html: *280 + issue: *280 + review_comments: *280 + review_comment: *280 + self: *280 required: - comments - commits @@ -39954,7 +42508,7 @@ paths: - review_comment - self author_association: *82 - auto_merge: &589 + auto_merge: &588 title: Auto merge description: The status of auto merging a pull request. type: object @@ -40056,7 +42610,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &283 + content_type: &282 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -40096,7 +42650,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &285 + draft_issue: &284 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -40170,7 +42724,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *278 + - *277 - *75 - *17 - *47 @@ -40182,7 +42736,7 @@ paths: application/json: schema: type: array - items: &282 + items: &281 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -40332,7 +42886,7 @@ paths: - updated_at - project_url examples: - default: &714 + default: &713 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -40462,7 +43016,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project parameters: - - *278 + - *277 - *75 requestBody: required: true @@ -40509,7 +43063,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &715 + items: &714 type: object properties: name: @@ -40546,7 +43100,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &716 + iteration_configuration: &715 type: object description: The configuration for iteration fields. properties: @@ -40596,7 +43150,7 @@ paths: value: name: Due date data_type: date - single_select_field: &717 + single_select_field: &716 summary: Create a single select field value: name: Priority @@ -40623,7 +43177,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &718 + iteration_field: &717 summary: Create an iteration field value: name: Sprint @@ -40647,9 +43201,9 @@ paths: description: Response for adding a field to an organization-owned project. content: application/json: - schema: *282 + schema: *281 examples: - text_field: &719 + text_field: &718 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -40658,7 +43212,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: &720 + number_field: &719 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -40667,7 +43221,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: &721 + date_field: &720 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -40676,7 +43230,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: &722 + single_select_field: &721 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -40710,7 +43264,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &723 + iteration_field: &722 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -40755,8 +43309,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *278 - - &724 + - *277 + - &723 name: field_id description: The unique identifier of the field. in: path @@ -40769,9 +43323,9 @@ paths: description: Response content: application/json: - schema: *282 + schema: *281 examples: - default: &725 + default: &724 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -40827,7 +43381,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *278 + - *277 - *75 - 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) @@ -40860,7 +43414,7 @@ paths: application/json: schema: type: array - items: &286 + items: &285 title: Projects v2 Item description: An item belonging to a project type: object @@ -40876,7 +43430,7 @@ paths: format: uri example: https://api.github.com/users/monalisa/2/projectsV2/3 description: The API URL of the project that contains this item. - content_type: *283 + content_type: *282 content: type: object additionalProperties: true @@ -40919,7 +43473,7 @@ paths: - updated_at - archived_at examples: - default: &287 + default: &286 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -41617,7 +44171,7 @@ paths: url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - *75 - - *278 + - *277 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -41687,22 +44241,22 @@ paths: description: Response content: application/json: - schema: *284 + schema: *283 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *285 + value: *284 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *285 + value: *284 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *285 + value: *284 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *285 + value: *284 '304': *37 '403': *29 '401': *25 @@ -41722,9 +44276,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *278 + - *277 - *75 - - &288 + - &287 name: item_id description: The unique identifier of the project item. in: path @@ -41750,9 +44304,9 @@ paths: description: Response content: application/json: - schema: *286 + schema: *285 examples: - default: *287 + default: *286 headers: Link: *67 '304': *37 @@ -41773,9 +44327,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *278 + - *277 - *75 - - *288 + - *287 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -41845,13 +44399,13 @@ paths: description: Response content: application/json: - schema: *286 + schema: *285 examples: - text_field: *287 - number_field: *287 - date_field: *287 - single_select_field: *287 - iteration_field: *287 + text_field: *286 + number_field: *286 + date_field: *286 + single_select_field: *286 + iteration_field: *286 '401': *25 '403': *29 '404': *6 @@ -41871,9 +44425,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *278 + - *277 - *75 - - *288 + - *287 responses: '204': description: Response @@ -41897,7 +44451,7 @@ paths: url: https://docs.github.com/rest/projects/views#create-a-view-for-an-organization-owned-project parameters: - *75 - - *278 + - *277 requestBody: required: true content: @@ -41968,7 +44522,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &706 + schema: &705 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -42066,7 +44620,7 @@ paths: examples: table_view: summary: Response for creating a table view - value: &289 + value: &288 value: id: 1 number: 1 @@ -42112,10 +44666,10 @@ paths: - 456 board_view: summary: Response for creating a board view with filter - value: *289 + value: *288 roadmap_view: summary: Response for creating a roadmap view - value: *289 + value: *288 '304': *37 '403': *29 '401': *25 @@ -42143,9 +44697,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-project-view parameters: - - *278 + - *277 - *75 - - &726 + - &725 name: view_number description: The number that identifies the project view. in: path @@ -42177,9 +44731,9 @@ paths: application/json: schema: type: array - items: *286 + items: *285 examples: - default: *287 + default: *286 headers: Link: *67 '304': *37 @@ -42212,7 +44766,7 @@ paths: application/json: schema: type: array - items: &290 + items: &289 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -42280,7 +44834,7 @@ paths: - property_name - value_type examples: - default: &291 + default: &290 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -42340,7 +44894,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *290 + items: *289 minItems: 1 maxItems: 100 required: @@ -42370,9 +44924,9 @@ paths: application/json: schema: type: array - items: *290 + items: *289 examples: - default: *291 + default: *290 '403': *29 '404': *6 x-github: @@ -42394,7 +44948,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - *75 - - &292 + - &291 name: custom_property_name description: The custom property name in: path @@ -42406,9 +44960,9 @@ paths: description: Response content: application/json: - schema: *290 + schema: *289 examples: - default: &293 + default: &292 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -42443,7 +44997,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - *75 - - *292 + - *291 requestBody: required: true content: @@ -42514,9 +45068,9 @@ paths: description: Response content: application/json: - schema: *290 + schema: *289 examples: - default: *293 + default: *292 '403': *29 '404': *6 x-github: @@ -42540,9 +45094,9 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - *75 - - *292 + - *291 responses: - '204': *192 + '204': *191 '403': *29 '404': *6 x-github: @@ -42601,7 +45155,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &294 + items: &293 title: Custom Property Value description: Custom property name and associated value type: object @@ -42688,7 +45242,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *294 + items: *293 required: - repository_names - properties @@ -42878,9 +45432,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *266 + default: *265 headers: Link: *67 x-github: @@ -43082,7 +45636,7 @@ paths: description: Response content: application/json: - schema: &345 + schema: &344 title: Full Repository description: Full Repository type: object @@ -43370,8 +45924,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *295 - required: *296 + properties: *294 + required: *295 nullable: true temp_clone_token: type: string @@ -43486,7 +46040,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &485 + properties: &484 url: type: string format: uri @@ -43502,12 +46056,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &486 + required: &485 - url - key - name - html_url - security_and_analysis: *297 + security_and_analysis: *296 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -43591,7 +46145,7 @@ paths: - network_count - subscribers_count examples: - default: &347 + default: &346 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -44112,7 +46666,7 @@ paths: - *75 - *17 - *19 - - &611 + - &610 name: targets description: | A comma-separated list of rule targets to filter by. @@ -44130,7 +46684,7 @@ paths: application/json: schema: type: array - items: &324 + items: &323 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -44165,7 +46719,7 @@ paths: source: type: string description: The name of the source - enforcement: &300 + enforcement: &299 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -44178,7 +46732,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &301 + items: &300 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -44248,7 +46802,7 @@ paths: conditions: nullable: true anyOf: - - &298 + - &297 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -44272,7 +46826,7 @@ paths: match. items: type: string - - &302 + - &301 title: Organization ruleset conditions type: object description: |- @@ -44286,7 +46840,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *298 + - *297 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -44320,7 +46874,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *298 + - *297 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -44342,7 +46896,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *298 + - *297 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -44355,7 +46909,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &299 + items: &298 title: Repository ruleset property targeting definition type: object @@ -44388,17 +46942,17 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *299 + items: *298 required: - repository_property rules: type: array - items: &612 + items: &611 title: Repository Rule type: object description: A repository rule. oneOf: - - &303 + - &302 title: creation description: Only allow users with bypass permission to create matching refs. @@ -44410,7 +46964,7 @@ paths: type: string enum: - creation - - &304 + - &303 title: update description: Only allow users with bypass permission to update matching refs. @@ -44431,7 +46985,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &305 + - &304 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -44443,7 +46997,7 @@ paths: type: string enum: - deletion - - &306 + - &305 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -44455,7 +47009,7 @@ paths: type: string enum: - required_linear_history - - &610 + - &609 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -44533,7 +47087,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &307 + - &306 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -44557,7 +47111,7 @@ paths: type: string required: - required_deployment_environments - - &308 + - &307 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -44569,7 +47123,7 @@ paths: type: string enum: - required_signatures - - &309 + - &308 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -44675,7 +47229,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &310 + - &309 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -44723,7 +47277,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &311 + - &310 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -44735,7 +47289,7 @@ paths: type: string enum: - non_fast_forward - - &312 + - &311 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -44772,7 +47326,7 @@ paths: required: - operator - pattern - - &313 + - &312 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -44809,7 +47363,7 @@ paths: required: - operator - pattern - - &314 + - &313 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -44846,7 +47400,7 @@ paths: required: - operator - pattern - - &315 + - &314 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -44883,7 +47437,7 @@ paths: required: - operator - pattern - - &316 + - &315 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -44920,7 +47474,7 @@ paths: required: - operator - pattern - - &317 + - &316 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -44945,7 +47499,7 @@ paths: type: string required: - restricted_file_paths - - &318 + - &317 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -44969,7 +47523,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &319 + - &318 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -44992,7 +47546,7 @@ paths: type: string required: - restricted_file_extensions - - &320 + - &319 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -45017,7 +47571,7 @@ paths: maximum: 100 required: - max_file_size - - &321 + - &320 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -45067,7 +47621,7 @@ paths: - repository_id required: - workflows - - &322 + - &321 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -45128,7 +47682,7 @@ paths: - tool required: - code_scanning_tools - - &323 + - &322 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -45227,20 +47781,21 @@ paths: - push - repository default: branch - enforcement: *300 + enforcement: *299 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *301 - conditions: *302 + items: *300 + conditions: *301 rules: type: array description: An array of rules within the ruleset. - items: &326 + items: &325 title: Repository Rule type: object description: A repository rule. oneOf: + - *302 - *303 - *304 - *305 @@ -45261,7 +47816,6 @@ paths: - *320 - *321 - *322 - - *323 required: - name - enforcement @@ -45299,9 +47853,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *323 examples: - default: &325 + default: &324 value: id: 21 name: super cool ruleset @@ -45357,7 +47911,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *75 - - &613 + - &612 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 @@ -45372,7 +47926,7 @@ paths: in: query schema: type: string - - &614 + - &613 name: time_period description: |- The time period to filter by. @@ -45388,14 +47942,14 @@ paths: - week - month default: day - - &615 + - &614 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 - - &616 + - &615 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -45415,7 +47969,7 @@ paths: description: Response content: application/json: - schema: &617 + schema: &616 title: Rule Suites description: Response type: array @@ -45470,7 +48024,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &618 + default: &617 value: - id: 21 actor_id: 12 @@ -45514,7 +48068,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *75 - - &619 + - &618 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -45530,7 +48084,7 @@ paths: description: Response content: application/json: - schema: &620 + schema: &619 title: Rule Suite description: Response type: object @@ -45629,7 +48183,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &621 + default: &620 value: id: 21 actor_id: 12 @@ -45702,9 +48256,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *323 examples: - default: *325 + default: *324 '404': *6 '500': *55 put: @@ -45748,16 +48302,16 @@ paths: - tag - push - repository - enforcement: *300 + enforcement: *299 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *301 - conditions: *302 + items: *300 + conditions: *301 rules: description: An array of rules within the ruleset. type: array - items: *326 + items: *325 examples: default: value: @@ -45792,9 +48346,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *323 examples: - default: *325 + default: *324 '404': *6 '422': *15 '500': *55 @@ -45852,7 +48406,7 @@ paths: application/json: schema: type: array - items: &327 + items: &326 title: Ruleset version type: object description: The historical version of a ruleset @@ -45876,7 +48430,7 @@ paths: type: string format: date-time examples: - default: &623 + default: &622 value: - version_id: 3 actor: @@ -45929,9 +48483,9 @@ paths: description: Response content: application/json: - schema: &624 + schema: &623 allOf: - - *327 + - *326 - type: object required: - state @@ -46001,7 +48555,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *75 - - &625 + - &624 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -46012,7 +48566,7 @@ paths: enum: - open - resolved - - &626 + - &625 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -46022,7 +48576,7 @@ paths: required: false schema: type: string - - &627 + - &626 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -46031,7 +48585,7 @@ paths: required: false schema: type: string - - &628 + - &627 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -46050,7 +48604,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &629 + - &628 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. @@ -46065,7 +48619,7 @@ paths: - *61 - *19 - *17 - - &630 + - &629 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 @@ -46075,7 +48629,7 @@ paths: required: false schema: type: string - - &631 + - &630 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 @@ -46085,7 +48639,7 @@ paths: required: false schema: type: string - - &632 + - &631 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -46094,7 +48648,7 @@ paths: required: false schema: type: string - - &633 + - &632 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -46103,7 +48657,7 @@ paths: schema: type: boolean default: false - - &634 + - &633 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -46112,7 +48666,7 @@ paths: schema: type: boolean default: false - - &635 + - &634 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -46131,8 +48685,8 @@ paths: items: type: object properties: - number: *179 - created_at: *180 + number: *178 + created_at: *179 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -46140,21 +48694,21 @@ paths: format: date-time readOnly: true nullable: true - url: *182 - html_url: *183 + url: *181 + html_url: *182 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &636 + state: &635 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: &637 + resolution: &636 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -46261,8 +48815,8 @@ paths: pull request. ' - oneOf: &638 - - &640 + oneOf: &637 + - &639 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -46304,6 +48858,12 @@ 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. + example: https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1 required: - path - start_line @@ -46314,7 +48874,7 @@ paths: - blob_url - commit_sha - commit_url - - &641 + - &640 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. @@ -46369,7 +48929,7 @@ paths: - page_url - commit_sha - commit_url - - &642 + - &641 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -46381,9 +48941,15 @@ paths: description: The API URL to get the issue where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &643 + - &642 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -46395,9 +48961,15 @@ paths: description: The API URL to get the issue where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &644 + - &643 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -46409,9 +48981,15 @@ paths: description: The API URL to get the issue comment where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &645 + - &644 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -46425,7 +49003,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &646 + - &645 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -46439,7 +49017,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &647 + - &646 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -46453,7 +49031,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &648 + - &647 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. @@ -46465,9 +49043,15 @@ paths: description: The API URL to get the pull request where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &649 + - &648 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. @@ -46479,9 +49063,15 @@ paths: description: The API URL to get the pull request where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &650 + - &649 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. @@ -46493,9 +49083,15 @@ paths: description: The API URL to get the pull request comment where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &651 + - &650 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. @@ -46507,9 +49103,15 @@ paths: description: The API URL to get the pull request review where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &652 + - &651 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -46521,6 +49123,12 @@ paths: description: The API URL to get the pull request review comment where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846#discussion_r12 required: - pull_request_review_comment_url nullable: true @@ -46751,7 +49359,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &329 + pattern_config_version: &328 type: string description: The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate @@ -46760,7 +49368,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &328 + items: &327 type: object properties: token_type: @@ -46826,7 +49434,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *328 + items: *327 examples: default: value: @@ -46883,7 +49491,7 @@ paths: schema: type: object properties: - pattern_config_version: *329 + pattern_config_version: *328 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -46909,7 +49517,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *329 + custom_pattern_version: *328 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -47007,7 +49615,7 @@ paths: application/json: schema: type: array - items: &656 + items: &655 description: A repository security advisory. type: object properties: @@ -47227,7 +49835,7 @@ paths: login: type: string description: The username of the user credited. - type: *330 + type: *329 credits_detailed: type: array nullable: true @@ -47237,7 +49845,7 @@ paths: type: object properties: user: *4 - type: *330 + type: *329 state: type: string description: The state of the user's acceptance of the @@ -47261,7 +49869,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *198 + items: *197 private_fork: readOnly: true nullable: true @@ -47298,7 +49906,7 @@ paths: - private_fork additionalProperties: false examples: - default: &657 + default: &656 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -47685,7 +50293,7 @@ paths: application/json: schema: type: array - items: *331 + items: *330 examples: default: value: @@ -47903,9 +50511,9 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 examples: - default: *173 + default: *172 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47974,7 +50582,7 @@ paths: url: https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *75 - - *150 + - *149 responses: '204': description: Response @@ -47997,7 +50605,7 @@ paths: url: https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *75 - - *150 + - *149 responses: '204': description: Response @@ -48038,7 +50646,7 @@ paths: type: integer network_configurations: type: array - items: &332 + items: &331 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -48156,6 +50764,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 @@ -48171,9 +50792,9 @@ paths: description: Response content: application/json: - schema: *332 + schema: *331 examples: - default: &333 + default: &332 value: id: 123456789ABCDEF name: My network configuration @@ -48202,7 +50823,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - *75 - - &334 + - &333 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -48214,9 +50835,9 @@ paths: description: Response content: application/json: - schema: *332 + schema: *331 examples: - default: *333 + default: *332 headers: Link: *67 x-github: @@ -48238,7 +50859,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - *75 - - *334 + - *333 requestBody: required: true content: @@ -48266,6 +50887,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: @@ -48278,9 +50912,9 @@ paths: description: Response content: application/json: - schema: *332 + schema: *331 examples: - default: *333 + default: *332 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48300,7 +50934,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - *75 - - *334 + - *333 responses: '204': description: Response @@ -48440,13 +51074,13 @@ paths: application/json: schema: type: array - items: *335 + items: *334 examples: - default: *336 + default: *335 '500': *55 '403': *29 '404': *6 - '422': *337 + '422': *336 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48486,9 +51120,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *259 + default: *258 headers: Link: *67 '403': *29 @@ -48582,7 +51216,7 @@ paths: description: Response content: application/json: - schema: &338 + schema: &337 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -48645,8 +51279,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *257 - required: *258 + properties: *256 + required: *257 nullable: true members_count: type: integer @@ -48909,7 +51543,7 @@ paths: - repos_count - organization examples: - default: &339 + default: &338 value: id: 1 node_id: MDQ6VGVhbTE= @@ -48986,9 +51620,9 @@ paths: description: Response content: application/json: - schema: *338 + schema: *337 examples: - default: *339 + default: *338 '404': *6 x-github: githubCloudOnly: false @@ -49072,16 +51706,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *338 + schema: *337 examples: - default: *339 + default: *338 '201': description: Response content: application/json: - schema: *338 + schema: *337 examples: - default: *339 + default: *338 '404': *6 '422': *15 '403': *29 @@ -49111,7 +51745,7 @@ paths: responses: '204': description: Response - '422': &340 + '422': &339 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -49145,12 +51779,12 @@ paths: application/json: schema: type: array - items: *236 + items: *235 examples: - default: *237 + default: *236 headers: Link: *67 - '422': *340 + '422': *339 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49232,7 +51866,7 @@ paths: description: Response content: application/json: - schema: &341 + schema: &340 title: Team Membership description: Team Membership type: object @@ -49259,7 +51893,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &673 + response-if-user-is-a-team-maintainer: &672 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -49322,9 +51956,9 @@ paths: description: Response content: application/json: - schema: *341 + schema: *340 examples: - response-if-users-membership-with-team-is-now-pending: &674 + response-if-users-membership-with-team-is-now-pending: &673 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -49398,9 +52032,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *266 + default: *265 headers: Link: *67 x-github: @@ -49431,14 +52065,14 @@ paths: parameters: - *75 - *77 + - *341 - *342 - - *343 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &675 + schema: &674 title: Team Repository description: A team's access to a repository. type: object @@ -50009,8 +52643,8 @@ paths: parameters: - *75 - *77 + - *341 - *342 - - *343 requestBody: required: false content: @@ -50057,8 +52691,8 @@ paths: parameters: - *75 - *77 + - *341 - *342 - - *343 responses: '204': description: Response @@ -50093,9 +52727,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - response-if-child-teams-exist: &676 + response-if-child-teams-exist: &675 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -50249,7 +52883,7 @@ paths: resources: type: object properties: - core: &344 + core: &343 title: Rate Limit type: object properties: @@ -50266,21 +52900,21 @@ paths: - remaining - reset - used - graphql: *344 - search: *344 - code_search: *344 - source_import: *344 - integration_manifest: *344 - code_scanning_upload: *344 - actions_runner_registration: *344 - scim: *344 - dependency_snapshots: *344 - dependency_sbom: *344 - code_scanning_autofix: *344 + graphql: *343 + search: *343 + code_search: *343 + source_import: *343 + integration_manifest: *343 + code_scanning_upload: *343 + actions_runner_registration: *343 + scim: *343 + dependency_snapshots: *343 + dependency_sbom: *343 + code_scanning_autofix: *343 required: - core - search - rate: *344 + rate: *343 required: - rate - resources @@ -50385,14 +53019,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *345 + schema: *344 examples: default-response: summary: Default response @@ -50897,7 +53531,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *346 + '301': *345 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50915,8 +53549,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: + - *341 - *342 - - *343 requestBody: required: false content: @@ -51207,10 +53841,10 @@ paths: description: Response content: application/json: - schema: *345 + schema: *344 examples: - default: *347 - '307': &348 + default: *346 + '307': &347 description: Temporary Redirect content: application/json: @@ -51239,8 +53873,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -51262,7 +53896,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *348 + '307': *347 '404': *6 '409': *54 x-github: @@ -51286,11 +53920,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: + - *341 - *342 - - *343 - *17 - *19 - - &381 + - &380 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -51313,7 +53947,7 @@ paths: type: integer artifacts: type: array - items: &349 + items: &348 title: Artifact description: An artifact type: object @@ -51391,7 +54025,7 @@ paths: - expires_at - updated_at examples: - default: &382 + default: &381 value: total_count: 2 artifacts: @@ -51452,9 +54086,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: + - *341 - *342 - - *343 - - &350 + - &349 name: artifact_id description: The unique identifier of the artifact. in: path @@ -51466,7 +54100,7 @@ paths: description: Response content: application/json: - schema: *349 + schema: *348 examples: default: value: @@ -51504,9 +54138,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: + - *341 - *342 - - *343 - - *350 + - *349 responses: '204': description: Response @@ -51530,9 +54164,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: + - *341 - *342 - - *343 - - *350 + - *349 - name: archive_format in: path required: true @@ -51546,7 +54180,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': &542 + '410': &541 description: Gone content: application/json: @@ -51571,14 +54205,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: &351 + schema: &350 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -51611,13 +54245,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: + - *341 - *342 - - *343 requestBody: required: true content: application/json: - schema: *351 + schema: *350 examples: selected_actions: *42 responses: @@ -51646,14 +54280,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: &352 + schema: &351 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -51686,13 +54320,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: + - *341 - *342 - - *343 requestBody: required: true content: application/json: - schema: *352 + schema: *351 examples: selected_actions: *44 responses: @@ -51723,14 +54357,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *353 + schema: *352 examples: default: value: @@ -51756,11 +54390,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: + - *341 - *342 - - *343 - *17 - *19 - - &354 + - &353 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 @@ -51794,7 +54428,7 @@ paths: description: Response content: application/json: - schema: &355 + schema: &354 title: Repository actions caches description: Repository actions caches type: object @@ -51836,7 +54470,7 @@ paths: - total_count - actions_caches examples: - default: &356 + default: &355 value: total_count: 1 actions_caches: @@ -51868,23 +54502,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: + - *341 - *342 - - *343 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *354 + - *353 responses: '200': description: Response content: application/json: - schema: *355 + schema: *354 examples: - default: *356 + default: *355 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51904,8 +54538,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: + - *341 - *342 - - *343 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -51936,9 +54570,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: + - *341 - *342 - - *343 - - &357 + - &356 name: job_id description: The unique identifier of the job. in: path @@ -51950,7 +54584,7 @@ paths: description: Response content: application/json: - schema: &385 + schema: &384 title: Job description: Information of a job execution in a workflow run type: object @@ -52257,9 +54891,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: + - *341 - *342 - - *343 - - *357 + - *356 responses: '302': description: Response @@ -52287,9 +54921,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: + - *341 - *342 - - *343 - - *357 + - *356 requestBody: required: false content: @@ -52310,7 +54944,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -52334,8 +54968,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: + - *341 - *342 - - *343 responses: '200': description: Status response @@ -52385,8 +55019,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: + - *341 - *342 - - *343 requestBody: required: true content: @@ -52420,7 +55054,7 @@ paths: description: Empty response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -52449,8 +55083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -52468,7 +55102,7 @@ paths: type: integer secrets: type: array - items: &387 + items: &386 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -52488,7 +55122,7 @@ paths: - created_at - updated_at examples: - default: &388 + default: &387 value: total_count: 2 secrets: @@ -52521,9 +55155,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: + - *341 - *342 - - *343 - - *358 + - *357 - *19 responses: '200': @@ -52540,7 +55174,7 @@ paths: type: integer variables: type: array - items: &391 + items: &390 title: Actions Variable type: object properties: @@ -52570,7 +55204,7 @@ paths: - created_at - updated_at examples: - default: &392 + default: &391 value: total_count: 2 variables: @@ -52603,8 +55237,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -52613,12 +55247,12 @@ paths: schema: type: object properties: - enabled: &360 + enabled: &359 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *146 - selected_actions_url: *359 - sha_pinning_required: *147 + allowed_actions: *145 + selected_actions_url: *358 + sha_pinning_required: *146 required: - enabled examples: @@ -52646,8 +55280,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -52658,9 +55292,9 @@ paths: schema: type: object properties: - enabled: *360 - allowed_actions: *146 - sha_pinning_required: *147 + enabled: *359 + allowed_actions: *145 + sha_pinning_required: *146 required: - enabled examples: @@ -52690,14 +55324,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: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: &361 + schema: &360 type: object properties: access_level: @@ -52714,7 +55348,7 @@ paths: required: - access_level examples: - default: &362 + default: &361 value: access_level: organization x-github: @@ -52738,15 +55372,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: + - *341 - *342 - - *343 requestBody: required: true content: application/json: - schema: *361 + schema: *360 examples: - default: *362 + default: *361 responses: '204': description: Response @@ -52770,14 +55404,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *363 + schema: *362 examples: default: value: @@ -52801,8 +55435,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: + - *341 - *342 - - *343 responses: '204': description: Empty response for successful settings update @@ -52812,7 +55446,7 @@ paths: required: true content: application/json: - schema: *364 + schema: *363 examples: default: summary: Set retention days @@ -52836,16 +55470,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *148 + schema: *147 examples: - default: *365 + default: *364 '404': *6 x-github: enabledForGitHubApps: true @@ -52864,8 +55498,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -52875,7 +55509,7 @@ paths: required: true content: application/json: - schema: *148 + schema: *147 examples: default: summary: Set approval policy to first time contributors @@ -52899,16 +55533,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: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *366 + schema: *365 examples: - default: *149 + default: *148 '403': *29 '404': *6 x-github: @@ -52928,15 +55562,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: + - *341 - *342 - - *343 requestBody: required: true content: application/json: - schema: *367 + schema: *366 examples: - default: *149 + default: *148 responses: '204': description: Empty response for successful settings update @@ -52960,16 +55594,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *151 + schema: *150 examples: - default: *152 + default: *151 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52988,8 +55622,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -52997,9 +55631,9 @@ paths: required: false content: application/json: - schema: *151 + schema: *150 examples: - selected_actions: *152 + selected_actions: *151 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53021,16 +55655,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *368 + schema: *367 examples: - default: *156 + default: *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53051,8 +55685,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: + - *341 - *342 - - *343 responses: '204': description: Success response @@ -53063,9 +55697,9 @@ paths: required: true content: application/json: - schema: *369 + schema: *368 examples: - default: *156 + default: *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53092,8 +55726,8 @@ paths: in: query schema: type: string + - *341 - *342 - - *343 - *17 - *19 responses: @@ -53111,9 +55745,9 @@ paths: type: integer runners: type: array - items: *163 + items: *162 examples: - default: *164 + default: *163 headers: Link: *67 x-github: @@ -53137,8 +55771,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -53146,9 +55780,9 @@ paths: application/json: schema: type: array - items: *370 + items: *369 examples: - default: *371 + default: *370 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53170,8 +55804,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: + - *341 - *342 - - *343 requestBody: required: true content: @@ -53214,7 +55848,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *372 + '201': *371 '404': *6 '422': *7 '409': *54 @@ -53245,16 +55879,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: + - *341 - *342 - - *343 responses: '201': description: Response content: application/json: - schema: *165 + schema: *164 examples: - default: *373 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53282,16 +55916,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: + - *341 - *342 - - *343 responses: '201': description: Response content: application/json: - schema: *165 + schema: *164 examples: - default: *374 + default: *373 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53313,17 +55947,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: + - *341 - *342 - - *343 - - *162 + - *161 responses: '200': description: Response content: application/json: - schema: *163 + schema: *162 examples: - default: *375 + default: *374 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53344,9 +55978,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: + - *341 - *342 - - *343 - - *162 + - *161 responses: '204': description: Response @@ -53372,11 +56006,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: + - *341 - *342 - - *343 - - *162 + - *161 responses: - '200': *167 + '200': *166 '404': *6 x-github: githubCloudOnly: false @@ -53398,9 +56032,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: + - *341 - *342 - - *343 - - *162 + - *161 requestBody: required: true content: @@ -53424,7 +56058,7 @@ paths: - gpu - accelerated responses: - '200': *167 + '200': *166 '404': *6 '422': *7 x-github: @@ -53448,9 +56082,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: + - *341 - *342 - - *343 - - *162 + - *161 requestBody: required: true content: @@ -53475,7 +56109,7 @@ paths: - gpu - accelerated responses: - '200': *167 + '200': *166 '404': *6 '422': *7 x-github: @@ -53499,11 +56133,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: + - *341 - *342 - - *343 - - *162 + - *161 responses: - '200': *376 + '200': *375 '404': *6 x-github: githubCloudOnly: false @@ -53530,12 +56164,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: + - *341 - *342 - - *343 - - *162 - - *377 + - *161 + - *376 responses: - '200': *167 + '200': *166 '404': *6 '422': *7 x-github: @@ -53561,9 +56195,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: + - *341 - *342 - - *343 - - &395 + - &394 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. @@ -53571,7 +56205,7 @@ paths: required: false schema: type: string - - &396 + - &395 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -53579,7 +56213,7 @@ paths: required: false schema: type: string - - &397 + - &396 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -53588,7 +56222,7 @@ paths: required: false schema: type: string - - &398 + - &397 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 @@ -53615,7 +56249,7 @@ paths: - pending - *17 - *19 - - &399 + - &398 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)." @@ -53624,7 +56258,7 @@ paths: schema: type: string format: date-time - - &378 + - &377 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -53633,13 +56267,13 @@ paths: schema: type: boolean default: false - - &400 + - &399 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &401 + - &400 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -53662,7 +56296,7 @@ paths: type: integer workflow_runs: type: array - items: &379 + items: &378 title: Workflow Run description: An invocation of a workflow type: object @@ -53810,7 +56444,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &423 + properties: &422 id: type: string description: SHA for the commit @@ -53861,7 +56495,7 @@ paths: - name - email nullable: true - required: &424 + required: &423 - id - tree_id - message @@ -53869,8 +56503,8 @@ paths: - author - committer nullable: true - repository: *161 - head_repository: *161 + repository: *160 + head_repository: *160 head_repository_id: type: integer example: 5 @@ -53908,7 +56542,7 @@ paths: - workflow_url - pull_requests examples: - default: &402 + default: &401 value: total_count: 1 workflow_runs: @@ -54144,24 +56778,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: + - *341 - *342 - - *343 - - &380 + - &379 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *378 + - *377 responses: '200': description: Response content: application/json: - schema: *379 + schema: *378 examples: - default: &383 + default: &382 value: id: 30433642 name: Build @@ -54402,9 +57036,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: + - *341 - *342 - - *343 - - *380 + - *379 responses: '204': description: Response @@ -54427,9 +57061,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: + - *341 - *342 - - *343 - - *380 + - *379 responses: '200': description: Response @@ -54548,15 +57182,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: + - *341 - *342 - - *343 - - *380 + - *379 responses: '201': description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -54583,12 +57217,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: + - *341 - *342 - - *343 - - *380 + - *379 - *17 - *19 - - *381 + - *380 - *61 responses: '200': @@ -54605,9 +57239,9 @@ paths: type: integer artifacts: type: array - items: *349 + items: *348 examples: - default: *382 + default: *381 headers: Link: *67 x-github: @@ -54631,25 +57265,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: + - *341 - *342 - - *343 - - *380 - - &384 + - *379 + - &383 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *378 + - *377 responses: '200': description: Response content: application/json: - schema: *379 + schema: *378 examples: - default: *383 + default: *382 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54672,10 +57306,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: + - *341 - *342 - - *343 - - *380 - - *384 + - *379 + - *383 - *17 - *19 responses: @@ -54693,9 +57327,9 @@ paths: type: integer jobs: type: array - items: *385 + items: *384 examples: - default: &386 + default: &385 value: total_count: 1 jobs: @@ -54808,10 +57442,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: + - *341 - *342 - - *343 - - *380 - - *384 + - *379 + - *383 responses: '302': description: Response @@ -54839,15 +57473,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: + - *341 - *342 - - *343 - - *380 + - *379 responses: '202': description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -54874,9 +57508,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: + - *341 - *342 - - *343 - - *380 + - *379 requestBody: required: true content: @@ -54943,15 +57577,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: + - *341 - *342 - - *343 - - *380 + - *379 responses: '202': description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -54978,9 +57612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: + - *341 - *342 - - *343 - - *380 + - *379 - 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 @@ -55010,9 +57644,9 @@ paths: type: integer jobs: type: array - items: *385 + items: *384 examples: - default: *386 + default: *385 headers: Link: *67 x-github: @@ -55037,9 +57671,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: + - *341 - *342 - - *343 - - *380 + - *379 responses: '302': description: Response @@ -55066,9 +57700,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: + - *341 - *342 - - *343 - - *380 + - *379 responses: '204': description: Response @@ -55095,9 +57729,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: + - *341 - *342 - - *343 - - *380 + - *379 responses: '200': description: Response @@ -55157,7 +57791,7 @@ paths: items: type: object properties: - type: &508 + type: &507 type: string description: The type of reviewer. enum: @@ -55167,7 +57801,7 @@ paths: reviewer: anyOf: - *4 - - *198 + - *197 required: - environment - wait_timer @@ -55242,9 +57876,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: + - *341 - *342 - - *343 - - *380 + - *379 requestBody: required: true content: @@ -55291,12 +57925,12 @@ paths: application/json: schema: type: array - items: &503 + items: &502 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &746 + properties: &745 url: type: string format: uri @@ -55381,7 +58015,7 @@ paths: nullable: true properties: *80 required: *81 - required: &747 + required: &746 - id - node_id - sha @@ -55397,7 +58031,7 @@ paths: - created_at - updated_at examples: - default: &504 + default: &503 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -55453,9 +58087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: + - *341 - *342 - - *343 - - *380 + - *379 requestBody: required: false content: @@ -55476,7 +58110,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -55499,9 +58133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: + - *341 - *342 - - *343 - - *380 + - *379 requestBody: required: false content: @@ -55522,7 +58156,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -55554,9 +58188,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: + - *341 - *342 - - *343 - - *380 + - *379 responses: '200': description: Response @@ -55693,8 +58327,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -55712,9 +58346,9 @@ paths: type: integer secrets: type: array - items: *387 + items: *386 examples: - default: *388 + default: *387 headers: Link: *67 x-github: @@ -55739,16 +58373,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *389 + schema: *388 examples: - default: *390 + default: *389 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55770,17 +58404,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: + - *341 - *342 - - *343 - - *169 + - *168 responses: '200': description: Response content: application/json: - schema: *387 + schema: *386 examples: - default: &521 + default: &520 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -55806,9 +58440,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: + - *341 - *342 - - *343 - - *169 + - *168 requestBody: required: true content: @@ -55839,7 +58473,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -55865,9 +58499,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: + - *341 - *342 - - *343 - - *169 + - *168 responses: '204': description: Response @@ -55892,9 +58526,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: + - *341 - *342 - - *343 - - *358 + - *357 - *19 responses: '200': @@ -55911,9 +58545,9 @@ paths: type: integer variables: type: array - items: *391 + items: *390 examples: - default: *392 + default: *391 headers: Link: *67 x-github: @@ -55936,8 +58570,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -55964,7 +58598,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -55989,17 +58623,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: + - *341 - *342 - - *343 - - *172 + - *171 responses: '200': description: Response content: application/json: - schema: *391 + schema: *390 examples: - default: &522 + default: &521 value: name: USERNAME value: octocat @@ -56025,9 +58659,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: + - *341 - *342 - - *343 - - *172 + - *171 requestBody: required: true content: @@ -56069,9 +58703,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: + - *341 - *342 - - *343 - - *172 + - *171 responses: '204': description: Response @@ -56096,8 +58730,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -56115,7 +58749,7 @@ paths: type: integer workflows: type: array - items: &393 + items: &392 title: Workflow description: A GitHub Actions workflow type: object @@ -56222,9 +58856,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: + - *341 - *342 - - *343 - - &394 + - &393 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -56239,7 +58873,7 @@ paths: description: Response content: application/json: - schema: *393 + schema: *392 examples: default: value: @@ -56272,9 +58906,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: + - *341 - *342 - - *343 - - *394 + - *393 responses: '204': description: Response @@ -56299,9 +58933,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: + - *341 - *342 - - *343 - - *394 + - *393 responses: '204': description: Empty response when `return_run_details` parameter is `false`. @@ -56388,9 +59022,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: + - *341 - *342 - - *343 - - *394 + - *393 responses: '204': description: Response @@ -56417,19 +59051,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: + - *341 - *342 - - *343 + - *393 - *394 - *395 - *396 - *397 - - *398 - *17 - *19 + - *398 + - *377 - *399 - - *378 - *400 - - *401 responses: '200': description: Response @@ -56445,9 +59079,9 @@ paths: type: integer workflow_runs: type: array - items: *379 + items: *378 examples: - default: *402 + default: *401 headers: Link: *67 x-github: @@ -56479,9 +59113,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: + - *341 - *342 - - *343 - - *394 + - *393 responses: '200': description: Response @@ -56542,8 +59176,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: + - *341 - *342 - - *343 - *61 - *17 - *47 @@ -56707,8 +59341,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -56745,8 +59379,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: + - *341 - *342 - - *343 - name: assignee in: path required: true @@ -56782,8 +59416,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -56893,8 +59527,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: + - *341 - *342 - - *343 - *17 - *47 - *48 @@ -56951,7 +59585,7 @@ paths: initiator: type: string examples: - default: *403 + default: *402 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56971,8 +59605,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -56980,7 +59614,7 @@ paths: application/json: schema: type: array - items: &404 + items: &403 title: Autolink reference description: An autolink reference. type: object @@ -57034,8 +59668,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -57074,9 +59708,9 @@ paths: description: response content: application/json: - schema: *404 + schema: *403 examples: - default: &405 + default: &404 value: id: 1 key_prefix: TICKET- @@ -57107,9 +59741,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: + - *341 - *342 - - *343 - - &406 + - &405 name: autolink_id description: The unique identifier of the autolink. in: path @@ -57121,9 +59755,9 @@ paths: description: Response content: application/json: - schema: *404 + schema: *403 examples: - default: *405 + default: *404 '404': *6 x-github: githubCloudOnly: false @@ -57143,9 +59777,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: + - *341 - *342 - - *343 - - *406 + - *405 responses: '204': description: Response @@ -57169,8 +59803,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: + - *341 - *342 - - *343 responses: '200': description: Response if Dependabot is enabled @@ -57218,8 +59852,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -57240,8 +59874,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -57261,8 +59895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: + - *341 - *342 - - *343 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -57300,7 +59934,7 @@ paths: - url protected: type: boolean - protection: &408 + protection: &407 title: Branch Protection description: Branch Protection type: object @@ -57342,7 +59976,7 @@ paths: required: - contexts - checks - enforce_admins: &411 + enforce_admins: &410 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -57357,7 +59991,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &413 + required_pull_request_reviews: &412 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -57378,7 +60012,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *198 + items: *197 apps: description: The list of apps with review dismissal access. @@ -57407,7 +60041,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *198 + items: *197 apps: description: The list of apps allowed to bypass pull request requirements. @@ -57433,7 +60067,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &410 + restrictions: &409 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -57496,7 +60130,7 @@ paths: type: string teams: type: array - items: *198 + items: *197 apps: type: array items: @@ -57710,9 +60344,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: + - *341 - *342 - - *343 - - &409 + - &408 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). @@ -57726,14 +60360,14 @@ paths: description: Response content: application/json: - schema: &419 + schema: &418 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &476 + commit: &475 title: Commit description: Commit type: object @@ -57767,7 +60401,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &407 + properties: &406 name: type: string example: '"Chris Wanstrath"' @@ -57783,7 +60417,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *407 + properties: *406 nullable: true message: type: string @@ -57804,7 +60438,7 @@ paths: required: - sha - url - verification: &528 + verification: &527 title: Verification type: object properties: @@ -57838,12 +60472,12 @@ paths: nullable: true oneOf: - *4 - - *170 + - *169 committer: nullable: true oneOf: - *4 - - *170 + - *169 parents: type: array items: @@ -57874,7 +60508,7 @@ paths: type: integer files: type: array - items: &489 + items: &488 title: Diff Entry description: Diff Entry type: object @@ -57958,7 +60592,7 @@ paths: - self protected: type: boolean - protection: *408 + protection: *407 protection_url: type: string format: uri @@ -58065,7 +60699,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *346 + '301': *345 '404': *6 x-github: githubCloudOnly: false @@ -58087,15 +60721,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response content: application/json: - schema: *408 + schema: *407 examples: default: value: @@ -58289,9 +60923,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: true content: @@ -58546,7 +61180,7 @@ paths: url: type: string format: uri - required_status_checks: &416 + required_status_checks: &415 title: Status Check Policy description: Status Check Policy type: object @@ -58622,7 +61256,7 @@ paths: items: *4 teams: type: array - items: *198 + items: *197 apps: type: array items: *5 @@ -58640,7 +61274,7 @@ paths: items: *4 teams: type: array - items: *198 + items: *197 apps: type: array items: *5 @@ -58698,7 +61332,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *410 + restrictions: *409 required_conversation_resolution: type: object properties: @@ -58810,9 +61444,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '204': description: Response @@ -58837,17 +61471,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response content: application/json: - schema: *411 + schema: *410 examples: - default: &412 + default: &411 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -58869,17 +61503,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response content: application/json: - schema: *411 + schema: *410 examples: - default: *412 + default: *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58898,9 +61532,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '204': description: Response @@ -58925,17 +61559,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response content: application/json: - schema: *413 + schema: *412 examples: - default: &414 + default: &413 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -59031,9 +61665,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: false content: @@ -59131,9 +61765,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *412 examples: - default: *414 + default: *413 '422': *15 x-github: githubCloudOnly: false @@ -59154,9 +61788,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '204': description: Response @@ -59183,17 +61817,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response content: application/json: - schema: *411 + schema: *410 examples: - default: &415 + default: &414 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -59216,17 +61850,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response content: application/json: - schema: *411 + schema: *410 examples: - default: *415 + default: *414 '404': *6 x-github: githubCloudOnly: false @@ -59246,9 +61880,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '204': description: Response @@ -59273,17 +61907,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response content: application/json: - schema: *416 + schema: *415 examples: - default: &417 + default: &416 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -59309,9 +61943,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: false content: @@ -59363,9 +61997,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *415 examples: - default: *417 + default: *416 '404': *6 '422': *15 x-github: @@ -59387,9 +62021,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '204': description: Response @@ -59413,9 +62047,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response @@ -59449,9 +62083,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: false content: @@ -59518,9 +62152,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: false content: @@ -59584,9 +62218,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: content: application/json: @@ -59652,15 +62286,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response content: application/json: - schema: *410 + schema: *409 examples: default: value: @@ -59751,9 +62385,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '204': description: Response @@ -59776,9 +62410,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response @@ -59788,7 +62422,7 @@ paths: type: array items: *5 examples: - default: &418 + default: &417 value: - id: 1 slug: octoapp @@ -59845,9 +62479,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: true content: @@ -59881,7 +62515,7 @@ paths: type: array items: *5 examples: - default: *418 + default: *417 '422': *15 x-github: githubCloudOnly: false @@ -59902,9 +62536,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: true content: @@ -59938,7 +62572,7 @@ paths: type: array items: *5 examples: - default: *418 + default: *417 '422': *15 x-github: githubCloudOnly: false @@ -59959,9 +62593,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: true content: @@ -59995,7 +62629,7 @@ paths: type: array items: *5 examples: - default: *418 + default: *417 '422': *15 x-github: githubCloudOnly: false @@ -60017,9 +62651,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response @@ -60027,9 +62661,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *259 + default: *258 '404': *6 x-github: githubCloudOnly: false @@ -60049,9 +62683,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: false content: @@ -60087,9 +62721,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *259 + default: *258 '422': *15 x-github: githubCloudOnly: false @@ -60110,9 +62744,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: false content: @@ -60148,9 +62782,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *259 + default: *258 '422': *15 x-github: githubCloudOnly: false @@ -60171,9 +62805,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: content: application/json: @@ -60208,9 +62842,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *259 + default: *258 '422': *15 x-github: githubCloudOnly: false @@ -60232,9 +62866,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response @@ -60268,9 +62902,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: true content: @@ -60328,9 +62962,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: true content: @@ -60388,9 +63022,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: true content: @@ -60450,9 +63084,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: true content: @@ -60474,7 +63108,7 @@ paths: description: Response content: application/json: - schema: *419 + schema: *418 examples: default: value: @@ -60590,8 +63224,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -60870,7 +63504,7 @@ paths: description: Response content: application/json: - schema: &420 + schema: &419 title: CheckRun description: A check performed on the code of a given code change type: object @@ -60990,7 +63624,7 @@ paths: check. type: array items: *90 - deployment: &739 + deployment: &738 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -61270,9 +63904,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: + - *341 - *342 - - *343 - - &421 + - &420 name: check_run_id description: The unique identifier of the check run. in: path @@ -61284,9 +63918,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *419 examples: - default: &422 + default: &421 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -61386,9 +64020,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: + - *341 - *342 - - *343 - - *421 + - *420 requestBody: required: true content: @@ -61628,9 +64262,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *419 examples: - default: *422 + default: *421 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61650,9 +64284,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: + - *341 - *342 - - *343 - - *421 + - *420 - *17 - *19 responses: @@ -61747,15 +64381,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: + - *341 - *342 - - *343 - - *421 + - *420 responses: '201': description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -61793,8 +64427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -61816,7 +64450,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &425 + schema: &424 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -61893,7 +64527,7 @@ paths: nullable: true properties: *80 required: *81 - repository: *161 + repository: *160 created_at: type: string format: date-time @@ -61902,12 +64536,12 @@ paths: type: string format: date-time nullable: true - head_commit: &767 + head_commit: &766 title: Simple Commit description: A commit. type: object - properties: *423 - required: *424 + properties: *422 + required: *423 latest_check_runs_count: type: integer check_runs_url: @@ -61935,7 +64569,7 @@ paths: - check_runs_url - pull_requests examples: - default: &426 + default: &425 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -62226,9 +64860,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *425 + schema: *424 examples: - default: *426 + default: *425 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62247,8 +64881,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -62309,7 +64943,7 @@ paths: required: - app_id - setting - repository: *161 + repository: *160 examples: default: value: @@ -62557,9 +65191,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: + - *341 - *342 - - *343 - - &427 + - &426 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -62571,9 +65205,9 @@ paths: description: Response content: application/json: - schema: *425 + schema: *424 examples: - default: *426 + default: *425 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62596,17 +65230,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: + - *341 - *342 - - *343 - - *427 - - &482 + - *426 + - &481 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &483 + - &482 name: status description: Returns check runs with the specified `status`. in: query @@ -62645,9 +65279,9 @@ paths: type: integer check_runs: type: array - items: *420 + items: *419 examples: - default: &484 + default: &483 value: total_count: 1 check_runs: @@ -62749,15 +65383,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: + - *341 - *342 - - *343 - - *427 + - *426 responses: '201': description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -62784,21 +65418,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: + - *341 - *342 - - *343 + - *427 - *428 - - *429 - *19 - *17 - - &446 + - &445 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: *430 - - &447 + schema: *429 + - &446 name: pr description: The number of the pull request for the results you want to list. in: query @@ -62823,13 +65457,13 @@ paths: be returned. in: query required: false - schema: *431 + schema: *430 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *432 + schema: *431 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -62848,14 +65482,14 @@ paths: items: type: object properties: - number: *179 - created_at: *180 - updated_at: *181 - url: *182 - html_url: *183 - instances_url: *433 - state: *188 - fixed_at: *184 + number: *178 + created_at: *179 + updated_at: *180 + url: *181 + html_url: *182 + instances_url: *432 + state: *187 + fixed_at: *183 dismissed_by: title: Simple User description: A GitHub user. @@ -62863,12 +65497,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *185 - dismissed_reason: *434 - dismissed_comment: *435 - rule: *436 - tool: *437 - most_recent_instance: *438 + dismissed_at: *184 + dismissed_reason: *433 + dismissed_comment: *434 + rule: *435 + tool: *436 + most_recent_instance: *437 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -62994,7 +65628,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &439 + '403': &438 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -63021,9 +65655,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: + - *341 - *342 - - *343 - - &440 + - &439 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -63031,23 +65665,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *179 + schema: *178 responses: '200': description: Response content: application/json: - schema: &441 + schema: &440 type: object properties: - number: *179 - created_at: *180 - updated_at: *181 - url: *182 - html_url: *183 - instances_url: *433 - state: *188 - fixed_at: *184 + number: *178 + created_at: *179 + updated_at: *180 + url: *181 + html_url: *182 + instances_url: *432 + state: *187 + fixed_at: *183 dismissed_by: title: Simple User description: A GitHub user. @@ -63055,9 +65689,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *185 - dismissed_reason: *434 - dismissed_comment: *435 + dismissed_at: *184 + dismissed_reason: *433 + dismissed_comment: *434 rule: type: object properties: @@ -63111,8 +65745,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *437 - most_recent_instance: *438 + tool: *436 + most_recent_instance: *437 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -63211,7 +65845,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *439 + '403': *438 '404': *6 '503': *121 x-github: @@ -63231,9 +65865,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: + - *341 - *342 - - *343 - - *440 + - *439 requestBody: required: true content: @@ -63248,8 +65882,8 @@ paths: enum: - open - dismissed - dismissed_reason: *434 - dismissed_comment: *435 + dismissed_reason: *433 + dismissed_comment: *434 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -63277,7 +65911,7 @@ paths: description: Response content: application/json: - schema: *441 + schema: *440 examples: default: value: @@ -63353,7 +65987,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &445 + '403': &444 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -63380,15 +66014,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: + - *341 - *342 - - *343 - - *440 + - *439 responses: '200': description: Response content: application/json: - schema: &442 + schema: &441 type: object properties: status: @@ -63414,13 +66048,13 @@ paths: - description - started_at examples: - default: &443 + default: &442 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &444 + '400': &443 description: Bad Request content: application/json: @@ -63431,7 +66065,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': *439 + '403': *438 '404': *6 '503': *121 x-github: @@ -63456,29 +66090,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: + - *341 - *342 - - *343 - - *440 + - *439 responses: '200': description: OK content: application/json: - schema: *442 + schema: *441 examples: - default: *443 + default: *442 '202': description: Accepted content: application/json: - schema: *442 + schema: *441 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *444 + '400': *443 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -63510,9 +66144,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: + - *341 - *342 - - *343 - - *440 + - *439 requestBody: required: false content: @@ -63557,8 +66191,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *444 - '403': *445 + '400': *443 + '403': *444 '404': *6 '422': description: Unprocessable Entity @@ -63582,13 +66216,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: + - *341 - *342 - - *343 - - *440 + - *439 - *19 - *17 + - *445 - *446 - - *447 responses: '200': description: Response @@ -63599,10 +66233,10 @@ paths: items: type: object properties: - ref: *430 - analysis_key: *448 - environment: *449 - category: *450 + ref: *429 + analysis_key: *447 + environment: *448 + category: *449 state: type: string description: State of a code scanning alert instance. @@ -63617,7 +66251,7 @@ paths: properties: text: type: string - location: *451 + location: *450 html_url: type: string classifications: @@ -63625,7 +66259,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: *452 + items: *451 examples: default: value: @@ -63662,7 +66296,7 @@ paths: end_column: 50 classifications: - source - '403': *439 + '403': *438 '404': *6 '503': *121 x-github: @@ -63696,25 +66330,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: + - *341 - *342 - - *343 + - *427 - *428 - - *429 - *19 - *17 - - *447 + - *446 - 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: *430 + schema: *429 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &453 + schema: &452 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -63735,23 +66369,23 @@ paths: application/json: schema: type: array - items: &454 + items: &453 type: object properties: - ref: *430 - commit_sha: &462 + ref: *429 + commit_sha: &461 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: *448 + analysis_key: *447 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *450 + category: *449 error: type: string example: error reading field xyz @@ -63775,8 +66409,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *453 - tool: *437 + sarif_id: *452 + tool: *436 deletable: type: boolean warning: @@ -63837,7 +66471,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *439 + '403': *438 '404': *6 '503': *121 x-github: @@ -63873,8 +66507,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: + - *341 - *342 - - *343 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -63887,7 +66521,7 @@ paths: description: Response content: application/json: - schema: *454 + schema: *453 examples: response: summary: application/json response @@ -63941,7 +66575,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *439 + '403': *438 '404': *6 '422': description: Response if analysis could not be processed @@ -64028,8 +66662,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: + - *341 - *342 - - *343 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -64082,7 +66716,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': *445 + '403': *444 '404': *6 '503': *121 x-github: @@ -64104,8 +66738,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -64113,7 +66747,7 @@ paths: application/json: schema: type: array - items: &455 + items: &454 title: CodeQL Database description: A CodeQL database. type: object @@ -64224,7 +66858,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': *439 + '403': *438 '404': *6 '503': *121 x-github: @@ -64253,8 +66887,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: + - *341 - *342 - - *343 - name: language in: path description: The language of the CodeQL database. @@ -64266,7 +66900,7 @@ paths: description: Response content: application/json: - schema: *455 + schema: *454 examples: default: value: @@ -64298,9 +66932,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': &491 + '302': &490 description: Found - '403': *439 + '403': *438 '404': *6 '503': *121 x-github: @@ -64322,8 +66956,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: + - *341 - *342 - - *343 - name: language in: path description: The language of the CodeQL database. @@ -64333,7 +66967,7 @@ paths: responses: '204': description: Response - '403': *445 + '403': *444 '404': *6 '503': *121 x-github: @@ -64361,8 +66995,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -64371,7 +67005,7 @@ paths: type: object additionalProperties: false properties: - language: &456 + language: &455 type: string description: The language targeted by the CodeQL query enum: @@ -64451,7 +67085,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &460 + schema: &459 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -64461,7 +67095,7 @@ paths: description: The ID of the variant analysis. controller_repo: *66 actor: *4 - query_language: *456 + query_language: *455 query_pack_url: type: string description: The download url for the query pack. @@ -64508,7 +67142,7 @@ paths: items: type: object properties: - repository: &457 + repository: &456 title: Repository Identifier description: Repository Identifier type: object @@ -64544,7 +67178,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &461 + analysis_status: &460 type: string description: The new status of the CodeQL variant analysis repository task. @@ -64576,7 +67210,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &458 + access_mismatch_repos: &457 type: object properties: repository_count: @@ -64590,7 +67224,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: *457 + items: *456 required: - repository_count - repositories @@ -64612,8 +67246,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *458 - over_limit_repos: *458 + no_codeql_db_repos: *457 + over_limit_repos: *457 required: - access_mismatch_repos - not_found_repos @@ -64629,7 +67263,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &459 + value: &458 summary: Default response value: id: 1 @@ -64775,10 +67409,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *459 + value: *458 repository_lists: summary: Response for a successful variant analysis submission - value: *459 + value: *458 '404': *6 '422': description: Unable to process variant analysis submission @@ -64806,8 +67440,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: + - *341 - *342 - - *343 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -64819,9 +67453,9 @@ paths: description: Response content: application/json: - schema: *460 + schema: *459 examples: - default: *459 + default: *458 '404': *6 '503': *121 x-github: @@ -64844,7 +67478,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: - - *342 + - *341 - name: repo in: path description: The name of the controller repository. @@ -64879,7 +67513,7 @@ paths: type: object properties: repository: *66 - analysis_status: *461 + analysis_status: *460 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -65004,8 +67638,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -65090,7 +67724,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *439 + '403': *438 '404': *6 '503': *121 x-github: @@ -65111,8 +67745,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -65179,7 +67813,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -65204,7 +67838,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *445 + '403': *444 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -65275,8 +67909,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -65284,7 +67918,7 @@ paths: schema: type: object properties: - commit_sha: *462 + commit_sha: *461 ref: type: string description: |- @@ -65342,7 +67976,7 @@ paths: schema: type: object properties: - id: *453 + id: *452 url: type: string description: The REST API URL for checking the status of the upload. @@ -65356,7 +67990,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': *445 + '403': *444 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -65379,8 +68013,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: + - *341 - *342 - - *343 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -65426,7 +68060,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': *439 + '403': *438 '404': description: Not Found if the sarif id does not match any upload '503': *121 @@ -65451,8 +68085,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: + - *341 - *342 - - *343 responses: '200': description: Response @@ -65508,7 +68142,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': *192 + '204': *191 '304': *37 '403': *29 '404': *6 @@ -65533,8 +68167,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: + - *341 - *342 - - *343 - 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 @@ -65654,8 +68288,8 @@ paths: parameters: - *17 - *19 + - *341 - *342 - - *343 responses: '200': description: Response @@ -65671,7 +68305,7 @@ paths: type: integer codespaces: type: array - items: *247 + items: *246 examples: default: value: @@ -65969,8 +68603,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -66033,17 +68667,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '400': *14 '401': *25 '403': *29 @@ -66072,8 +68706,8 @@ paths: parameters: - *17 - *19 + - *341 - *342 - - *343 responses: '200': description: Response @@ -66137,8 +68771,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: + - *341 - *342 - - *343 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -66173,14 +68807,14 @@ paths: type: integer machines: type: array - items: &682 + items: &681 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *464 - required: *465 + properties: *463 + required: *464 examples: - default: &683 + default: &682 value: total_count: 2 machines: @@ -66220,8 +68854,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: + - *341 - *342 - - *343 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -66305,8 +68939,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: + - *341 - *342 - - *343 - 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 @@ -66372,8 +69006,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -66391,7 +69025,7 @@ paths: type: integer secrets: type: array - items: &469 + items: &468 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -66411,7 +69045,7 @@ paths: - created_at - updated_at examples: - default: *466 + default: *465 headers: Link: *67 x-github: @@ -66434,16 +69068,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *467 + schema: *466 examples: - default: *468 + default: *467 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66463,17 +69097,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: + - *341 - *342 - - *343 - - *169 + - *168 responses: '200': description: Response content: application/json: - schema: *469 + schema: *468 examples: - default: *470 + default: *469 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66493,9 +69127,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: + - *341 - *342 - - *343 - - *169 + - *168 requestBody: required: true content: @@ -66523,7 +69157,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -66547,9 +69181,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: + - *341 - *342 - - *343 - - *169 + - *168 responses: '204': description: Response @@ -66577,8 +69211,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: + - *341 - *342 - - *343 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -66620,7 +69254,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &471 + properties: &470 login: type: string example: octocat @@ -66713,7 +69347,7 @@ paths: user_view_type: type: string example: public - required: &472 + required: &471 - avatar_url - events_url - followers_url @@ -66787,8 +69421,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: + - *341 - *342 - - *343 - *71 responses: '204': @@ -66835,8 +69469,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: + - *341 - *342 - - *343 - *71 requestBody: required: false @@ -66863,7 +69497,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &541 + schema: &540 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -66874,7 +69508,7 @@ paths: example: 42 type: integer format: int64 - repository: *161 + repository: *160 invitee: title: Simple User description: A GitHub user. @@ -67092,8 +69726,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: + - *341 - *342 - - *343 - *71 responses: '204': @@ -67125,8 +69759,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: + - *341 - *342 - - *343 - *71 responses: '200': @@ -67147,8 +69781,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *471 - required: *472 + properties: *470 + required: *471 nullable: true required: - permission @@ -67203,8 +69837,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -67214,7 +69848,7 @@ paths: application/json: schema: type: array - items: &473 + items: &472 title: Commit Comment description: Commit Comment type: object @@ -67272,7 +69906,7 @@ paths: - created_at - updated_at examples: - default: &478 + default: &477 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -67331,17 +69965,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: + - *341 - *342 - - *343 - *101 responses: '200': description: Response content: application/json: - schema: *473 + schema: *472 examples: - default: &479 + default: &478 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -67398,8 +70032,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: + - *341 - *342 - - *343 - *101 requestBody: required: true @@ -67422,7 +70056,7 @@ paths: description: Response content: application/json: - schema: *473 + schema: *472 examples: default: value: @@ -67473,8 +70107,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: + - *341 - *342 - - *343 - *101 responses: '204': @@ -67496,8 +70130,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: + - *341 - *342 - - *343 - *101 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -67524,7 +70158,7 @@ paths: application/json: schema: type: array - items: &474 + items: &473 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -67567,7 +70201,7 @@ paths: - content - created_at examples: - default: &545 + default: &544 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -67612,8 +70246,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: + - *341 - *342 - - *343 - *101 requestBody: required: true @@ -67646,9 +70280,9 @@ paths: description: Reaction exists content: application/json: - schema: *474 + schema: *473 examples: - default: &475 + default: &474 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -67677,9 +70311,9 @@ paths: description: Reaction created content: application/json: - schema: *474 + schema: *473 examples: - default: *475 + default: *474 '422': *15 x-github: githubCloudOnly: false @@ -67701,10 +70335,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: + - *341 - *342 - - *343 - *101 - - &546 + - &545 name: reaction_id description: The unique identifier of the reaction. in: path @@ -67759,8 +70393,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: + - *341 - *342 - - *343 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -67816,9 +70450,9 @@ paths: application/json: schema: type: array - items: *476 + items: *475 examples: - default: &596 + default: &595 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -67912,9 +70546,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: + - *341 - *342 - - *343 - - &477 + - &476 name: commit_sha description: The SHA of the commit. in: path @@ -67986,9 +70620,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: + - *341 - *342 - - *343 - - *477 + - *476 - *17 - *19 responses: @@ -67998,9 +70632,9 @@ paths: application/json: schema: type: array - items: *473 + items: *472 examples: - default: *478 + default: *477 headers: Link: *67 x-github: @@ -68028,9 +70662,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: + - *341 - *342 - - *343 - - *477 + - *476 requestBody: required: true content: @@ -68065,9 +70699,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *472 examples: - default: *479 + default: *478 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -68095,9 +70729,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: + - *341 - *342 - - *343 - - *477 + - *476 - *17 - *19 responses: @@ -68107,9 +70741,9 @@ paths: application/json: schema: type: array - items: *480 + items: *479 examples: - default: &588 + default: &587 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -68646,11 +71280,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: + - *341 - *342 - - *343 - *19 - *17 - - &481 + - &480 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)" @@ -68665,9 +71299,9 @@ paths: description: Response content: application/json: - schema: *476 + schema: *475 examples: - default: &575 + default: &574 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -68780,11 +71414,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: + - *341 - *342 - - *343 + - *480 - *481 - *482 - - *483 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -68818,9 +71452,9 @@ paths: type: integer check_runs: type: array - items: *420 + items: *419 examples: - default: *484 + default: *483 headers: Link: *67 x-github: @@ -68845,9 +71479,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: + - *341 - *342 - - *343 - - *481 + - *480 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -68855,7 +71489,7 @@ paths: schema: type: integer example: 1 - - *482 + - *481 - *17 - *19 responses: @@ -68873,7 +71507,7 @@ paths: type: integer check_suites: type: array - items: *425 + items: *424 examples: default: value: @@ -69073,9 +71707,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: + - *341 - *342 - - *343 - - *481 + - *480 - *17 - *19 responses: @@ -69142,7 +71776,7 @@ paths: type: string total_count: type: integer - repository: *161 + repository: *160 commit_url: type: string format: uri @@ -69273,9 +71907,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: + - *341 - *342 - - *343 - - *481 + - *480 - *17 - *19 responses: @@ -69285,7 +71919,7 @@ paths: application/json: schema: type: array - items: &661 + items: &660 title: Status description: The status of a commit. type: object @@ -69366,7 +72000,7 @@ paths: site_admin: false headers: Link: *67 - '301': *346 + '301': *345 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69394,8 +72028,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -69424,20 +72058,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *485 - required: *486 + properties: *484 + required: *485 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &487 + properties: &486 url: type: string format: uri html_url: type: string format: uri - required: &488 + required: &487 - url - html_url nullable: true @@ -69451,26 +72085,26 @@ paths: contributing: title: Community Health File type: object - properties: *487 - required: *488 + properties: *486 + required: *487 nullable: true readme: title: Community Health File type: object - properties: *487 - required: *488 + properties: *486 + required: *487 nullable: true issue_template: title: Community Health File type: object - properties: *487 - required: *488 + properties: *486 + required: *487 nullable: true pull_request_template: title: Community Health File type: object - properties: *487 - required: *488 + properties: *486 + required: *487 nullable: true required: - code_of_conduct @@ -69597,8 +72231,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: + - *341 - *342 - - *343 - *19 - *17 - name: basehead @@ -69641,8 +72275,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *476 - merge_base_commit: *476 + base_commit: *475 + merge_base_commit: *475 status: type: string enum: @@ -69662,10 +72296,10 @@ paths: example: 6 commits: type: array - items: *476 + items: *475 files: type: array - items: *489 + items: *488 required: - url - html_url @@ -69951,8 +72585,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: + - *341 - *342 - - *343 - name: path description: path parameter in: path @@ -70112,7 +72746,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &490 + response-if-content-is-a-file-github-object: &489 summary: Response if content is a file value: type: file @@ -70244,7 +72878,7 @@ paths: - size - type - url - - &601 + - &600 title: Content File description: Content File type: object @@ -70445,7 +73079,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *490 + response-if-content-is-a-file: *489 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -70514,7 +73148,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *491 + '302': *490 '304': *37 x-github: githubCloudOnly: false @@ -70537,8 +73171,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: + - *341 - *342 - - *343 - name: path description: path parameter in: path @@ -70631,7 +73265,7 @@ paths: description: Response content: application/json: - schema: &492 + schema: &491 title: File Commit description: File Commit type: object @@ -70783,7 +73417,7 @@ paths: description: Response content: application/json: - schema: *492 + schema: *491 examples: example-for-creating-a-file: value: @@ -70837,7 +73471,7 @@ paths: schema: oneOf: - *3 - - &523 + - &522 description: Repository rule violation was detected type: object properties: @@ -70858,7 +73492,7 @@ paths: items: type: object properties: - placeholder_id: &653 + placeholder_id: &652 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -70890,8 +73524,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: + - *341 - *342 - - *343 - name: path description: path parameter in: path @@ -70952,7 +73586,7 @@ paths: description: Response content: application/json: - schema: *492 + schema: *491 examples: default: value: @@ -71007,8 +73641,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: + - *341 - *342 - - *343 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -71131,23 +73765,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: + - *341 - *342 - - *343 + - *199 - *200 - *201 - *202 - - *203 - 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 + - *203 + - *492 - *204 - - *493 - *205 - *206 - - *207 - *61 - *47 - *48 @@ -71159,11 +73793,11 @@ paths: application/json: schema: type: array - items: &497 + items: &496 type: object description: A Dependabot alert. properties: - number: *179 + number: *178 state: type: string description: The state of the Dependabot alert. @@ -71205,13 +73839,14 @@ paths: - unknown - direct - transitive - security_advisory: *494 + - inconclusive + security_advisory: *493 security_vulnerability: *65 - url: *182 - html_url: *183 - created_at: *180 - updated_at: *181 - dismissed_at: *185 + url: *181 + html_url: *182 + created_at: *179 + updated_at: *180 + dismissed_at: *184 dismissed_by: title: Simple User description: A GitHub user. @@ -71235,9 +73870,9 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *184 - auto_dismissed_at: *495 - dismissal_request: *496 + fixed_at: *183 + auto_dismissed_at: *494 + dismissal_request: *495 assignees: type: array description: The users assigned to this alert. @@ -71309,7 +73944,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 @@ -71492,9 +74127,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: + - *341 - *342 - - *343 - - &498 + - &497 name: alert_number in: path description: |- @@ -71503,13 +74138,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *179 + schema: *178 responses: '200': description: Response content: application/json: - schema: *497 + schema: *496 examples: default: value: @@ -71566,7 +74201,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 @@ -71641,9 +74276,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: + - *341 - *342 - - *343 - - *498 + - *497 requestBody: required: true content: @@ -71699,7 +74334,7 @@ paths: description: Response content: application/json: - schema: *497 + schema: *496 examples: default: value: @@ -71829,8 +74464,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -71848,7 +74483,7 @@ paths: type: integer secrets: type: array - items: &501 + items: &500 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -71901,16 +74536,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *499 + schema: *498 examples: - default: *500 + default: *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71930,15 +74565,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: + - *341 - *342 - - *343 - - *169 + - *168 responses: '200': description: Response content: application/json: - schema: *501 + schema: *500 examples: default: value: @@ -71964,9 +74599,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: + - *341 - *342 - - *343 - - *169 + - *168 requestBody: required: true content: @@ -71994,7 +74629,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -72018,9 +74653,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: + - *341 - *342 - - *343 - - *169 + - *168 responses: '204': description: Response @@ -72042,8 +74677,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: + - *341 - *342 - - *343 - 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 @@ -72203,8 +74838,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: + - *341 - *342 - - *343 responses: '200': description: Response @@ -72443,8 +75078,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: + - *341 - *342 - - *343 requestBody: required: true content: @@ -72519,7 +75154,7 @@ paths: - version - url additionalProperties: false - metadata: &502 + metadata: &501 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -72552,7 +75187,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *502 + metadata: *501 resolved: type: object description: A collection of resolved package dependencies. @@ -72565,7 +75200,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *502 + metadata: *501 relationship: type: string description: A notation of whether a dependency is requested @@ -72694,8 +75329,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: + - *341 - *342 - - *343 - name: sha description: The SHA recorded at creation time. in: query @@ -72735,9 +75370,9 @@ paths: application/json: schema: type: array - items: *503 + items: *502 examples: - default: *504 + default: *503 headers: Link: *67 x-github: @@ -72803,8 +75438,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -72885,7 +75520,7 @@ paths: description: Response content: application/json: - schema: *503 + schema: *502 examples: simple-example: summary: Simple example @@ -72958,9 +75593,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: + - *341 - *342 - - *343 - - &505 + - &504 name: deployment_id description: deployment_id parameter in: path @@ -72972,7 +75607,7 @@ paths: description: Response content: application/json: - schema: *503 + schema: *502 examples: default: value: @@ -73037,9 +75672,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: + - *341 - *342 - - *343 - - *505 + - *504 responses: '204': description: Response @@ -73061,9 +75696,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: + - *341 - *342 - - *343 - - *505 + - *504 - *17 - *19 responses: @@ -73073,7 +75708,7 @@ paths: application/json: schema: type: array - items: &506 + items: &505 title: Deployment Status description: The status of a deployment. type: object @@ -73234,9 +75869,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: + - *341 - *342 - - *343 - - *505 + - *504 requestBody: required: true content: @@ -73311,9 +75946,9 @@ paths: description: Response content: application/json: - schema: *506 + schema: *505 examples: - default: &507 + default: &506 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -73369,9 +76004,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: + - *341 - *342 - - *343 - - *505 + - *504 - name: status_id in: path required: true @@ -73382,9 +76017,9 @@ paths: description: Response content: application/json: - schema: *506 + schema: *505 examples: - default: *507 + default: *506 '404': *6 x-github: githubCloudOnly: false @@ -73409,8 +76044,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -73467,8 +76102,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -73485,7 +76120,7 @@ paths: type: integer environments: type: array - items: &509 + items: &508 title: Environment description: Details of a deployment environment type: object @@ -73537,7 +76172,7 @@ paths: type: type: string example: wait_timer - wait_timer: &511 + wait_timer: &510 type: integer example: 30 description: The amount of time to delay a job after @@ -73574,11 +76209,11 @@ paths: items: type: object properties: - type: *508 + type: *507 reviewer: anyOf: - *4 - - *198 + - *197 required: - id - node_id @@ -73598,7 +76233,7 @@ paths: - id - node_id - type - deployment_branch_policy: &512 + deployment_branch_policy: &511 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -73714,9 +76349,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: + - *341 - *342 - - *343 - - &510 + - &509 name: environment_name in: path required: true @@ -73729,9 +76364,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *508 examples: - default: &513 + default: &512 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -73815,9 +76450,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: + - *341 - *342 - - *343 - - *510 + - *509 requestBody: required: false content: @@ -73826,7 +76461,7 @@ paths: type: object nullable: true properties: - wait_timer: *511 + wait_timer: *510 prevent_self_review: type: boolean example: false @@ -73843,13 +76478,13 @@ paths: items: type: object properties: - type: *508 + type: *507 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *512 + deployment_branch_policy: *511 additionalProperties: false examples: default: @@ -73869,9 +76504,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *508 examples: - default: *513 + default: *512 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -73895,9 +76530,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: + - *341 - *342 - - *343 - - *510 + - *509 responses: '204': description: Default response @@ -73922,9 +76557,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: + - *341 - *342 - - *343 - - *510 + - *509 - *17 - *19 responses: @@ -73942,7 +76577,7 @@ paths: example: 2 branch_policies: type: array - items: &514 + items: &513 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -73999,9 +76634,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: + - *341 - *342 - - *343 - - *510 + - *509 requestBody: required: true content: @@ -74047,9 +76682,9 @@ paths: description: Response content: application/json: - schema: *514 + schema: *513 examples: - example-wildcard: &515 + example-wildcard: &514 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -74091,10 +76726,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: + - *341 - *342 - - *343 - - *510 - - &516 + - *509 + - &515 name: branch_policy_id in: path required: true @@ -74106,9 +76741,9 @@ paths: description: Response content: application/json: - schema: *514 + schema: *513 examples: - default: *515 + default: *514 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74127,10 +76762,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: + - *341 - *342 - - *343 - - *510 - - *516 + - *509 + - *515 requestBody: required: true content: @@ -74158,9 +76793,9 @@ paths: description: Response content: application/json: - schema: *514 + schema: *513 examples: - default: *515 + default: *514 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74179,10 +76814,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: + - *341 - *342 - - *343 - - *510 - - *516 + - *509 + - *515 responses: '204': description: Response @@ -74207,9 +76842,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *510 - - *343 + - *509 - *342 + - *341 responses: '200': description: List of deployment protection rules @@ -74225,7 +76860,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &517 + items: &516 title: Deployment protection rule description: Deployment protection rule type: object @@ -74244,7 +76879,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &518 + app: &517 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -74343,9 +76978,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: - - *510 - - *343 + - *509 - *342 + - *341 requestBody: content: application/json: @@ -74366,9 +77001,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *517 + schema: *516 examples: - default: &519 + default: &518 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -74403,9 +77038,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: - - *510 - - *343 + - *509 - *342 + - *341 - *19 - *17 responses: @@ -74424,7 +77059,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *518 + items: *517 examples: default: value: @@ -74459,10 +77094,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: + - *341 - *342 - - *343 - - *510 - - &520 + - *509 + - &519 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -74474,9 +77109,9 @@ paths: description: Response content: application/json: - schema: *517 + schema: *516 examples: - default: *519 + default: *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74497,10 +77132,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *510 - - *343 + - *509 - *342 - - *520 + - *341 + - *519 responses: '204': description: Response @@ -74526,9 +77161,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: + - *341 - *342 - - *343 - - *510 + - *509 - *17 - *19 responses: @@ -74546,9 +77181,9 @@ paths: type: integer secrets: type: array - items: *387 + items: *386 examples: - default: *388 + default: *387 headers: Link: *67 x-github: @@ -74573,17 +77208,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: + - *341 - *342 - - *343 - - *510 + - *509 responses: '200': description: Response content: application/json: - schema: *389 + schema: *388 examples: - default: *390 + default: *389 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74605,18 +77240,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: + - *341 - *342 - - *343 - - *510 - - *169 + - *509 + - *168 responses: '200': description: Response content: application/json: - schema: *387 + schema: *386 examples: - default: *521 + default: *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74638,10 +77273,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: + - *341 - *342 - - *343 - - *510 - - *169 + - *509 + - *168 requestBody: required: true content: @@ -74672,7 +77307,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -74698,10 +77333,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: + - *341 - *342 - - *343 - - *510 - - *169 + - *509 + - *168 responses: '204': description: Default response @@ -74726,10 +77361,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: + - *341 - *342 - - *343 - - *510 - - *358 + - *509 + - *357 - *19 responses: '200': @@ -74746,9 +77381,9 @@ paths: type: integer variables: type: array - items: *391 + items: *390 examples: - default: *392 + default: *391 headers: Link: *67 x-github: @@ -74771,9 +77406,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: + - *341 - *342 - - *343 - - *510 + - *509 requestBody: required: true content: @@ -74800,7 +77435,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -74825,18 +77460,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: + - *341 - *342 - - *343 - - *510 - - *172 + - *509 + - *171 responses: '200': description: Response content: application/json: - schema: *391 + schema: *390 examples: - default: *522 + default: *521 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74857,10 +77492,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: + - *341 - *342 - - *343 - - *172 - - *510 + - *171 + - *509 requestBody: required: true content: @@ -74902,10 +77537,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: + - *341 - *342 - - *343 - - *172 - - *510 + - *171 + - *509 responses: '204': description: Response @@ -74927,8 +77562,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -74996,8 +77631,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: + - *341 - *342 - - *343 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -75019,7 +77654,7 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: default: value: @@ -75156,8 +77791,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: + - *341 - *342 - - *343 requestBody: required: false content: @@ -75189,9 +77824,9 @@ paths: description: Response content: application/json: - schema: *345 + schema: *344 examples: - default: *347 + default: *346 '400': *14 '422': *15 '403': *29 @@ -75212,8 +77847,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -75273,7 +77908,7 @@ paths: schema: oneOf: - *129 - - *523 + - *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75298,8 +77933,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: + - *341 - *342 - - *343 - name: file_sha in: path required: true @@ -75398,8 +78033,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -75508,7 +78143,7 @@ paths: description: Response content: application/json: - schema: &524 + schema: &523 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -75722,15 +78357,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: + - *341 - *342 - - *343 - - *477 + - *476 responses: '200': description: Response content: application/json: - schema: *524 + schema: *523 examples: default: value: @@ -75786,9 +78421,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: + - *341 - *342 - - *343 - - &525 + - &524 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. @@ -75805,7 +78440,7 @@ paths: application/json: schema: type: array - items: &526 + items: &525 title: Git Reference description: Git references within a repository type: object @@ -75880,17 +78515,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: + - *341 - *342 - - *343 - - *525 + - *524 responses: '200': description: Response content: application/json: - schema: *526 + schema: *525 examples: - default: &527 + default: &526 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -75919,8 +78554,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -75949,9 +78584,9 @@ paths: description: Response content: application/json: - schema: *526 + schema: *525 examples: - default: *527 + default: *526 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -75977,9 +78612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: + - *341 - *342 - - *343 - - *525 + - *524 requestBody: required: true content: @@ -76008,9 +78643,9 @@ paths: description: Response content: application/json: - schema: *526 + schema: *525 examples: - default: *527 + default: *526 '422': *15 '409': *54 x-github: @@ -76028,9 +78663,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: + - *341 - *342 - - *343 - - *525 + - *524 responses: '204': description: Response @@ -76085,8 +78720,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -76153,7 +78788,7 @@ paths: description: Response content: application/json: - schema: &529 + schema: &528 title: Git Tag description: Metadata for a Git tag type: object @@ -76204,7 +78839,7 @@ paths: - sha - type - url - verification: *528 + verification: *527 required: - sha - url @@ -76214,7 +78849,7 @@ paths: - tag - message examples: - default: &530 + default: &529 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -76287,8 +78922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: + - *341 - *342 - - *343 - name: tag_sha in: path required: true @@ -76299,9 +78934,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *528 examples: - default: *530 + default: *529 '404': *6 '409': *54 x-github: @@ -76325,8 +78960,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -76399,7 +79034,7 @@ paths: description: Response content: application/json: - schema: &531 + schema: &530 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -76495,8 +79130,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: + - *341 - *342 - - *343 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -76519,7 +79154,7 @@ paths: description: Response content: application/json: - schema: *531 + schema: *530 examples: default-response: summary: Default response @@ -76578,8 +79213,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -76589,7 +79224,7 @@ paths: application/json: schema: type: array - items: &532 + items: &531 title: Webhook description: Webhooks for repositories. type: object @@ -76643,7 +79278,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &775 + last_response: &774 title: Hook Response type: object properties: @@ -76717,8 +79352,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: + - *341 - *342 - - *343 requestBody: required: false content: @@ -76770,9 +79405,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *531 examples: - default: &533 + default: &532 value: type: Repository id: 12345678 @@ -76820,17 +79455,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: + - *341 - *342 - - *343 - - *215 + - *214 responses: '200': description: Response content: application/json: - schema: *532 + schema: *531 examples: - default: *533 + default: *532 '404': *6 x-github: githubCloudOnly: false @@ -76850,9 +79485,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: + - *341 - *342 - - *343 - - *215 + - *214 requestBody: required: true content: @@ -76897,9 +79532,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *531 examples: - default: *533 + default: *532 '422': *15 '404': *6 x-github: @@ -76920,9 +79555,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: + - *341 - *342 - - *343 - - *215 + - *214 responses: '204': description: Response @@ -76946,9 +79581,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: + - *341 - *342 - - *343 - - *215 + - *214 responses: '200': description: Response @@ -76975,9 +79610,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: + - *341 - *342 - - *343 - - *215 + - *214 requestBody: required: false content: @@ -77021,12 +79656,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: + - *341 - *342 - - *343 - - *215 + - *214 - *17 + - *215 - *216 - - *217 responses: '200': description: Response @@ -77034,9 +79669,9 @@ paths: application/json: schema: type: array - items: *218 + items: *217 examples: - default: *219 + default: *218 '400': *14 '422': *15 x-github: @@ -77055,18 +79690,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: + - *341 - *342 - - *343 - - *215 + - *214 - *16 responses: '200': description: Response content: application/json: - schema: *220 + schema: *219 examples: - default: *221 + default: *220 '400': *14 '422': *15 x-github: @@ -77085,9 +79720,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: + - *341 - *342 - - *343 - - *215 + - *214 - *16 responses: '202': *39 @@ -77110,9 +79745,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: + - *341 - *342 - - *343 - - *215 + - *214 responses: '204': description: Response @@ -77137,9 +79772,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: + - *341 - *342 - - *343 - - *215 + - *214 responses: '204': description: Response @@ -77162,8 +79797,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response if immutable releases are enabled @@ -77209,10 +79844,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: + - *341 - *342 - - *343 responses: - '204': *192 + '204': *191 '409': *54 x-github: githubCloudOnly: false @@ -77230,10 +79865,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: + - *341 - *342 - - *343 responses: - '204': *192 + '204': *191 '409': *54 x-github: githubCloudOnly: false @@ -77288,14 +79923,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: &534 + schema: &533 title: Import description: A repository import from an external source. type: object @@ -77394,7 +80029,7 @@ paths: - html_url - authors_url examples: - default: &537 + default: &536 value: vcs: subversion use_lfs: true @@ -77410,7 +80045,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': &535 + '503': &534 description: Unavailable due to service under maintenance. content: application/json: @@ -77439,8 +80074,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -77488,7 +80123,7 @@ paths: description: Response content: application/json: - schema: *534 + schema: *533 examples: default: value: @@ -77513,7 +80148,7 @@ paths: type: string '422': *15 '404': *6 - '503': *535 + '503': *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77541,8 +80176,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: + - *341 - *342 - - *343 requestBody: required: false content: @@ -77591,7 +80226,7 @@ paths: description: Response content: application/json: - schema: *534 + schema: *533 examples: example-1: summary: Example 1 @@ -77639,7 +80274,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': *535 + '503': *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77662,12 +80297,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: + - *341 - *342 - - *343 responses: '204': description: Response - '503': *535 + '503': *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77693,9 +80328,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: + - *341 - *342 - - *343 - - &704 + - &703 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -77709,7 +80344,7 @@ paths: application/json: schema: type: array - items: &536 + items: &535 title: Porter Author description: Porter Author type: object @@ -77763,7 +80398,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': *535 + '503': *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77788,8 +80423,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: + - *341 - *342 - - *343 - name: author_id in: path required: true @@ -77819,7 +80454,7 @@ paths: description: Response content: application/json: - schema: *536 + schema: *535 examples: default: value: @@ -77832,7 +80467,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *535 + '503': *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77856,8 +80491,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -77898,7 +80533,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *535 + '503': *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77926,8 +80561,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -77954,11 +80589,11 @@ paths: description: Response content: application/json: - schema: *534 + schema: *533 examples: - default: *537 + default: *536 '422': *15 - '503': *535 + '503': *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77981,8 +80616,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -77990,8 +80625,8 @@ paths: application/json: schema: *22 examples: - default: *538 - '301': *346 + default: *537 + '301': *345 '404': *6 x-github: githubCloudOnly: false @@ -78011,8 +80646,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -78020,12 +80655,12 @@ paths: application/json: schema: anyOf: - - *234 + - *233 - type: object properties: {} additionalProperties: false examples: - default: &540 + default: &539 value: limit: collaborators_only origin: repository @@ -78050,13 +80685,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: + - *341 - *342 - - *343 requestBody: required: true content: application/json: - schema: *539 + schema: *538 examples: default: summary: Example request body @@ -78068,9 +80703,9 @@ paths: description: Response content: application/json: - schema: *234 + schema: *233 examples: - default: *540 + default: *539 '409': description: Response x-github: @@ -78092,8 +80727,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -78116,8 +80751,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -78127,9 +80762,9 @@ paths: application/json: schema: type: array - items: *541 + items: *540 examples: - default: &697 + default: &696 value: - id: 1 repository: @@ -78260,9 +80895,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: + - *341 - *342 - - *343 - - *238 + - *237 requestBody: required: false content: @@ -78291,7 +80926,7 @@ paths: description: Response content: application/json: - schema: *541 + schema: *540 examples: default: value: @@ -78422,9 +81057,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: + - *341 - *342 - - *343 - - *238 + - *237 responses: '204': description: Response @@ -78455,8 +81090,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: + - *341 - *342 - - *343 - 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 @@ -78504,7 +81139,7 @@ paths: required: false schema: type: string - - *245 + - *244 - name: sort description: What to sort results by. in: query @@ -78529,7 +81164,7 @@ paths: type: array items: *85 examples: - default: &553 + default: &552 value: - id: 1 node_id: MDU6SXNzdWUx @@ -78678,7 +81313,7 @@ paths: state_reason: completed headers: Link: *67 - '301': *346 + '301': *345 '422': *15 '404': *6 x-github: @@ -78707,8 +81342,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -78792,7 +81427,7 @@ paths: application/json: schema: *85 examples: - default: &550 + default: &549 value: id: 1 node_id: MDU6SXNzdWUx @@ -78949,7 +81584,7 @@ paths: '422': *15 '503': *121 '404': *6 - '410': *542 + '410': *541 x-github: triggersNotification: true githubCloudOnly: false @@ -78977,8 +81612,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: + - *341 - *342 - - *343 - *109 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -78999,9 +81634,9 @@ paths: application/json: schema: type: array - items: *543 + items: *542 examples: - default: &552 + default: &551 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -79059,17 +81694,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: + - *341 - *342 - - *343 - *101 responses: '200': description: Response content: application/json: - schema: *543 + schema: *542 examples: - default: &544 + default: &543 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -79124,8 +81759,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: + - *341 - *342 - - *343 - *101 requestBody: required: true @@ -79148,9 +81783,9 @@ paths: description: Response content: application/json: - schema: *543 + schema: *542 examples: - default: *544 + default: *543 '422': *15 x-github: githubCloudOnly: false @@ -79168,8 +81803,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: + - *341 - *342 - - *343 - *101 responses: '204': @@ -79198,15 +81833,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment parameters: + - *341 - *342 - - *343 - *101 responses: '200': description: Response content: application/json: - schema: *543 + schema: *542 examples: default: value: @@ -79262,7 +81897,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *542 + '410': *541 '422': *15 x-github: githubCloudOnly: false @@ -79279,8 +81914,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment parameters: + - *341 - *342 - - *343 - *101 responses: '204': @@ -79288,7 +81923,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *542 + '410': *541 '503': *121 x-github: githubCloudOnly: false @@ -79306,8 +81941,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: + - *341 - *342 - - *343 - *101 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -79334,9 +81969,9 @@ paths: application/json: schema: type: array - items: *474 + items: *473 examples: - default: *545 + default: *544 headers: Link: *67 '404': *6 @@ -79357,8 +81992,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: + - *341 - *342 - - *343 - *101 requestBody: required: true @@ -79391,16 +82026,16 @@ paths: description: Reaction exists content: application/json: - schema: *474 + schema: *473 examples: - default: *475 + default: *474 '201': description: Reaction created content: application/json: - schema: *474 + schema: *473 examples: - default: *475 + default: *474 '422': *15 x-github: githubCloudOnly: false @@ -79422,10 +82057,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: + - *341 - *342 - - *343 - *101 - - *546 + - *545 responses: '204': description: Response @@ -79445,8 +82080,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -79456,7 +82091,7 @@ paths: application/json: schema: type: array - items: &549 + items: &548 title: Issue Event description: Issue Event type: object @@ -79499,8 +82134,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *547 - required: *548 + properties: *546 + required: *547 nullable: true label: title: Issue Event Label @@ -79544,7 +82179,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *198 + requested_team: *197 dismissed_review: title: Issue Event Dismissed Review type: object @@ -79808,8 +82443,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: + - *341 - *342 - - *343 - name: event_id in: path required: true @@ -79820,7 +82455,7 @@ paths: description: Response content: application/json: - schema: *549 + schema: *548 examples: default: value: @@ -80013,7 +82648,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *542 + '410': *541 '403': *29 x-github: githubCloudOnly: false @@ -80047,9 +82682,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: + - *341 - *342 - - *343 - - &551 + - &550 name: issue_number description: The number that identifies the issue. in: path @@ -80065,7 +82700,7 @@ paths: examples: default: summary: Issue - value: *550 + value: *549 pinned_comment: summary: Issue with pinned comment value: @@ -80264,9 +82899,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *346 + '301': *345 '404': *6 - '410': *542 + '410': *541 '304': *37 x-github: githubCloudOnly: false @@ -80291,9 +82926,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: false content: @@ -80419,13 +83054,13 @@ paths: application/json: schema: *85 examples: - default: *550 + default: *549 '422': *15 '503': *121 '403': *29 - '301': *346 + '301': *345 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80443,9 +83078,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: false content: @@ -80473,7 +83108,7 @@ paths: application/json: schema: *85 examples: - default: *550 + default: *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80489,9 +83124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: content: application/json: @@ -80518,7 +83153,7 @@ paths: application/json: schema: *85 examples: - default: *550 + default: *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80540,9 +83175,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: + - *341 - *342 - - *343 - - *551 + - *550 - name: assignee in: path required: true @@ -80582,9 +83217,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: + - *341 - *342 - - *343 - - *551 + - *550 - *92 - *17 - *19 @@ -80595,13 +83230,13 @@ paths: application/json: schema: type: array - items: *543 + items: *542 examples: - default: *552 + default: *551 headers: Link: *67 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80630,9 +83265,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: true content: @@ -80654,16 +83289,16 @@ paths: description: Response content: application/json: - schema: *543 + schema: *542 examples: - default: *544 + default: *543 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *542 + '410': *541 '422': *15 '404': *6 x-github: @@ -80691,9 +83326,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: + - *341 - *342 - - *343 - - *551 + - *550 - *17 - *19 responses: @@ -80705,12 +83340,12 @@ paths: type: array items: *85 examples: - default: *553 + default: *552 headers: Link: *67 - '301': *346 + '301': *345 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80738,9 +83373,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: true content: @@ -80764,15 +83399,15 @@ paths: application/json: schema: *85 examples: - default: *550 + default: *549 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *346 + '301': *345 '403': *29 - '410': *542 + '410': *541 '422': *15 '404': *6 x-github: @@ -80803,9 +83438,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: + - *341 - *342 - - *343 - - *551 + - *550 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -80819,13 +83454,13 @@ paths: application/json: schema: *85 examples: - default: *550 - '301': *346 + default: *549 + '301': *345 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *542 + '410': *541 x-github: triggersNotification: true githubCloudOnly: false @@ -80851,9 +83486,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: + - *341 - *342 - - *343 - - *551 + - *550 - *17 - *19 responses: @@ -80865,12 +83500,12 @@ paths: type: array items: *85 examples: - default: *553 + default: *552 headers: Link: *67 - '301': *346 + '301': *345 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80887,9 +83522,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: + - *341 - *342 - - *343 - - *551 + - *550 - *17 - *19 responses: @@ -80903,7 +83538,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &556 + - &555 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -80957,7 +83592,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &557 + - &556 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -81093,7 +83728,7 @@ paths: - performed_via_github_app - assignee - assigner - - &558 + - &557 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -81144,7 +83779,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &559 + - &558 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -81195,7 +83830,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &560 + - &559 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -81249,7 +83884,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &561 + - &560 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -81283,7 +83918,7 @@ paths: properties: *80 required: *81 review_requester: *4 - requested_team: *198 + requested_team: *197 requested_reviewer: *4 required: - review_requester @@ -81296,7 +83931,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &562 + - &561 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -81330,7 +83965,7 @@ paths: properties: *80 required: *81 review_requester: *4 - requested_team: *198 + requested_team: *197 requested_reviewer: *4 required: - review_requester @@ -81343,7 +83978,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &563 + - &562 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -81403,7 +84038,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &564 + - &563 title: Locked Issue Event description: Locked Issue Event type: object @@ -81451,7 +84086,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &565 + - &564 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -81517,7 +84152,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &566 + - &565 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -81583,7 +84218,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &567 + - &566 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -81649,7 +84284,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &568 + - &567 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -81740,7 +84375,7 @@ paths: color: red headers: Link: *67 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81757,9 +84392,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 - *17 - *19 responses: @@ -81769,9 +84404,9 @@ paths: application/json: schema: type: array - items: *554 + items: *553 examples: - default: &667 + default: &666 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -81795,9 +84430,9 @@ paths: value: '2025-12-25' headers: Link: *67 - '301': *346 + '301': *345 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81814,9 +84449,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 - *17 - *19 responses: @@ -81828,7 +84463,7 @@ paths: type: array items: *84 examples: - default: &555 + default: &554 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -81846,9 +84481,9 @@ paths: default: false headers: Link: *67 - '301': *346 + '301': *345 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81864,9 +84499,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: false content: @@ -81911,10 +84546,10 @@ paths: type: array items: *84 examples: - default: *555 - '301': *346 + default: *554 + '301': *345 '404': *6 - '410': *542 + '410': *541 '422': *15 x-github: githubCloudOnly: false @@ -81931,9 +84566,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: false content: @@ -81995,10 +84630,10 @@ paths: type: array items: *84 examples: - default: *555 - '301': *346 + default: *554 + '301': *345 '404': *6 - '410': *542 + '410': *541 '422': *15 x-github: githubCloudOnly: false @@ -82015,15 +84650,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 responses: '204': description: Response - '301': *346 + '301': *345 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82042,9 +84677,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 - name: name in: path required: true @@ -82068,9 +84703,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *346 + '301': *345 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82090,9 +84725,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: false content: @@ -82120,7 +84755,7 @@ paths: '204': description: Response '403': *29 - '410': *542 + '410': *541 '404': *6 '422': *15 x-github: @@ -82138,9 +84773,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 responses: '204': description: Response @@ -82170,9 +84805,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 responses: '200': description: Response @@ -82180,10 +84815,10 @@ paths: application/json: schema: *85 examples: - default: *550 - '301': *346 + default: *549 + '301': *345 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82200,9 +84835,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 - 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. @@ -82228,13 +84863,13 @@ paths: application/json: schema: type: array - items: *474 + items: *473 examples: - default: *545 + default: *544 headers: Link: *67 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82252,9 +84887,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: true content: @@ -82286,16 +84921,16 @@ paths: description: Response content: application/json: - schema: *474 + schema: *473 examples: - default: *475 + default: *474 '201': description: Response content: application/json: - schema: *474 + schema: *473 examples: - default: *475 + default: *474 '422': *15 x-github: githubCloudOnly: false @@ -82317,10 +84952,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: + - *341 - *342 - - *343 - - *551 - - *546 + - *550 + - *545 responses: '204': description: Response @@ -82349,9 +84984,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: true content: @@ -82375,7 +85010,7 @@ paths: application/json: schema: *85 examples: - default: *550 + default: *549 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -82408,9 +85043,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: + - *341 - *342 - - *343 - - *551 + - *550 - *17 - *19 responses: @@ -82422,11 +85057,11 @@ paths: type: array items: *85 examples: - default: *553 + default: *552 headers: Link: *67 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82454,9 +85089,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: true content: @@ -82485,14 +85120,14 @@ paths: application/json: schema: *85 examples: - default: *550 + default: *549 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *542 + '410': *541 '422': *15 '404': *6 x-github: @@ -82512,9 +85147,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: true content: @@ -82547,7 +85182,7 @@ paths: application/json: schema: *85 examples: - default: *550 + default: *549 '403': *29 '404': *6 '422': *7 @@ -82569,9 +85204,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 - *17 - *19 responses: @@ -82586,6 +85221,7 @@ paths: description: Timeline Event type: object anyOf: + - *555 - *556 - *557 - *558 @@ -82598,7 +85234,6 @@ paths: - *565 - *566 - *567 - - *568 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -82659,8 +85294,8 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *569 - required: *570 + properties: *568 + required: *569 nullable: true required: - event @@ -82915,7 +85550,7 @@ paths: type: string comments: type: array - items: &590 + items: &589 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -83130,7 +85765,7 @@ paths: type: string comments: type: array - items: *473 + items: *472 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -83419,7 +86054,7 @@ paths: headers: Link: *67 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83436,8 +86071,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -83447,7 +86082,7 @@ paths: application/json: schema: type: array - items: &571 + items: &570 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -83513,8 +86148,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -83550,9 +86185,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *570 examples: - default: &572 + default: &571 value: id: 1 key: ssh-rsa AAA... @@ -83586,9 +86221,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: + - *341 - *342 - - *343 - - &573 + - &572 name: key_id description: The unique identifier of the key. in: path @@ -83600,9 +86235,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *570 examples: - default: *572 + default: *571 '404': *6 x-github: githubCloudOnly: false @@ -83620,9 +86255,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: + - *341 - *342 - - *343 - - *573 + - *572 responses: '204': description: Response @@ -83642,8 +86277,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -83655,7 +86290,7 @@ paths: type: array items: *84 examples: - default: *555 + default: *554 headers: Link: *67 '404': *6 @@ -83676,8 +86311,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -83715,7 +86350,7 @@ paths: application/json: schema: *84 examples: - default: &574 + default: &573 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -83747,8 +86382,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: + - *341 - *342 - - *343 - name: name in: path required: true @@ -83761,7 +86396,7 @@ paths: application/json: schema: *84 examples: - default: *574 + default: *573 '404': *6 x-github: githubCloudOnly: false @@ -83778,8 +86413,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: + - *341 - *342 - - *343 - name: name in: path required: true @@ -83844,8 +86479,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: + - *341 - *342 - - *343 - name: name in: path required: true @@ -83871,8 +86506,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -83911,9 +86546,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: + - *341 - *342 - - *343 - - *446 + - *445 responses: '200': description: Response @@ -84058,8 +86693,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -84124,8 +86759,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -84159,9 +86794,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *476 + schema: *475 examples: - default: *575 + default: *574 '204': description: Response when already merged '404': @@ -84186,8 +86821,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: + - *341 - *342 - - *343 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -84228,12 +86863,12 @@ paths: application/json: schema: type: array - items: &576 + items: &575 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *279 - required: *280 + properties: *278 + required: *279 examples: default: value: @@ -84289,8 +86924,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -84330,9 +86965,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *575 examples: - default: &577 + default: &576 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -84391,9 +87026,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: + - *341 - *342 - - *343 - - &578 + - &577 name: milestone_number description: The number that identifies the milestone. in: path @@ -84405,9 +87040,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *575 examples: - default: *577 + default: *576 '404': *6 x-github: githubCloudOnly: false @@ -84424,9 +87059,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: + - *341 - *342 - - *343 - - *578 + - *577 requestBody: required: false content: @@ -84464,9 +87099,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *575 examples: - default: *577 + default: *576 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84482,9 +87117,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: + - *341 - *342 - - *343 - - *578 + - *577 responses: '204': description: Response @@ -84505,9 +87140,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: + - *341 - *342 - - *343 - - *578 + - *577 - *17 - *19 responses: @@ -84519,7 +87154,7 @@ paths: type: array items: *84 examples: - default: *555 + default: *554 headers: Link: *67 x-github: @@ -84538,12 +87173,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: + - *341 - *342 - - *343 + - *578 - *579 - - *580 - *92 - - *581 + - *580 - *17 - *19 responses: @@ -84555,7 +87190,7 @@ paths: type: array items: *112 examples: - default: *582 + default: *581 headers: Link: *67 x-github: @@ -84579,8 +87214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: + - *341 - *342 - - *343 requestBody: required: false content: @@ -84638,14 +87273,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: &583 + schema: &582 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -84770,7 +87405,7 @@ paths: - custom_404 - public examples: - default: &584 + default: &583 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -84811,8 +87446,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -84866,9 +87501,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *582 examples: - default: *584 + default: *583 '422': *15 '409': *54 x-github: @@ -84891,8 +87526,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -84991,8 +87626,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -85018,8 +87653,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -85029,7 +87664,7 @@ paths: application/json: schema: type: array - items: &585 + items: &584 title: Page Build description: Page Build type: object @@ -85123,8 +87758,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: + - *341 - *342 - - *343 responses: '201': description: Response @@ -85169,16 +87804,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *585 + schema: *584 examples: - default: &586 + default: &585 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -85226,8 +87861,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: + - *341 - *342 - - *343 - name: build_id in: path required: true @@ -85238,9 +87873,9 @@ paths: description: Response content: application/json: - schema: *585 + schema: *584 examples: - default: *586 + default: *585 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85260,8 +87895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -85366,9 +88001,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: + - *341 - *342 - - *343 - - &587 + - &586 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -85426,11 +88061,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: + - *341 - *342 - - *343 - - *587 + - *586 responses: - '204': *192 + '204': *191 '404': *6 x-github: githubCloudOnly: false @@ -85455,8 +88090,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -85687,7 +88322,7 @@ paths: description: Empty response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -85714,8 +88349,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: + - *341 - *342 - - *343 responses: '200': description: Private vulnerability reporting status @@ -85752,10 +88387,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: + - *341 - *342 - - *343 responses: - '204': *192 + '204': *191 '422': *14 x-github: githubCloudOnly: false @@ -85774,10 +88409,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: + - *341 - *342 - - *343 responses: - '204': *192 + '204': *191 '422': *14 x-github: githubCloudOnly: false @@ -85797,8 +88432,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -85806,7 +88441,7 @@ paths: application/json: schema: type: array - items: *294 + items: *293 examples: default: value: @@ -85837,8 +88472,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: + - *341 - *342 - - *343 requestBody: required: true content: @@ -85850,7 +88485,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *294 + items: *293 required: - properties examples: @@ -85900,8 +88535,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: + - *341 - *342 - - *343 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -85961,9 +88596,9 @@ paths: application/json: schema: type: array - items: *480 + items: *479 examples: - default: *588 + default: *587 headers: Link: *67 '304': *37 @@ -85995,8 +88630,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -86061,7 +88696,7 @@ paths: description: Response content: application/json: - schema: &592 + schema: &591 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -86172,8 +88807,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *279 - required: *280 + properties: *278 + required: *279 nullable: true active_lock_reason: type: string @@ -86216,7 +88851,7 @@ paths: items: *4 requested_teams: type: array - items: *331 + items: *330 head: type: object properties: @@ -86254,14 +88889,14 @@ paths: _links: type: object properties: - comments: *281 - commits: *281 - statuses: *281 - html: *281 - issue: *281 - review_comments: *281 - review_comment: *281 - self: *281 + comments: *280 + commits: *280 + statuses: *280 + html: *280 + issue: *280 + review_comments: *280 + review_comment: *280 + self: *280 required: - comments - commits @@ -86272,7 +88907,7 @@ paths: - review_comment - self author_association: *82 - auto_merge: *589 + auto_merge: *588 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -86364,7 +88999,7 @@ paths: - merged_by - review_comments examples: - default: &593 + default: &592 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -86891,8 +89526,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: + - *341 - *342 - - *343 - name: sort in: query required: false @@ -86921,9 +89556,9 @@ paths: application/json: schema: type: array - items: *590 + items: *589 examples: - default: &595 + default: &594 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -87000,17 +89635,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: + - *341 - *342 - - *343 - *101 responses: '200': description: Response content: application/json: - schema: *590 + schema: *589 examples: - default: &591 + default: &590 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -87085,8 +89720,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: + - *341 - *342 - - *343 - *101 requestBody: required: true @@ -87109,9 +89744,9 @@ paths: description: Response content: application/json: - schema: *590 + schema: *589 examples: - default: *591 + default: *590 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87127,8 +89762,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: + - *341 - *342 - - *343 - *101 responses: '204': @@ -87150,8 +89785,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: + - *341 - *342 - - *343 - *101 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -87178,9 +89813,9 @@ paths: application/json: schema: type: array - items: *474 + items: *473 examples: - default: *545 + default: *544 headers: Link: *67 '404': *6 @@ -87201,8 +89836,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: + - *341 - *342 - - *343 - *101 requestBody: required: true @@ -87235,16 +89870,16 @@ paths: description: Reaction exists content: application/json: - schema: *474 + schema: *473 examples: - default: *475 + default: *474 '201': description: Reaction created content: application/json: - schema: *474 + schema: *473 examples: - default: *475 + default: *474 '422': *15 x-github: githubCloudOnly: false @@ -87266,10 +89901,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: + - *341 - *342 - - *343 - *101 - - *546 + - *545 responses: '204': description: Response @@ -87312,9 +89947,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: + - *341 - *342 - - *343 - - &594 + - &593 name: pull_number description: The number that identifies the pull request. in: path @@ -87327,9 +89962,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *592 + schema: *591 examples: - default: *593 + default: *592 '304': *37 '404': *6 '406': @@ -87364,9 +89999,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 requestBody: required: false content: @@ -87408,9 +90043,9 @@ paths: description: Response content: application/json: - schema: *592 + schema: *591 examples: - default: *593 + default: *592 '422': *15 '403': *29 x-github: @@ -87432,9 +90067,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 requestBody: required: true content: @@ -87494,17 +90129,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '401': *25 '403': *29 '404': *6 @@ -87534,9 +90169,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 - *109 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -87557,9 +90192,9 @@ paths: application/json: schema: type: array - items: *590 + items: *589 examples: - default: *595 + default: *594 headers: Link: *67 x-github: @@ -87592,9 +90227,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 requestBody: required: true content: @@ -87699,7 +90334,7 @@ paths: description: Response content: application/json: - schema: *590 + schema: *589 examples: example-for-a-multi-line-comment: value: @@ -87787,9 +90422,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: + - *341 - *342 - - *343 - - *594 + - *593 - *101 requestBody: required: true @@ -87812,7 +90447,7 @@ paths: description: Response content: application/json: - schema: *590 + schema: *589 examples: default: value: @@ -87898,9 +90533,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 - *17 - *19 responses: @@ -87910,9 +90545,9 @@ paths: application/json: schema: type: array - items: *476 + items: *475 examples: - default: *596 + default: *595 headers: Link: *67 x-github: @@ -87942,9 +90577,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: + - *341 - *342 - - *343 - - *594 + - *593 - *17 - *19 responses: @@ -87954,7 +90589,7 @@ paths: application/json: schema: type: array - items: *489 + items: *488 examples: default: value: @@ -87992,9 +90627,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: + - *341 - *342 - - *343 - - *594 + - *593 responses: '204': description: Response if pull request has been merged @@ -88017,9 +90652,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 requestBody: required: false content: @@ -88130,9 +90765,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 responses: '200': description: Response @@ -88148,7 +90783,7 @@ paths: items: *4 teams: type: array - items: *198 + items: *197 required: - users - teams @@ -88207,9 +90842,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 requestBody: required: false content: @@ -88246,7 +90881,7 @@ paths: description: Response content: application/json: - schema: *480 + schema: *479 examples: default: value: @@ -88782,9 +91417,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 requestBody: required: true content: @@ -88818,7 +91453,7 @@ paths: description: Response content: application/json: - schema: *480 + schema: *479 examples: default: value: @@ -89323,9 +91958,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 - *17 - *19 responses: @@ -89335,7 +91970,7 @@ paths: application/json: schema: type: array - items: &597 + items: &596 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -89486,9 +92121,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 requestBody: required: false content: @@ -89574,9 +92209,9 @@ paths: description: Response content: application/json: - schema: *597 + schema: *596 examples: - default: &599 + default: &598 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -89639,10 +92274,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 - - &598 + - *593 + - &597 name: review_id description: The unique identifier of the review. in: path @@ -89654,9 +92289,9 @@ paths: description: Response content: application/json: - schema: *597 + schema: *596 examples: - default: &600 + default: &599 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -89715,10 +92350,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 - - *598 + - *593 + - *597 requestBody: required: true content: @@ -89741,7 +92376,7 @@ paths: description: Response content: application/json: - schema: *597 + schema: *596 examples: default: value: @@ -89803,18 +92438,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 - - *598 + - *593 + - *597 responses: '200': description: Response content: application/json: - schema: *597 + schema: *596 examples: - default: *599 + default: *598 '422': *7 '404': *6 x-github: @@ -89841,10 +92476,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: + - *341 - *342 - - *343 - - *594 - - *598 + - *593 + - *597 - *17 - *19 responses: @@ -89927,9 +92562,9 @@ paths: _links: type: object properties: - self: *281 - html: *281 - pull_request: *281 + self: *280 + html: *280 + pull_request: *280 required: - self - html @@ -90079,10 +92714,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 - - *598 + - *593 + - *597 requestBody: required: true content: @@ -90110,7 +92745,7 @@ paths: description: Response content: application/json: - schema: *597 + schema: *596 examples: default: value: @@ -90173,10 +92808,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 - - *598 + - *593 + - *597 requestBody: required: true content: @@ -90211,9 +92846,9 @@ paths: description: Response content: application/json: - schema: *597 + schema: *596 examples: - default: *600 + default: *599 '404': *6 '422': *7 '403': *29 @@ -90235,9 +92870,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: + - *341 - *342 - - *343 - - *594 + - *593 requestBody: required: false content: @@ -90300,8 +92935,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: + - *341 - *342 - - *343 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -90314,9 +92949,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *600 examples: - default: &602 + default: &601 value: type: file encoding: base64 @@ -90358,8 +92993,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: + - *341 - *342 - - *343 - name: dir description: The alternate path to look for a README file in: path @@ -90379,9 +93014,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *600 examples: - default: *602 + default: *601 '404': *6 '422': *15 x-github: @@ -90403,8 +93038,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -90414,7 +93049,7 @@ paths: application/json: schema: type: array - items: *603 + items: *602 examples: default: value: @@ -90508,8 +93143,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -90585,9 +93220,9 @@ paths: description: Response content: application/json: - schema: *603 + schema: *602 examples: - default: &607 + default: &606 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -90692,9 +93327,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: + - *341 - *342 - - *343 - - &605 + - &604 name: asset_id description: The unique identifier of the asset. in: path @@ -90706,9 +93341,9 @@ paths: description: Response content: application/json: - schema: *604 + schema: *603 examples: - default: &606 + default: &605 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 @@ -90743,7 +93378,7 @@ paths: type: User site_admin: false '404': *6 - '302': *491 + '302': *490 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90759,9 +93394,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: + - *341 - *342 - - *343 - - *605 + - *604 requestBody: required: false content: @@ -90789,9 +93424,9 @@ paths: description: Response content: application/json: - schema: *604 + schema: *603 examples: - default: *606 + default: *605 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90807,9 +93442,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: + - *341 - *342 - - *343 - - *605 + - *604 responses: '204': description: Response @@ -90834,8 +93469,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -90920,16 +93555,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *603 + schema: *602 examples: - default: *607 + default: *606 '404': *6 x-github: githubCloudOnly: false @@ -90947,8 +93582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: + - *341 - *342 - - *343 - name: tag description: tag parameter in: path @@ -90961,9 +93596,9 @@ paths: description: Response content: application/json: - schema: *603 + schema: *602 examples: - default: *607 + default: *606 '404': *6 x-github: githubCloudOnly: false @@ -90985,9 +93620,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: + - *341 - *342 - - *343 - - &608 + - &607 name: release_id description: The unique identifier of the release. in: path @@ -91001,9 +93636,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: *603 + schema: *602 examples: - default: *607 + default: *606 '401': description: Unauthorized x-github: @@ -91021,9 +93656,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: + - *341 - *342 - - *343 - - *608 + - *607 requestBody: required: false content: @@ -91087,9 +93722,9 @@ paths: description: Response content: application/json: - schema: *603 + schema: *602 examples: - default: *607 + default: *606 '404': description: Not Found if the discussion category name is invalid content: @@ -91110,9 +93745,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: + - *341 - *342 - - *343 - - *608 + - *607 responses: '204': description: Response @@ -91133,9 +93768,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: + - *341 - *342 - - *343 - - *608 + - *607 - *17 - *19 responses: @@ -91145,7 +93780,7 @@ paths: application/json: schema: type: array - items: *604 + items: *603 examples: default: value: @@ -91226,9 +93861,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: + - *341 - *342 - - *343 - - *608 + - *607 - name: name in: query required: true @@ -91254,7 +93889,7 @@ paths: description: Response for successful upload content: application/json: - schema: *604 + schema: *603 examples: response-for-successful-upload: value: @@ -91309,9 +93944,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: + - *341 - *342 - - *343 - - *608 + - *607 - 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. @@ -91335,9 +93970,9 @@ paths: application/json: schema: type: array - items: *474 + items: *473 examples: - default: *545 + default: *544 headers: Link: *67 '404': *6 @@ -91358,9 +93993,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: + - *341 - *342 - - *343 - - *608 + - *607 requestBody: required: true content: @@ -91390,16 +94025,16 @@ paths: description: Reaction exists content: application/json: - schema: *474 + schema: *473 examples: - default: *475 + default: *474 '201': description: Reaction created content: application/json: - schema: *474 + schema: *473 examples: - default: *475 + default: *474 '422': *15 x-github: githubCloudOnly: false @@ -91421,10 +94056,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: + - *341 - *342 - - *343 - - *608 - - *546 + - *607 + - *545 responses: '204': description: Response @@ -91448,9 +94083,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: + - *341 - *342 - - *343 - - *409 + - *408 - *17 - *19 responses: @@ -91466,8 +94101,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *303 - - &609 + - *302 + - &608 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -91486,69 +94121,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. + - allOf: + - *303 + - *608 - allOf: - *304 - - *609 + - *608 - allOf: - *305 - - *609 + - *608 - allOf: - - *306 - *609 + - *608 - allOf: - - *610 - - *609 + - *306 + - *608 - allOf: - *307 - - *609 + - *608 - allOf: - *308 - - *609 + - *608 - allOf: - *309 - - *609 + - *608 - allOf: - *310 - - *609 + - *608 - allOf: - *311 - - *609 + - *608 - allOf: - *312 - - *609 + - *608 - allOf: - *313 - - *609 + - *608 - allOf: - *314 - - *609 + - *608 - allOf: - *315 - - *609 + - *608 - allOf: - *316 - - *609 + - *608 - allOf: - *317 - - *609 + - *608 - allOf: - *318 - - *609 + - *608 - allOf: - *319 - - *609 + - *608 - allOf: - *320 - - *609 + - *608 - allOf: - *321 - - *609 + - *608 - allOf: - *322 - - *609 - - allOf: - - *323 - - *609 + - *608 examples: default: value: @@ -91587,8 +94222,8 @@ paths: category: repos subcategory: rules parameters: + - *341 - *342 - - *343 - *17 - *19 - name: includes_parents @@ -91599,7 +94234,7 @@ paths: schema: type: boolean default: true - - *611 + - *610 responses: '200': description: Response @@ -91607,7 +94242,7 @@ paths: application/json: schema: type: array - items: *324 + items: *323 examples: default: value: @@ -91654,8 +94289,8 @@ paths: category: repos subcategory: rules parameters: + - *341 - *342 - - *343 requestBody: description: Request body required: true @@ -91675,16 +94310,16 @@ paths: - tag - push default: branch - enforcement: *300 + enforcement: *299 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *301 - conditions: *298 + items: *300 + conditions: *297 rules: type: array description: An array of rules within the ruleset. - items: *612 + items: *611 required: - name - enforcement @@ -91715,9 +94350,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *323 examples: - default: &622 + default: &621 value: id: 42 name: super cool ruleset @@ -91765,12 +94400,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: + - *341 - *342 - - *343 + - *612 - *613 - *614 - *615 - - *616 - *17 - *19 responses: @@ -91778,9 +94413,9 @@ paths: description: Response content: application/json: - schema: *617 + schema: *616 examples: - default: *618 + default: *617 '404': *6 '500': *55 x-github: @@ -91801,17 +94436,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: + - *341 - *342 - - *343 - - *619 + - *618 responses: '200': description: Response content: application/json: - schema: *620 + schema: *619 examples: - default: *621 + default: *620 '404': *6 '500': *55 x-github: @@ -91839,8 +94474,8 @@ paths: category: repos subcategory: rules parameters: + - *341 - *342 - - *343 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91860,9 +94495,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *323 examples: - default: *622 + default: *621 '404': *6 '500': *55 put: @@ -91880,8 +94515,8 @@ paths: category: repos subcategory: rules parameters: + - *341 - *342 - - *343 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91906,16 +94541,16 @@ paths: - branch - tag - push - enforcement: *300 + enforcement: *299 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *301 - conditions: *298 + items: *300 + conditions: *297 rules: description: An array of rules within the ruleset. type: array - items: *612 + items: *611 examples: default: value: @@ -91943,9 +94578,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *323 examples: - default: *622 + default: *621 '404': *6 '422': *15 '500': *55 @@ -91964,8 +94599,8 @@ paths: category: repos subcategory: rules parameters: + - *341 - *342 - - *343 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91988,8 +94623,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: + - *341 - *342 - - *343 - *17 - *19 - name: ruleset_id @@ -92005,9 +94640,9 @@ paths: application/json: schema: type: array - items: *327 + items: *326 examples: - default: *623 + default: *622 '404': *6 '500': *55 x-github: @@ -92026,8 +94661,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: + - *341 - *342 - - *343 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92045,7 +94680,7 @@ paths: description: Response content: application/json: - schema: *624 + schema: *623 examples: default: value: @@ -92100,22 +94735,22 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: + - *341 - *342 - - *343 + - *624 - *625 - *626 - *627 - *628 - - *629 - *61 - *19 - *17 + - *629 - *630 - *631 - *632 - *633 - *634 - - *635 responses: '200': description: Response @@ -92123,11 +94758,11 @@ paths: application/json: schema: type: array - items: &639 + items: &638 type: object properties: - number: *179 - created_at: *180 + number: *178 + created_at: *179 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -92135,15 +94770,15 @@ paths: format: date-time readOnly: true nullable: true - url: *182 - html_url: *183 + url: *181 + html_url: *182 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *636 - resolution: *637 + state: *635 + resolution: *636 resolved_at: type: string format: date-time @@ -92239,7 +94874,7 @@ paths: pull request. ' - oneOf: *638 + oneOf: *637 nullable: true has_more_locations: type: boolean @@ -92388,16 +95023,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: + - *341 - *342 - - *343 - - *440 - - *635 + - *439 + - *634 responses: '200': description: Response content: application/json: - schema: *639 + schema: *638 examples: default: value: @@ -92451,9 +95086,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: + - *341 - *342 - - *343 - - *440 + - *439 requestBody: required: true content: @@ -92461,8 +95096,8 @@ paths: schema: type: object properties: - state: *636 - resolution: *637 + state: *635 + resolution: *636 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -92498,7 +95133,7 @@ paths: description: Response content: application/json: - schema: *639 + schema: *638 examples: default: value: @@ -92593,9 +95228,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: + - *341 - *342 - - *343 - - *440 + - *439 - *19 - *17 responses: @@ -92606,7 +95241,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &797 + items: &796 type: object properties: type: @@ -92632,6 +95267,7 @@ paths: example: commit details: oneOf: + - *639 - *640 - *641 - *642 @@ -92644,7 +95280,6 @@ paths: - *649 - *650 - *651 - - *652 examples: default: value: @@ -92730,8 +95365,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -92739,14 +95374,14 @@ paths: schema: type: object properties: - reason: &654 + reason: &653 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *653 + placeholder_id: *652 required: - reason - placeholder_id @@ -92763,7 +95398,7 @@ paths: schema: type: object properties: - reason: *654 + reason: *653 expire_at: type: string format: date-time @@ -92809,8 +95444,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: + - *341 - *342 - - *343 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -92825,7 +95460,7 @@ paths: properties: incremental_scans: type: array - items: &655 + items: &654 description: Information on a single scan performed by secret scanning on the repository type: object @@ -92851,15 +95486,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *655 + items: *654 backfill_scans: type: array - items: *655 + items: *654 custom_pattern_backfill_scans: type: array items: allOf: - - *655 + - *654 - type: object properties: pattern_name: @@ -92929,8 +95564,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: + - *341 - *342 - - *343 - *61 - name: sort description: The property to sort the results by. @@ -92974,9 +95609,9 @@ paths: application/json: schema: type: array - items: *656 + items: *655 examples: - default: *657 + default: *656 '400': *14 '404': *6 x-github: @@ -92999,8 +95634,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -93073,7 +95708,7 @@ paths: login: type: string description: The username of the user credited. - type: *330 + type: *329 required: - login - type @@ -93160,9 +95795,9 @@ paths: description: Response content: application/json: - schema: *656 + schema: *655 examples: - default: &659 + default: &658 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -93395,8 +96030,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -93500,7 +96135,7 @@ paths: description: Response content: application/json: - schema: *656 + schema: *655 examples: default: value: @@ -93647,17 +96282,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: + - *341 - *342 - - *343 - - *658 + - *657 responses: '200': description: Response content: application/json: - schema: *656 + schema: *655 examples: - default: *659 + default: *658 '403': *29 '404': *6 x-github: @@ -93681,9 +96316,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: + - *341 - *342 - - *343 - - *658 + - *657 requestBody: required: true content: @@ -93756,7 +96391,7 @@ paths: login: type: string description: The username of the user credited. - type: *330 + type: *329 required: - login - type @@ -93842,10 +96477,10 @@ paths: description: Response content: application/json: - schema: *656 + schema: *655 examples: - default: *659 - add_credit: *659 + default: *658 + add_credit: *658 '403': *29 '404': *6 '422': @@ -93883,9 +96518,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: + - *341 - *342 - - *343 - - *658 + - *657 responses: '202': *39 '400': *14 @@ -93912,17 +96547,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: + - *341 - *342 - - *343 - - *658 + - *657 responses: '202': description: Response content: application/json: - schema: *345 + schema: *344 examples: - default: *347 + default: *346 '400': *14 '422': *15 '403': *29 @@ -93948,8 +96583,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -94048,8 +96683,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: + - *341 - *342 - - *343 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -94058,7 +96693,7 @@ paths: application/json: schema: type: array - items: &660 + items: &659 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -94071,7 +96706,7 @@ paths: - 1124 - -435 '202': *39 - '204': *192 + '204': *191 '422': description: Repository contains more than 10,000 commits x-github: @@ -94091,8 +96726,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -94141,7 +96776,7 @@ paths: total: 89 week: 1336280400 '202': *39 - '204': *192 + '204': *191 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94168,8 +96803,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -94243,7 +96878,7 @@ paths: d: 77 c: 10 '202': *39 - '204': *192 + '204': *191 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94265,8 +96900,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: + - *341 - *342 - - *343 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -94420,8 +97055,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: + - *341 - *342 - - *343 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -94431,7 +97066,7 @@ paths: application/json: schema: type: array - items: *660 + items: *659 examples: default: value: @@ -94444,7 +97079,7 @@ paths: - - 0 - 2 - 21 - '204': *192 + '204': *191 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94464,8 +97099,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: + - *341 - *342 - - *343 - name: sha in: path required: true @@ -94519,7 +97154,7 @@ paths: description: Response content: application/json: - schema: *661 + schema: *660 examples: default: value: @@ -94573,8 +97208,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -94606,14 +97241,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: + - *341 - *342 - - *343 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &662 + schema: &661 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -94681,8 +97316,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: + - *341 - *342 - - *343 requestBody: required: false content: @@ -94708,7 +97343,7 @@ paths: description: Response content: application/json: - schema: *662 + schema: *661 examples: default: value: @@ -94735,8 +97370,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -94756,8 +97391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -94836,8 +97471,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: + - *341 - *342 - - *343 - name: ref in: path required: true @@ -94873,8 +97508,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -94884,9 +97519,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *259 + default: *258 headers: Link: *67 '404': *6 @@ -94906,8 +97541,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: + - *341 - *342 - - *343 - *19 - *17 responses: @@ -94915,7 +97550,7 @@ paths: description: Response content: application/json: - schema: &663 + schema: &662 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -94927,7 +97562,7 @@ paths: required: - names examples: - default: &664 + default: &663 value: names: - octocat @@ -94950,8 +97585,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -94982,9 +97617,9 @@ paths: description: Response content: application/json: - schema: *663 + schema: *662 examples: - default: *664 + default: *663 '404': *6 '422': *7 x-github: @@ -95005,9 +97640,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: + - *341 - *342 - - *343 - - &665 + - &664 name: per description: The time frame to display results for. in: query @@ -95036,7 +97671,7 @@ paths: example: 128 clones: type: array - items: &666 + items: &665 title: Traffic type: object properties: @@ -95123,8 +97758,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -95214,8 +97849,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -95275,9 +97910,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: + - *341 - *342 - - *343 - - *665 + - *664 responses: '200': description: Response @@ -95296,7 +97931,7 @@ paths: example: 3782 views: type: array - items: *666 + items: *665 required: - uniques - count @@ -95373,8 +98008,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -95410,7 +98045,7 @@ paths: description: Response content: application/json: - schema: *161 + schema: *160 examples: default: value: @@ -95648,8 +98283,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: + - *341 - *342 - - *343 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -95672,8 +98307,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -95695,8 +98330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -95722,8 +98357,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: + - *341 - *342 - - *343 - name: ref in: path required: true @@ -95815,9 +98450,9 @@ paths: description: Response content: application/json: - schema: *345 + schema: *344 examples: - default: *347 + default: *346 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -95858,7 +98493,7 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: default: value: @@ -95964,8 +98599,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *150 - - *551 + - *149 + - *550 requestBody: required: true content: @@ -96029,9 +98664,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *554 + items: *553 examples: - default: *667 + default: *666 '400': *14 '403': *29 '404': *6 @@ -96067,8 +98702,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *150 - - *551 + - *149 + - *550 requestBody: required: true content: @@ -96133,9 +98768,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *554 + items: *553 examples: - default: *667 + default: *666 '400': *14 '403': *29 '404': *6 @@ -96166,9 +98801,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: - - *150 - - *551 - - *241 + - *149 + - *550 + - *240 responses: '204': description: Issue field value deleted successfully @@ -96289,7 +98924,7 @@ paths: html_url: type: string format: uri - repository: *161 + repository: *160 score: type: number file_size: @@ -96307,7 +98942,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &668 + text_matches: &667 title: Search Result Text Matches type: array items: @@ -96469,7 +99104,7 @@ paths: enum: - author-date - committer-date - - &669 + - &668 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 @@ -96540,7 +99175,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *407 + properties: *406 nullable: true comment_count: type: integer @@ -96560,7 +99195,7 @@ paths: url: type: string format: uri - verification: *528 + verification: *527 required: - author - committer @@ -96579,7 +99214,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *407 + properties: *406 nullable: true parents: type: array @@ -96592,12 +99227,12 @@ paths: type: string sha: type: string - repository: *161 + repository: *160 score: type: number node_id: type: string - text_matches: *668 + text_matches: *667 required: - sha - node_id @@ -96789,7 +99424,7 @@ paths: - interactions - created - updated - - *669 + - *668 - *17 - *19 - name: advanced_search @@ -96903,11 +99538,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: type: string state_reason: @@ -96924,8 +99559,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *279 - required: *280 + properties: *278 + required: *279 nullable: true comments: type: integer @@ -96939,7 +99574,7 @@ paths: type: string format: date-time nullable: true - text_matches: *668 + text_matches: *667 pull_request: type: object properties: @@ -96983,7 +99618,7 @@ paths: timeline_url: type: string format: uri - type: *242 + type: *241 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -97211,7 +99846,7 @@ paths: enum: - created - updated - - *669 + - *668 - *17 - *19 responses: @@ -97255,7 +99890,7 @@ paths: nullable: true score: type: number - text_matches: *668 + text_matches: *667 required: - id - node_id @@ -97340,7 +99975,7 @@ paths: - forks - help-wanted-issues - updated - - *669 + - *668 - *17 - *19 responses: @@ -97588,7 +100223,7 @@ paths: - admin - pull - push - text_matches: *668 + text_matches: *667 temp_clone_token: type: string allow_merge_commit: @@ -97888,7 +100523,7 @@ paths: type: string format: uri nullable: true - text_matches: *668 + text_matches: *667 related: type: array nullable: true @@ -98079,7 +100714,7 @@ paths: - followers - repositories - joined - - *669 + - *668 - *17 - *19 responses: @@ -98183,7 +100818,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *668 + text_matches: *667 blog: type: string nullable: true @@ -98262,7 +100897,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &672 + - &671 name: team_id description: The unique identifier of the team. in: path @@ -98274,9 +100909,9 @@ paths: description: Response content: application/json: - schema: *338 + schema: *337 examples: - default: *339 + default: *338 '404': *6 x-github: githubCloudOnly: false @@ -98303,7 +100938,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *672 + - *671 requestBody: required: true content: @@ -98366,16 +101001,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *338 + schema: *337 examples: - default: *339 + default: *338 '201': description: Response content: application/json: - schema: *338 + schema: *337 examples: - default: *339 + default: *338 '404': *6 '422': *15 '403': *29 @@ -98403,7 +101038,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *672 + - *671 responses: '204': description: Response @@ -98432,7 +101067,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *672 + - *671 - *17 - *19 responses: @@ -98442,9 +101077,9 @@ paths: application/json: schema: type: array - items: *236 + items: *235 examples: - default: *237 + default: *236 headers: Link: *67 x-github: @@ -98470,7 +101105,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *672 + - *671 - name: role description: Filters members returned by their role in the team. in: query @@ -98521,7 +101156,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *672 + - *671 - *71 responses: '204': @@ -98558,7 +101193,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *672 + - *671 - *71 responses: '204': @@ -98598,7 +101233,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *672 + - *671 - *71 responses: '204': @@ -98635,16 +101270,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *672 + - *671 - *71 responses: '200': description: Response content: application/json: - schema: *341 + schema: *340 examples: - response-if-user-is-a-team-maintainer: *673 + response-if-user-is-a-team-maintainer: *672 '404': *6 x-github: githubCloudOnly: false @@ -98677,7 +101312,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *672 + - *671 - *71 requestBody: required: false @@ -98703,9 +101338,9 @@ paths: description: Response content: application/json: - schema: *341 + schema: *340 examples: - response-if-users-membership-with-team-is-now-pending: *674 + response-if-users-membership-with-team-is-now-pending: *673 '403': description: Forbidden if team synchronization is set up '422': @@ -98739,7 +101374,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *672 + - *671 - *71 responses: '204': @@ -98767,7 +101402,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *672 + - *671 - *17 - *19 responses: @@ -98777,9 +101412,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *266 + default: *265 headers: Link: *67 '404': *6 @@ -98809,15 +101444,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *672 + - *671 + - *341 - *342 - - *343 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *675 + schema: *674 examples: alternative-response-with-extra-repository-information: value: @@ -98968,9 +101603,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *672 + - *671 + - *341 - *342 - - *343 requestBody: required: false content: @@ -99020,9 +101655,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *672 + - *671 + - *341 - *342 - - *343 responses: '204': description: Response @@ -99047,7 +101682,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *672 + - *671 - *17 - *19 responses: @@ -99057,9 +101692,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - response-if-child-teams-exist: *676 + response-if-child-teams-exist: *675 headers: Link: *67 '404': *6 @@ -99092,7 +101727,7 @@ paths: application/json: schema: oneOf: - - &678 + - &677 title: Private User description: Private User type: object @@ -99295,7 +101930,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *677 + - *676 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -99448,7 +102083,7 @@ paths: description: Response content: application/json: - schema: *678 + schema: *677 examples: default: value: @@ -99651,9 +102286,9 @@ paths: type: integer codespaces: type: array - items: *247 + items: *246 examples: - default: *248 + default: *247 '304': *37 '500': *55 '401': *25 @@ -99792,17 +102427,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '401': *25 '403': *29 '404': *6 @@ -99846,7 +102481,7 @@ paths: type: integer secrets: type: array - items: &679 + items: &678 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -99886,7 +102521,7 @@ paths: - visibility - selected_repositories_url examples: - default: *466 + default: *465 headers: Link: *67 x-github: @@ -99956,13 +102591,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *169 + - *168 responses: '200': description: Response content: application/json: - schema: *679 + schema: *678 examples: default: value: @@ -99992,7 +102627,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *169 + - *168 requestBody: required: true content: @@ -100037,7 +102672,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -100065,7 +102700,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *169 + - *168 responses: '204': description: Response @@ -100090,7 +102725,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *169 + - *168 responses: '200': description: Response @@ -100106,9 +102741,9 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 examples: - default: *199 + default: *198 '401': *25 '403': *29 '404': *6 @@ -100133,7 +102768,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *169 + - *168 requestBody: required: true content: @@ -100187,7 +102822,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *169 + - *168 - name: repository_id in: path required: true @@ -100220,7 +102855,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *169 + - *168 - name: repository_id in: path required: true @@ -100252,15 +102887,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *249 + - *248 responses: '200': description: Response content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '304': *37 '500': *55 '401': *25 @@ -100286,7 +102921,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *249 + - *248 requestBody: required: false content: @@ -100316,9 +102951,9 @@ paths: description: Response content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '401': *25 '403': *29 '404': *6 @@ -100340,7 +102975,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *249 + - *248 responses: '202': *39 '304': *37 @@ -100369,13 +103004,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *249 + - *248 responses: '202': description: Response content: application/json: - schema: &680 + schema: &679 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -100416,7 +103051,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &681 + default: &680 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -100448,7 +103083,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *249 + - *248 - name: export_id in: path required: true @@ -100461,9 +103096,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *679 examples: - default: *681 + default: *680 '404': *6 x-github: githubCloudOnly: false @@ -100484,7 +103119,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *249 + - *248 responses: '200': description: Response @@ -100500,9 +103135,9 @@ paths: type: integer machines: type: array - items: *682 + items: *681 examples: - default: *683 + default: *682 '304': *37 '500': *55 '401': *25 @@ -100531,7 +103166,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *249 + - *248 requestBody: required: true content: @@ -100581,13 +103216,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *345 + repository: *344 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *464 - required: *465 + properties: *463 + required: *464 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -101361,15 +103996,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *249 + - *248 responses: '200': description: Response content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '304': *37 '500': *55 '400': *14 @@ -101401,15 +104036,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *249 + - *248 responses: '200': description: Response content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '500': *55 '401': *25 '403': *29 @@ -101439,9 +104074,9 @@ paths: application/json: schema: type: array - items: *260 + items: *259 examples: - default: &694 + default: &693 value: - id: 197 name: hello_docker @@ -101542,7 +104177,7 @@ paths: application/json: schema: type: array - items: &684 + items: &683 title: Email description: Email type: object @@ -101607,9 +104242,9 @@ paths: application/json: schema: type: array - items: *684 + items: *683 examples: - default: &696 + default: &695 value: - email: octocat@github.com verified: true @@ -101684,7 +104319,7 @@ paths: application/json: schema: type: array - items: *684 + items: *683 examples: default: value: @@ -101940,7 +104575,7 @@ paths: application/json: schema: type: array - items: &685 + items: &684 title: GPG Key description: A unique encryption key type: object @@ -102071,7 +104706,7 @@ paths: - subkeys - revoked examples: - default: &712 + default: &711 value: - id: 3 name: Octocat's GPG Key @@ -102156,9 +104791,9 @@ paths: description: Response content: application/json: - schema: *685 + schema: *684 examples: - default: &686 + default: &685 value: id: 3 name: Octocat's GPG Key @@ -102215,7 +104850,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &687 + - &686 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -102227,9 +104862,9 @@ paths: description: Response content: application/json: - schema: *685 + schema: *684 examples: - default: *686 + default: *685 '404': *6 '304': *37 '403': *29 @@ -102252,7 +104887,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *687 + - *686 responses: '204': description: Response @@ -102445,7 +105080,7 @@ paths: allOf: - *79 examples: - default: *153 + default: *152 headers: Link: *67 '404': *6 @@ -102471,7 +105106,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *150 + - *149 responses: '204': description: Response @@ -102497,7 +105132,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *150 + - *149 responses: '204': description: Response @@ -102531,12 +105166,12 @@ paths: application/json: schema: anyOf: - - *234 + - *233 - type: object properties: {} additionalProperties: false examples: - default: *235 + default: *234 '204': description: Response when there are no restrictions x-github: @@ -102560,7 +105195,7 @@ paths: required: true content: application/json: - schema: *539 + schema: *538 examples: default: value: @@ -102571,7 +105206,7 @@ paths: description: Response content: application/json: - schema: *234 + schema: *233 examples: default: value: @@ -102652,7 +105287,7 @@ paths: - closed - all default: open - - *245 + - *244 - name: sort description: What to sort results by. in: query @@ -102677,7 +105312,7 @@ paths: type: array items: *85 examples: - default: *246 + default: *245 headers: Link: *67 '404': *6 @@ -102710,7 +105345,7 @@ paths: application/json: schema: type: array - items: &688 + items: &687 title: Key description: Key type: object @@ -102811,9 +105446,9 @@ paths: description: Response content: application/json: - schema: *688 + schema: *687 examples: - default: &689 + default: &688 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -102846,15 +105481,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *573 + - *572 responses: '200': description: Response content: application/json: - schema: *688 + schema: *687 examples: - default: *689 + default: *688 '404': *6 '304': *37 '403': *29 @@ -102877,7 +105512,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *573 + - *572 responses: '204': description: Response @@ -102910,7 +105545,7 @@ paths: application/json: schema: type: array - items: &690 + items: &689 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -102978,7 +105613,7 @@ paths: - account - plan examples: - default: &691 + default: &690 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -103040,9 +105675,9 @@ paths: application/json: schema: type: array - items: *690 + items: *689 examples: - default: *691 + default: *690 headers: Link: *67 '304': *37 @@ -103082,7 +105717,7 @@ paths: application/json: schema: type: array - items: *251 + items: *250 examples: default: value: @@ -103196,7 +105831,7 @@ paths: description: Response content: application/json: - schema: *251 + schema: *250 examples: default: value: @@ -103283,7 +105918,7 @@ paths: description: Response content: application/json: - schema: *251 + schema: *250 examples: default: value: @@ -103355,7 +105990,7 @@ paths: application/json: schema: type: array - items: *253 + items: *252 examples: default: value: @@ -103608,7 +106243,7 @@ paths: description: Response content: application/json: - schema: *253 + schema: *252 examples: default: value: @@ -103788,7 +106423,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *254 + - *253 - name: exclude in: query required: false @@ -103801,7 +106436,7 @@ paths: description: Response content: application/json: - schema: *253 + schema: *252 examples: default: value: @@ -103995,7 +106630,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *254 + - *253 responses: '302': description: Response @@ -104021,7 +106656,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *254 + - *253 responses: '204': description: Response @@ -104050,8 +106685,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *254 - - *692 + - *253 + - *691 responses: '204': description: Response @@ -104075,7 +106710,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *254 + - *253 - *17 - *19 responses: @@ -104085,9 +106720,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *266 + default: *265 headers: Link: *67 '404': *6 @@ -104166,7 +106801,7 @@ paths: - docker - nuget - container - - *693 + - *692 - *19 - *17 responses: @@ -104176,10 +106811,10 @@ paths: application/json: schema: type: array - items: *260 + items: *259 examples: - default: *694 - '400': *695 + default: *693 + '400': *694 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104199,16 +106834,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: + - *261 - *262 - - *263 responses: '200': description: Response content: application/json: - schema: *260 + schema: *259 examples: - default: &713 + default: &712 value: id: 40201 name: octo-name @@ -104321,8 +106956,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: + - *261 - *262 - - *263 responses: '204': description: Response @@ -104352,8 +106987,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: + - *261 - *262 - - *263 - name: token description: package token schema: @@ -104385,8 +107020,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: + - *261 - *262 - - *263 - *19 - *17 - name: state @@ -104406,7 +107041,7 @@ paths: application/json: schema: type: array - items: *264 + items: *263 examples: default: value: @@ -104455,15 +107090,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: + - *261 - *262 - - *263 - - *265 + - *264 responses: '200': description: Response content: application/json: - schema: *264 + schema: *263 examples: default: value: @@ -104499,9 +107134,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: + - *261 - *262 - - *263 - - *265 + - *264 responses: '204': description: Response @@ -104531,9 +107166,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: + - *261 - *262 - - *263 - - *265 + - *264 responses: '204': description: Response @@ -104570,9 +107205,9 @@ paths: application/json: schema: type: array - items: *684 + items: *683 examples: - default: *696 + default: *695 headers: Link: *67 '304': *37 @@ -104685,7 +107320,7 @@ paths: type: array items: *79 examples: - default: &703 + default: &702 summary: Default response value: - id: 1296269 @@ -104989,9 +107624,9 @@ paths: description: Response content: application/json: - schema: *345 + schema: *344 examples: - default: *347 + default: *346 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -105029,9 +107664,9 @@ paths: application/json: schema: type: array - items: *541 + items: *540 examples: - default: *697 + default: *696 headers: Link: *67 '304': *37 @@ -105054,7 +107689,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *238 + - *237 responses: '204': description: Response @@ -105077,7 +107712,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *238 + - *237 responses: '204': description: Response @@ -105110,7 +107745,7 @@ paths: application/json: schema: type: array - items: &698 + items: &697 title: Social account description: Social media account type: object @@ -105125,7 +107760,7 @@ paths: - provider - url examples: - default: &699 + default: &698 value: - provider: twitter url: https://twitter.com/github @@ -105187,9 +107822,9 @@ paths: application/json: schema: type: array - items: *698 + items: *697 examples: - default: *699 + default: *698 '422': *15 '304': *37 '404': *6 @@ -105276,7 +107911,7 @@ paths: application/json: schema: type: array - items: &700 + items: &699 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -105296,7 +107931,7 @@ paths: - title - created_at examples: - default: &731 + default: &730 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -105360,9 +107995,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *699 examples: - default: &701 + default: &700 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -105392,7 +108027,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: - - &702 + - &701 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -105404,9 +108039,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *699 examples: - default: *701 + default: *700 '404': *6 '304': *37 '403': *29 @@ -105429,7 +108064,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: - - *702 + - *701 responses: '204': description: Response @@ -105458,7 +108093,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &732 + - &731 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 @@ -105483,11 +108118,11 @@ paths: type: array items: *79 examples: - default-response: *703 + default-response: *702 application/vnd.github.v3.star+json: schema: type: array - items: &733 + items: &732 title: Starred Repository description: Starred Repository type: object @@ -105643,8 +108278,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: + - *341 - *342 - - *343 responses: '204': description: Response if this repository is starred by you @@ -105672,8 +108307,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -105697,8 +108332,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -105731,9 +108366,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *266 + default: *265 headers: Link: *67 '304': *37 @@ -105770,7 +108405,7 @@ paths: application/json: schema: type: array - items: *338 + items: *337 examples: default: value: @@ -105856,10 +108491,10 @@ paths: application/json: schema: oneOf: - - *678 - *677 + - *676 examples: - default-response: &707 + default-response: &706 summary: Default response value: login: octocat @@ -105894,7 +108529,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &708 + response-with-git-hub-plan-information: &707 summary: Response with GitHub plan information value: login: octocat @@ -105951,14 +108586,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &705 + - &704 name: user_id description: The unique identifier of the user. in: path required: true schema: type: string - - *278 + - *277 requestBody: required: true description: Details of the draft item to create in the project. @@ -105992,9 +108627,9 @@ paths: description: Response content: application/json: - schema: *284 + schema: *283 examples: - draft_issue: *285 + draft_issue: *284 '304': *37 '403': *29 '401': *25 @@ -106017,7 +108652,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *704 + - *703 - *17 responses: '200': @@ -106052,8 +108687,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *705 - - *278 + - *704 + - *277 requestBody: required: true content: @@ -106124,17 +108759,17 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *706 + schema: *705 examples: table_view: summary: Response for creating a table view - value: *289 + value: *288 board_view: summary: Response for creating a board view with filter - value: *289 + value: *288 roadmap_view: summary: Response for creating a roadmap view - value: *289 + value: *288 '304': *37 '403': *29 '401': *25 @@ -106176,11 +108811,11 @@ paths: application/json: schema: oneOf: - - *678 - *677 + - *676 examples: - default-response: *707 - response-with-git-hub-plan-information: *708 + default-response: *706 + response-with-git-hub-plan-information: *707 '404': *6 x-github: githubCloudOnly: false @@ -106230,8 +108865,8 @@ paths: required: - subject_digests examples: - default: *709 - withPredicateType: *710 + default: *708 + withPredicateType: *709 responses: '200': description: Response @@ -106284,7 +108919,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *711 + default: *710 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106489,12 +109124,12 @@ paths: initiator: type: string examples: - default: *403 + default: *402 '201': description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -106528,9 +109163,9 @@ paths: application/json: schema: type: array - items: *260 + items: *259 examples: - default: *694 + default: *693 '403': *29 '401': *25 x-github: @@ -106914,9 +109549,9 @@ paths: application/json: schema: type: array - items: *685 + items: *684 examples: - default: *712 + default: *711 headers: Link: *67 x-github: @@ -107020,7 +109655,7 @@ paths: application/json: schema: *22 examples: - default: *538 + default: *537 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107144,7 +109779,7 @@ paths: - docker - nuget - container - - *693 + - *692 - *71 - *19 - *17 @@ -107155,12 +109790,12 @@ paths: application/json: schema: type: array - items: *260 + items: *259 examples: - default: *694 + default: *693 '403': *29 '401': *25 - '400': *695 + '400': *694 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107180,17 +109815,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: + - *261 - *262 - - *263 - *71 responses: '200': description: Response content: application/json: - schema: *260 + schema: *259 examples: - default: *713 + default: *712 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107211,8 +109846,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: + - *261 - *262 - - *263 - *71 responses: '204': @@ -107245,8 +109880,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: + - *261 - *262 - - *263 - *71 - name: token description: package token @@ -107279,8 +109914,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: + - *261 - *262 - - *263 - *71 responses: '200': @@ -107289,7 +109924,7 @@ paths: application/json: schema: type: array - items: *264 + items: *263 examples: default: value: @@ -107347,16 +109982,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: + - *261 - *262 - - *263 - - *265 + - *264 - *71 responses: '200': description: Response content: application/json: - schema: *264 + schema: *263 examples: default: value: @@ -107391,10 +110026,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: + - *261 - *262 - - *263 - *71 - - *265 + - *264 responses: '204': description: Response @@ -107426,10 +110061,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: + - *261 - *262 - - *263 - *71 - - *265 + - *264 responses: '204': description: Response @@ -107470,9 +110105,9 @@ paths: application/json: schema: type: array - items: *276 + items: *275 examples: - default: *277 + default: *276 headers: Link: *67 '304': *37 @@ -107494,16 +110129,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *278 + - *277 - *71 responses: '200': description: Response content: application/json: - schema: *276 + schema: *275 examples: - default: *277 + default: *276 headers: Link: *67 '304': *37 @@ -107525,7 +110160,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *278 + - *277 - *71 - *17 - *47 @@ -107537,9 +110172,9 @@ paths: application/json: schema: type: array - items: *282 + items: *281 examples: - default: *714 + default: *713 headers: Link: *67 '304': *37 @@ -107561,7 +110196,7 @@ paths: url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project parameters: - *71 - - *278 + - *277 requestBody: required: true content: @@ -107599,7 +110234,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *715 + items: *714 required: - name - data_type @@ -107615,7 +110250,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *716 + iteration_configuration: *715 required: - name - data_type @@ -107637,20 +110272,20 @@ paths: value: name: Due date data_type: date - single_select_field: *717 - iteration_field: *718 + single_select_field: *716 + iteration_field: *717 responses: '201': description: Response content: application/json: - schema: *282 + schema: *281 examples: - text_field: *719 - number_field: *720 - date_field: *721 - single_select_field: *722 - iteration_field: *723 + text_field: *718 + number_field: *719 + date_field: *720 + single_select_field: *721 + iteration_field: *722 '304': *37 '403': *29 '401': *25 @@ -107671,17 +110306,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *278 - - *724 + - *277 + - *723 - *71 responses: '200': description: Response content: application/json: - schema: *282 + schema: *281 examples: - default: *725 + default: *724 headers: Link: *67 '304': *37 @@ -107704,7 +110339,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *278 + - *277 - *71 - *47 - *48 @@ -107737,9 +110372,9 @@ paths: application/json: schema: type: array - items: *286 + items: *285 examples: - default: *287 + default: *286 headers: Link: *67 '304': *37 @@ -107761,7 +110396,7 @@ paths: url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - *71 - - *278 + - *277 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -107831,22 +110466,22 @@ paths: description: Response content: application/json: - schema: *284 + schema: *283 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *285 + value: *284 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *285 + value: *284 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *285 + value: *284 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *285 + value: *284 '304': *37 '403': *29 '401': *25 @@ -107866,9 +110501,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *278 + - *277 - *71 - - *288 + - *287 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -107888,9 +110523,9 @@ paths: description: Response content: application/json: - schema: *286 + schema: *285 examples: - default: *287 + default: *286 headers: Link: *67 '304': *37 @@ -107911,9 +110546,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *278 + - *277 - *71 - - *288 + - *287 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -107983,13 +110618,13 @@ paths: description: Response content: application/json: - schema: *286 + schema: *285 examples: - text_field: *287 - number_field: *287 - date_field: *287 - single_select_field: *287 - iteration_field: *287 + text_field: *286 + number_field: *286 + date_field: *286 + single_select_field: *286 + iteration_field: *286 '401': *25 '403': *29 '404': *6 @@ -108009,9 +110644,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *278 + - *277 - *71 - - *288 + - *287 responses: '204': description: Response @@ -108033,9 +110668,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-project-view parameters: - - *278 + - *277 - *71 - - *726 + - *725 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -108061,9 +110696,9 @@ paths: application/json: schema: type: array - items: *286 + items: *285 examples: - default: *287 + default: *286 headers: Link: *67 '304': *37 @@ -108282,9 +110917,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *266 + default: *265 headers: Link: *67 x-github: @@ -108310,7 +110945,7 @@ paths: - *123 - *125 - *124 - - *727 + - *726 - *126 responses: '200': @@ -108441,7 +111076,7 @@ paths: parameters: - *71 - *123 - - *728 + - *727 - *124 responses: '200': @@ -108540,9 +111175,9 @@ paths: - *123 - *125 - *124 - - *729 + - *728 - *126 - - *730 + - *729 responses: '200': description: Response when getting a billing usage summary @@ -108676,9 +111311,9 @@ paths: application/json: schema: type: array - items: *698 + items: *697 examples: - default: *699 + default: *698 headers: Link: *67 x-github: @@ -108708,9 +111343,9 @@ paths: application/json: schema: type: array - items: *700 + items: *699 examples: - default: *731 + default: *730 headers: Link: *67 x-github: @@ -108735,7 +111370,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *71 - - *732 + - *731 - *61 - *17 - *19 @@ -108747,11 +111382,11 @@ paths: schema: anyOf: - type: array - items: *733 + items: *732 - type: array items: *79 examples: - default-response: *703 + default-response: *702 headers: Link: *67 x-github: @@ -108780,9 +111415,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *266 + default: *265 headers: Link: *67 x-github: @@ -108910,7 +111545,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &734 + enterprise: &733 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -108968,7 +111603,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &735 + installation: &734 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -108987,7 +111622,7 @@ x-webhooks: required: - id - node_id - organization: &736 + organization: &735 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -109047,13 +111682,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &737 + repository: &736 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &769 + properties: &768 id: description: Unique identifier of the repository example: 42 @@ -109748,7 +112383,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &770 + required: &769 - archive_url - assignees_url - blobs_url @@ -109899,10 +112534,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -109978,11 +112613,11 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - rule: &738 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + rule: &737 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) @@ -110205,11 +112840,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - rule: *738 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + rule: *737 sender: *4 required: - action @@ -110392,11 +113027,11 @@ x-webhooks: - everyone required: - from - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - rule: *738 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + rule: *737 sender: *4 required: - action @@ -110480,7 +113115,7 @@ x-webhooks: type: string enum: - completed - check_run: &740 + check_run: &739 title: CheckRun description: A check performed on the code of a given code change type: object @@ -110534,7 +113169,7 @@ x-webhooks: pull_requests: type: array items: *90 - repository: *161 + repository: *160 status: example: completed type: string @@ -110571,7 +113206,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *739 + deployment: *738 details_url: example: https://example.com type: string @@ -110656,10 +113291,10 @@ x-webhooks: - output - app - pull_requests - installation: *735 - enterprise: *734 - organization: *736 - repository: *737 + installation: *734 + enterprise: *733 + organization: *735 + repository: *736 sender: *4 required: - check_run @@ -111050,11 +113685,11 @@ x-webhooks: type: string enum: - created - check_run: *740 - installation: *735 - enterprise: *734 - organization: *736 - repository: *737 + check_run: *739 + installation: *734 + enterprise: *733 + organization: *735 + repository: *736 sender: *4 required: - check_run @@ -111448,11 +114083,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *740 - installation: *735 - enterprise: *734 - organization: *736 - repository: *737 + check_run: *739 + installation: *734 + enterprise: *733 + organization: *735 + repository: *736 requested_action: description: The action requested by the user. type: object @@ -111855,11 +114490,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *740 - installation: *735 - enterprise: *734 - organization: *736 - repository: *737 + check_run: *739 + installation: *734 + enterprise: *733 + organization: *735 + repository: *736 sender: *4 required: - check_run @@ -112829,10 +115464,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -113521,10 +116156,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -114207,10 +116842,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -114376,7 +117011,7 @@ x-webhooks: required: - login - id - dismissed_comment: *435 + dismissed_comment: *434 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -114521,20 +117156,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &741 + commit_oid: &740 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: *734 - installation: *735 - organization: *736 - ref: &742 + enterprise: *733 + installation: *734 + organization: *735 + ref: &741 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: *737 + repository: *736 sender: *4 required: - action @@ -114699,7 +117334,7 @@ x-webhooks: required: - login - id - dismissed_comment: *435 + dismissed_comment: *434 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -114929,12 +117564,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *741 - enterprise: *734 - installation: *735 - organization: *736 - ref: *742 - repository: *737 + commit_oid: *740 + enterprise: *733 + installation: *734 + organization: *735 + ref: *741 + repository: *736 sender: *4 required: - action @@ -115029,7 +117664,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *435 + dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -115200,12 +117835,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *741 - enterprise: *734 - installation: *735 - organization: *736 - ref: *742 - repository: *737 + commit_oid: *740 + enterprise: *733 + installation: *734 + organization: *735 + ref: *741 + repository: *736 sender: *4 required: - action @@ -115371,7 +118006,7 @@ x-webhooks: required: - login - id - dismissed_comment: *435 + dismissed_comment: *434 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -115537,12 +118172,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *741 - enterprise: *734 - installation: *735 - organization: *736 - ref: *742 - repository: *737 + commit_oid: *740 + enterprise: *733 + installation: *734 + organization: *735 + ref: *741 + repository: *736 sender: *4 required: - action @@ -115641,7 +118276,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *435 + dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -115816,16 +118451,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *737 + repository: *736 sender: *4 required: - action @@ -115922,7 +118557,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *435 + dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -116062,12 +118697,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *741 - enterprise: *734 - installation: *735 - organization: *736 - ref: *742 - repository: *737 + commit_oid: *740 + enterprise: *733 + installation: *734 + organization: *735 + ref: *741 + repository: *736 sender: *4 required: - action @@ -116233,7 +118868,7 @@ x-webhooks: required: - login - id - dismissed_comment: *435 + dismissed_comment: *434 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -116378,10 +119013,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -116636,10 +119271,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -116719,18 +119354,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *736 - pusher_type: &743 + organization: *735 + pusher_type: &742 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &744 + ref: &743 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -116740,7 +119375,7 @@ x-webhooks: enum: - tag - branch - repository: *737 + repository: *736 sender: *4 required: - ref @@ -116822,10 +119457,10 @@ x-webhooks: type: string enum: - created - definition: *290 - enterprise: *734 - installation: *735 - organization: *736 + definition: *289 + enterprise: *733 + installation: *734 + organization: *735 sender: *4 required: - action @@ -116910,9 +119545,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 sender: *4 required: - action @@ -116989,10 +119624,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *290 - enterprise: *734 - installation: *735 - organization: *736 + definition: *289 + enterprise: *733 + installation: *734 + organization: *735 sender: *4 required: - action @@ -117069,10 +119704,10 @@ x-webhooks: type: string enum: - updated - definition: *290 - enterprise: *734 - installation: *735 - organization: *736 + definition: *289 + enterprise: *733 + installation: *734 + organization: *735 sender: *4 required: - action @@ -117149,19 +119784,19 @@ x-webhooks: type: string enum: - updated - enterprise: *734 - installation: *735 - repository: *737 - organization: *736 + enterprise: *733 + installation: *734 + repository: *736 + organization: *735 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *294 + items: *293 old_property_values: type: array description: The old custom property values for the repository. - items: *294 + items: *293 required: - action - repository @@ -117237,18 +119872,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *734 - installation: *735 - organization: *736 - pusher_type: *743 - ref: *744 + enterprise: *733 + installation: *734 + organization: *735 + pusher_type: *742 + ref: *743 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *737 + repository: *736 sender: *4 required: - ref @@ -117328,11 +119963,11 @@ x-webhooks: type: string enum: - assignees_changed - alert: *497 - installation: *735 - organization: *736 - enterprise: *734 - repository: *737 + alert: *496 + installation: *734 + organization: *735 + enterprise: *733 + repository: *736 sender: *4 required: - action @@ -117412,11 +120047,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *497 - installation: *735 - organization: *736 - enterprise: *734 - repository: *737 + alert: *496 + installation: *734 + organization: *735 + enterprise: *733 + repository: *736 sender: *4 required: - action @@ -117497,11 +120132,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *497 - installation: *735 - organization: *736 - enterprise: *734 - repository: *737 + alert: *496 + installation: *734 + organization: *735 + enterprise: *733 + repository: *736 sender: *4 required: - action @@ -117582,11 +120217,11 @@ x-webhooks: type: string enum: - created - alert: *497 - installation: *735 - organization: *736 - enterprise: *734 - repository: *737 + alert: *496 + installation: *734 + organization: *735 + enterprise: *733 + repository: *736 sender: *4 required: - action @@ -117665,11 +120300,11 @@ x-webhooks: type: string enum: - dismissed - alert: *497 - installation: *735 - organization: *736 - enterprise: *734 - repository: *737 + alert: *496 + installation: *734 + organization: *735 + enterprise: *733 + repository: *736 sender: *4 required: - action @@ -117748,11 +120383,11 @@ x-webhooks: type: string enum: - fixed - alert: *497 - installation: *735 - organization: *736 - enterprise: *734 - repository: *737 + alert: *496 + installation: *734 + organization: *735 + enterprise: *733 + repository: *736 sender: *4 required: - action @@ -117832,11 +120467,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *497 - installation: *735 - organization: *736 - enterprise: *734 - repository: *737 + alert: *496 + installation: *734 + organization: *735 + enterprise: *733 + repository: *736 sender: *4 required: - action @@ -117915,11 +120550,11 @@ x-webhooks: type: string enum: - reopened - alert: *497 - installation: *735 - organization: *736 - enterprise: *734 - repository: *737 + alert: *496 + installation: *734 + organization: *735 + enterprise: *733 + repository: *736 sender: *4 required: - action @@ -117996,9 +120631,9 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - key: &745 + enterprise: *733 + installation: *734 + key: &744 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -118034,8 +120669,8 @@ x-webhooks: - verified - created_at - read_only - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -118112,11 +120747,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - key: *745 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + key: *744 + organization: *735 + repository: *736 sender: *4 required: - action @@ -118672,12 +121307,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - workflow: &751 + workflow: &750 title: Workflow type: object nullable: true @@ -119418,15 +122053,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *746 - required: *747 + properties: *745 + required: *746 nullable: true pull_requests: type: array - items: *592 - repository: *737 - organization: *736 - installation: *735 + items: *591 + repository: *736 + organization: *735 + installation: *734 sender: *4 responses: '200': @@ -119497,7 +122132,7 @@ x-webhooks: type: string enum: - approved - approver: &748 + approver: &747 type: object properties: avatar_url: @@ -119540,11 +122175,11 @@ x-webhooks: type: string comment: type: string - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - reviewers: &749 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + reviewers: &748 type: array items: type: object @@ -119623,7 +122258,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &750 + workflow_job_run: &749 type: object properties: conclusion: @@ -120354,18 +122989,18 @@ x-webhooks: type: string enum: - rejected - approver: *748 + approver: *747 comment: type: string - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - reviewers: *749 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + reviewers: *748 sender: *4 since: type: string - workflow_job_run: *750 + workflow_job_run: *749 workflow_job_runs: type: array items: @@ -121069,13 +123704,13 @@ x-webhooks: type: string enum: - requested - enterprise: *734 + enterprise: *733 environment: type: string - installation: *735 - organization: *736 - repository: *737 - requestor: &756 + installation: *734 + organization: *735 + repository: *736 + requestor: &755 title: User type: object nullable: true @@ -122964,12 +125599,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - workflow: *751 + workflow: *750 workflow_run: title: Deployment Workflow Run type: object @@ -123649,7 +126284,7 @@ x-webhooks: type: string enum: - answered - answer: &754 + answer: &753 type: object properties: author_association: @@ -123806,11 +126441,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -123937,11 +126572,11 @@ x-webhooks: - from required: - category - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124024,11 +126659,11 @@ x-webhooks: type: string enum: - closed - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124110,7 +126745,7 @@ x-webhooks: type: string enum: - created - comment: &753 + comment: &752 type: object properties: author_association: @@ -124267,11 +126902,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124354,12 +126989,12 @@ x-webhooks: type: string enum: - deleted - comment: *753 - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + comment: *752 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124454,12 +127089,12 @@ x-webhooks: - from required: - body - comment: *753 - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + comment: *752 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124543,11 +127178,11 @@ x-webhooks: type: string enum: - created - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124629,11 +127264,11 @@ x-webhooks: type: string enum: - deleted - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124733,11 +127368,11 @@ x-webhooks: type: string required: - from - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124819,10 +127454,10 @@ x-webhooks: type: string enum: - labeled - discussion: *752 - enterprise: *734 - installation: *735 - label: &755 + discussion: *751 + enterprise: *733 + installation: *734 + label: &754 title: Label type: object properties: @@ -124854,8 +127489,8 @@ x-webhooks: - color - default - description - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124938,11 +127573,11 @@ x-webhooks: type: string enum: - locked - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -125024,11 +127659,11 @@ x-webhooks: type: string enum: - pinned - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -125110,11 +127745,11 @@ x-webhooks: type: string enum: - reopened - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -125199,16 +127834,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *752 - new_repository: *737 + new_discussion: *751 + new_repository: *736 required: - new_discussion - new_repository - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -125291,10 +127926,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *752 - old_answer: *754 - organization: *736 - repository: *737 + discussion: *751 + old_answer: *753 + organization: *735 + repository: *736 sender: *4 required: - action @@ -125376,12 +128011,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *752 - enterprise: *734 - installation: *735 - label: *755 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + label: *754 + organization: *735 + repository: *736 sender: *4 required: - action @@ -125464,11 +128099,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -125550,11 +128185,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -125627,7 +128262,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *734 + enterprise: *733 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -126287,9 +128922,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - forkee @@ -126435,9 +129070,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 pages: description: The pages that were updated. type: array @@ -126474,7 +129109,7 @@ x-webhooks: - action - sha - html_url - repository: *737 + repository: *736 sender: *4 required: - pages @@ -126550,10 +129185,10 @@ x-webhooks: type: string enum: - created - enterprise: *734 + enterprise: *733 installation: *22 - organization: *736 - repositories: &757 + organization: *735 + repositories: &756 description: An array of repository objects that the installation can access. type: array @@ -126579,8 +129214,8 @@ x-webhooks: - name - full_name - private - repository: *737 - requester: *756 + repository: *736 + requester: *755 sender: *4 required: - action @@ -126655,11 +129290,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 + enterprise: *733 installation: *22 - organization: *736 - repositories: *757 - repository: *737 + organization: *735 + repositories: *756 + repository: *736 requester: nullable: true sender: *4 @@ -126735,11 +129370,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *734 + enterprise: *733 installation: *22 - organization: *736 - repositories: *757 - repository: *737 + organization: *735 + repositories: *756 + repository: *736 requester: nullable: true sender: *4 @@ -126815,10 +129450,10 @@ x-webhooks: type: string enum: - added - enterprise: *734 + enterprise: *733 installation: *22 - organization: *736 - repositories_added: &758 + organization: *735 + repositories_added: &757 description: An array of repository objects, which were added to the installation. type: array @@ -126864,15 +129499,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *737 - repository_selection: &759 + repository: *736 + repository_selection: &758 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *756 + requester: *755 sender: *4 required: - action @@ -126951,10 +129586,10 @@ x-webhooks: type: string enum: - removed - enterprise: *734 + enterprise: *733 installation: *22 - organization: *736 - repositories_added: *758 + organization: *735 + repositories_added: *757 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -126981,9 +129616,9 @@ x-webhooks: - name - full_name - private - repository: *737 - repository_selection: *759 - requester: *756 + repository: *736 + repository_selection: *758 + requester: *755 sender: *4 required: - action @@ -127062,11 +129697,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *734 + enterprise: *733 installation: *22 - organization: *736 - repositories: *757 - repository: *737 + organization: *735 + repositories: *756 + repository: *736 requester: nullable: true sender: *4 @@ -127244,10 +129879,10 @@ x-webhooks: type: string required: - from - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 target_type: type: string @@ -127326,11 +129961,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *734 + enterprise: *733 installation: *22 - organization: *736 - repositories: *757 - repository: *737 + organization: *735 + repositories: *756 + repository: *736 requester: nullable: true sender: *4 @@ -127504,8 +130139,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *569 - required: *570 + properties: *568 + required: *569 nullable: true user: title: User @@ -127590,8 +130225,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128380,8 +131015,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128397,7 +131032,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -128730,8 +131365,8 @@ x-webhooks: - state - locked - assignee - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -128811,7 +131446,7 @@ x-webhooks: type: string enum: - deleted - comment: &760 + comment: &759 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -128968,8 +131603,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *569 - required: *570 + properties: *568 + required: *569 nullable: true required: - url @@ -128984,8 +131619,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -129770,8 +132405,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 state: description: State of the issue; either 'open' or 'closed' type: string @@ -129787,7 +132422,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -130122,8 +132757,8 @@ x-webhooks: - state - locked - assignee - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -130203,7 +132838,7 @@ x-webhooks: type: string enum: - edited - changes: &789 + changes: &788 description: The changes to the comment. type: object properties: @@ -130215,9 +132850,9 @@ x-webhooks: type: string required: - from - comment: *760 - enterprise: *734 - installation: *735 + comment: *759 + enterprise: *733 + installation: *734 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -131005,8 +133640,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131022,7 +133657,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -131355,8 +133990,8 @@ x-webhooks: - state - locked - assignee - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -131437,9 +134072,9 @@ x-webhooks: type: string enum: - pinned - comment: *760 - enterprise: *734 - installation: *735 + comment: *759 + enterprise: *733 + installation: *734 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -132229,8 +134864,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132246,7 +134881,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -132581,8 +135216,8 @@ x-webhooks: - state - locked - assignee - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -132662,9 +135297,9 @@ x-webhooks: type: string enum: - unpinned - comment: *760 - enterprise: *734 - installation: *735 + comment: *759 + enterprise: *733 + installation: *734 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -133454,8 +136089,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133471,7 +136106,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -133806,8 +136441,8 @@ x-webhooks: - state - locked - assignee - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -133896,9 +136531,9 @@ x-webhooks: type: number blocking_issue: *85 blocking_issue_repo: *79 - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -133987,9 +136622,9 @@ x-webhooks: type: number blocking_issue: *85 blocking_issue_repo: *79 - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -134077,9 +136712,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *85 - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -134168,9 +136803,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *85 - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -134250,10 +136885,10 @@ x-webhooks: type: string enum: - assigned - assignee: *756 - enterprise: *734 - installation: *735 - issue: &763 + assignee: *755 + enterprise: *733 + installation: *734 + issue: &762 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -135045,11 +137680,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135065,7 +137700,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -135166,8 +137801,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -135247,8 +137882,8 @@ x-webhooks: type: string enum: - closed - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -136045,11 +138680,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136065,7 +138700,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -136301,8 +138936,8 @@ x-webhooks: required: - state - closed_at - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -136381,8 +139016,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137170,11 +139805,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137190,7 +139825,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -137290,8 +139925,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -137370,8 +140005,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -138181,11 +140816,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138201,7 +140836,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -138280,7 +140915,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &761 + milestone: &760 title: Milestone description: A collection of related issues and pull requests. type: object @@ -138418,8 +141053,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -138518,8 +141153,8 @@ x-webhooks: type: string required: - from - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139311,11 +141946,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139328,7 +141963,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *242 + type: *241 title: description: Title of the issue type: string @@ -139432,9 +142067,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *755 - organization: *736 - repository: *737 + label: *754 + organization: *735 + repository: *736 sender: *4 required: - action @@ -139514,8 +142149,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -140306,11 +142941,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140323,7 +142958,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *242 + type: *241 title: description: Title of the issue type: string @@ -140427,9 +143062,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *755 - organization: *736 - repository: *737 + label: *754 + organization: *735 + repository: *736 sender: *4 required: - action @@ -140509,8 +143144,8 @@ x-webhooks: type: string enum: - locked - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141325,11 +143960,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141342,7 +143977,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *242 + type: *241 title: description: Title of the issue type: string @@ -141423,8 +144058,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -141503,8 +144138,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142313,11 +144948,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142333,7 +144968,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -142411,9 +145046,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *761 - organization: *736 - repository: *737 + milestone: *760 + organization: *735 + repository: *736 sender: *4 required: - action @@ -143276,11 +145911,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143381,7 +146016,7 @@ x-webhooks: required: - login - id - type: *242 + type: *241 required: - id - number @@ -143861,8 +146496,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144646,11 +147281,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144666,7 +147301,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -144774,8 +147409,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -144855,9 +147490,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *734 - installation: *735 - issue: &762 + enterprise: *733 + installation: *734 + issue: &761 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -145643,11 +148278,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145663,7 +148298,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -145763,8 +148398,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -145843,8 +148478,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -146657,11 +149292,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146755,9 +149390,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *242 - organization: *736 - repository: *737 + type: *241 + organization: *735 + repository: *736 sender: *4 required: - action @@ -147626,11 +150261,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147646,7 +150281,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -148225,11 +150860,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *734 - installation: *735 - issue: *762 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + issue: *761 + organization: *735 + repository: *736 sender: *4 required: - action @@ -148309,12 +150944,12 @@ x-webhooks: type: string enum: - typed - enterprise: *734 - installation: *735 - issue: *763 - type: *242 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + issue: *762 + type: *241 + organization: *735 + repository: *736 sender: *4 required: - action @@ -148395,7 +151030,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &792 + assignee: &791 title: User type: object nullable: true @@ -148465,11 +151100,11 @@ x-webhooks: required: - login - id - enterprise: *734 - installation: *735 - issue: *763 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + issue: *762 + organization: *735 + repository: *736 sender: *4 required: - action @@ -148548,12 +151183,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *734 - installation: *735 - issue: *763 - label: *755 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + issue: *762 + label: *754 + organization: *735 + repository: *736 sender: *4 required: - action @@ -148633,8 +151268,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -149447,11 +152082,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149467,7 +152102,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -149545,8 +152180,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -149626,11 +152261,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *734 - installation: *735 - issue: *762 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + issue: *761 + organization: *735 + repository: *736 sender: *4 required: - action @@ -149709,12 +152344,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *734 - installation: *735 - issue: *763 - type: *242 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + issue: *762 + type: *241 + organization: *735 + repository: *736 sender: *4 required: - action @@ -149794,11 +152429,11 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - label: *755 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + label: *754 + organization: *735 + repository: *736 sender: *4 required: - action @@ -149876,11 +152511,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - label: *755 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + label: *754 + organization: *735 + repository: *736 sender: *4 required: - action @@ -149990,11 +152625,11 @@ x-webhooks: type: string required: - from - enterprise: *734 - installation: *735 - label: *755 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + label: *754 + organization: *735 + repository: *736 sender: *4 required: - action @@ -150076,9 +152711,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *734 - installation: *735 - marketplace_purchase: &764 + enterprise: *733 + installation: *734 + marketplace_purchase: &763 title: Marketplace Purchase type: object required: @@ -150161,8 +152796,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *736 - previous_marketplace_purchase: &765 + organization: *735 + previous_marketplace_purchase: &764 title: Marketplace Purchase type: object properties: @@ -150242,7 +152877,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *737 + repository: *736 sender: *4 required: - action @@ -150322,10 +152957,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *734 - installation: *735 - marketplace_purchase: *764 - organization: *736 + enterprise: *733 + installation: *734 + marketplace_purchase: *763 + organization: *735 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -150408,7 +153043,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *737 + repository: *736 sender: *4 required: - action @@ -150490,10 +153125,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *734 - installation: *735 - marketplace_purchase: *764 - organization: *736 + enterprise: *733 + installation: *734 + marketplace_purchase: *763 + organization: *735 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -150575,7 +153210,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *737 + repository: *736 sender: *4 required: - action @@ -150656,8 +153291,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 marketplace_purchase: title: Marketplace Purchase type: object @@ -150739,9 +153374,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *736 - previous_marketplace_purchase: *765 - repository: *737 + organization: *735 + previous_marketplace_purchase: *764 + repository: *736 sender: *4 required: - action @@ -150821,12 +153456,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *734 - installation: *735 - marketplace_purchase: *764 - organization: *736 - previous_marketplace_purchase: *765 - repository: *737 + enterprise: *733 + installation: *734 + marketplace_purchase: *763 + organization: *735 + previous_marketplace_purchase: *764 + repository: *736 sender: *4 required: - action @@ -150928,11 +153563,11 @@ x-webhooks: type: string required: - to - enterprise: *734 - installation: *735 - member: *756 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + member: *755 + organization: *735 + repository: *736 sender: *4 required: - action @@ -151032,11 +153667,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *734 - installation: *735 - member: *756 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + member: *755 + organization: *735 + repository: *736 sender: *4 required: - action @@ -151115,11 +153750,11 @@ x-webhooks: type: string enum: - removed - enterprise: *734 - installation: *735 - member: *756 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + member: *755 + organization: *735 + repository: *736 sender: *4 required: - action @@ -151197,11 +153832,11 @@ x-webhooks: type: string enum: - added - enterprise: *734 - installation: *735 - member: *756 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + member: *755 + organization: *735 + repository: *736 scope: description: The scope of the membership. Currently, can only be `team`. @@ -151277,7 +153912,7 @@ x-webhooks: required: - login - id - team: &766 + team: &765 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -151500,11 +154135,11 @@ x-webhooks: type: string enum: - removed - enterprise: *734 - installation: *735 - member: *756 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + member: *755 + organization: *735 + repository: *736 scope: description: The scope of the membership. Currently, can only be `team`. @@ -151581,7 +154216,7 @@ x-webhooks: required: - login - id - team: *766 + team: *765 required: - action - scope @@ -151663,8 +154298,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *735 - merge_group: &768 + installation: *734 + merge_group: &767 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -151683,15 +154318,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *767 + head_commit: *766 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -151777,10 +154412,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *735 - merge_group: *768 - organization: *736 - repository: *737 + installation: *734 + merge_group: *767 + organization: *735 + repository: *736 sender: *4 required: - action @@ -151853,7 +154488,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 + enterprise: *733 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -151962,16 +154597,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *735 - organization: *736 + installation: *734 + organization: *735 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *769 - required: *770 + properties: *768 + required: *769 nullable: true sender: *4 required: @@ -152052,11 +154687,11 @@ x-webhooks: type: string enum: - closed - enterprise: *734 - installation: *735 - milestone: *761 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + milestone: *760 + organization: *735 + repository: *736 sender: *4 required: - action @@ -152135,9 +154770,9 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - milestone: &771 + enterprise: *733 + installation: *734 + milestone: &770 title: Milestone description: A collection of related issues and pull requests. type: object @@ -152274,8 +154909,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -152354,11 +154989,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - milestone: *761 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + milestone: *760 + organization: *735 + repository: *736 sender: *4 required: - action @@ -152468,11 +155103,11 @@ x-webhooks: type: string required: - from - enterprise: *734 - installation: *735 - milestone: *761 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + milestone: *760 + organization: *735 + repository: *736 sender: *4 required: - action @@ -152552,11 +155187,11 @@ x-webhooks: type: string enum: - opened - enterprise: *734 - installation: *735 - milestone: *771 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + milestone: *770 + organization: *735 + repository: *736 sender: *4 required: - action @@ -152635,11 +155270,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *756 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + blocked_user: *755 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -152718,11 +155353,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *756 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + blocked_user: *755 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -152801,9 +155436,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - membership: &772 + enterprise: *733 + installation: *734 + membership: &771 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -152910,8 +155545,8 @@ x-webhooks: - role - organization_url - user - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -152989,11 +155624,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *734 - installation: *735 - membership: *772 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + membership: *771 + organization: *735 + repository: *736 sender: *4 required: - action @@ -153072,8 +155707,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -153189,10 +155824,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 - user: *756 + user: *755 required: - action - invitation @@ -153270,11 +155905,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *734 - installation: *735 - membership: *772 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + membership: *771 + organization: *735 + repository: *736 sender: *4 required: - action @@ -153361,11 +155996,11 @@ x-webhooks: properties: from: type: string - enterprise: *734 - installation: *735 - membership: *772 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + membership: *771 + organization: *735 + repository: *736 sender: *4 required: - action @@ -153442,9 +156077,9 @@ x-webhooks: type: string enum: - published - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 package: description: Information about the package. type: object @@ -153943,7 +156578,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &773 + items: &772 title: Ruby Gems metadata type: object properties: @@ -154038,7 +156673,7 @@ x-webhooks: - owner - package_version - registry - repository: *737 + repository: *736 sender: *4 required: - action @@ -154114,9 +156749,9 @@ x-webhooks: type: string enum: - updated - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 package: description: Information about the package. type: object @@ -154469,7 +157104,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *773 + items: *772 source_url: type: string format: uri @@ -154539,7 +157174,7 @@ x-webhooks: - owner - package_version - registry - repository: *737 + repository: *736 sender: *4 required: - action @@ -154715,12 +157350,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *734 + enterprise: *733 id: type: integer - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - id @@ -154797,7 +157432,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &774 + personal_access_token_request: &773 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -154943,10 +157578,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *734 - organization: *736 + enterprise: *733 + organization: *735 sender: *4 - installation: *735 + installation: *734 required: - action - personal_access_token_request @@ -155023,11 +157658,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *774 - enterprise: *734 - organization: *736 + personal_access_token_request: *773 + enterprise: *733 + organization: *735 sender: *4 - installation: *735 + installation: *734 required: - action - personal_access_token_request @@ -155103,11 +157738,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *774 - enterprise: *734 - organization: *736 + personal_access_token_request: *773 + enterprise: *733 + organization: *735 sender: *4 - installation: *735 + installation: *734 required: - action - personal_access_token_request @@ -155182,11 +157817,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *774 - organization: *736 - enterprise: *734 + personal_access_token_request: *773 + organization: *735 + enterprise: *733 sender: *4 - installation: *735 + installation: *734 required: - action - personal_access_token_request @@ -155291,7 +157926,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *775 + last_response: *774 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -155323,8 +157958,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 zen: description: Random string of GitHub zen. @@ -155569,10 +158204,10 @@ x-webhooks: - from required: - note - enterprise: *734 - installation: *735 - organization: *736 - project_card: &776 + enterprise: *733 + installation: *734 + organization: *735 + project_card: &775 title: Project Card type: object properties: @@ -155691,7 +158326,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *737 + repository: *736 sender: *4 required: - action @@ -155772,11 +158407,11 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 - project_card: *776 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + project_card: *775 + repository: *736 sender: *4 required: - action @@ -155856,9 +158491,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 project_card: title: Project Card type: object @@ -155986,8 +158621,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *769 - required: *770 + properties: *768 + required: *769 nullable: true sender: *4 required: @@ -156081,11 +158716,11 @@ x-webhooks: - from required: - note - enterprise: *734 - installation: *735 - organization: *736 - project_card: *776 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + project_card: *775 + repository: *736 sender: *4 required: - action @@ -156179,9 +158814,9 @@ x-webhooks: - from required: - column_id - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 project_card: allOf: - title: Project Card @@ -156371,7 +159006,7 @@ x-webhooks: type: string required: - after_id - repository: *737 + repository: *736 sender: *4 required: - action @@ -156451,10 +159086,10 @@ x-webhooks: type: string enum: - closed - enterprise: *734 - installation: *735 - organization: *736 - project: &778 + enterprise: *733 + installation: *734 + organization: *735 + project: &777 title: Project type: object properties: @@ -156578,7 +159213,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *737 + repository: *736 sender: *4 required: - action @@ -156658,10 +159293,10 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 - project_column: &777 + enterprise: *733 + installation: *734 + organization: *735 + project_column: &776 title: Project Column type: object properties: @@ -156700,7 +159335,7 @@ x-webhooks: - name - created_at - updated_at - repository: *737 + repository: *736 sender: *4 required: - action @@ -156779,18 +159414,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - organization: *736 - project_column: *777 + enterprise: *733 + installation: *734 + organization: *735 + project_column: *776 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *769 - required: *770 + properties: *768 + required: *769 nullable: true sender: *4 required: @@ -156880,11 +159515,11 @@ x-webhooks: type: string required: - from - enterprise: *734 - installation: *735 - organization: *736 - project_column: *777 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + project_column: *776 + repository: *736 sender: *4 required: - action @@ -156964,11 +159599,11 @@ x-webhooks: type: string enum: - moved - enterprise: *734 - installation: *735 - organization: *736 - project_column: *777 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + project_column: *776 + repository: *736 sender: *4 required: - action @@ -157048,11 +159683,11 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 - project: *778 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + project: *777 + repository: *736 sender: *4 required: - action @@ -157132,18 +159767,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - organization: *736 - project: *778 + enterprise: *733 + installation: *734 + organization: *735 + project: *777 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *769 - required: *770 + properties: *768 + required: *769 nullable: true sender: *4 required: @@ -157245,11 +159880,11 @@ x-webhooks: type: string required: - from - enterprise: *734 - installation: *735 - organization: *736 - project: *778 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + project: *777 + repository: *736 sender: *4 required: - action @@ -157328,11 +159963,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *734 - installation: *735 - organization: *736 - project: *778 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + project: *777 + repository: *736 sender: *4 required: - action @@ -157413,9 +160048,9 @@ x-webhooks: type: string enum: - closed - installation: *735 - organization: *736 - projects_v2: *276 + installation: *734 + organization: *735 + projects_v2: *275 sender: *4 required: - action @@ -157496,9 +160131,9 @@ x-webhooks: type: string enum: - created - installation: *735 - organization: *736 - projects_v2: *276 + installation: *734 + organization: *735 + projects_v2: *275 sender: *4 required: - action @@ -157579,9 +160214,9 @@ x-webhooks: type: string enum: - deleted - installation: *735 - organization: *736 - projects_v2: *276 + installation: *734 + organization: *735 + projects_v2: *275 sender: *4 required: - action @@ -157698,9 +160333,9 @@ x-webhooks: type: string to: type: string - installation: *735 - organization: *736 - projects_v2: *276 + installation: *734 + organization: *735 + projects_v2: *275 sender: *4 required: - action @@ -157783,7 +160418,7 @@ x-webhooks: type: string enum: - archived - changes: &782 + changes: &781 type: object properties: archived_at: @@ -157797,9 +160432,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *735 - organization: *736 - projects_v2_item: &779 + installation: *734 + organization: *735 + projects_v2_item: &778 title: Projects v2 Item description: An item belonging to a project type: object @@ -157817,7 +160452,7 @@ x-webhooks: type: string description: The node ID of the content represented by this item. - content_type: *283 + content_type: *282 creator: *4 created_at: type: string @@ -157934,9 +160569,9 @@ x-webhooks: nullable: true to: type: string - installation: *735 - organization: *736 - projects_v2_item: *779 + installation: *734 + organization: *735 + projects_v2_item: *778 sender: *4 required: - action @@ -158018,9 +160653,9 @@ x-webhooks: type: string enum: - created - installation: *735 - organization: *736 - projects_v2_item: *779 + installation: *734 + organization: *735 + projects_v2_item: *778 sender: *4 required: - action @@ -158101,9 +160736,9 @@ x-webhooks: type: string enum: - deleted - installation: *735 - organization: *736 - projects_v2_item: *779 + installation: *734 + organization: *735 + projects_v2_item: *778 sender: *4 required: - action @@ -158209,7 +160844,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &780 + - &779 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -158231,7 +160866,7 @@ x-webhooks: required: - id - name - - &781 + - &780 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -158265,8 +160900,8 @@ x-webhooks: oneOf: - type: string - type: integer + - *779 - *780 - - *781 required: - field_value - type: object @@ -158282,9 +160917,9 @@ x-webhooks: nullable: true required: - body - installation: *735 - organization: *736 - projects_v2_item: *779 + installation: *734 + organization: *735 + projects_v2_item: *778 sender: *4 required: - action @@ -158379,9 +161014,9 @@ x-webhooks: to: type: string nullable: true - installation: *735 - organization: *736 - projects_v2_item: *779 + installation: *734 + organization: *735 + projects_v2_item: *778 sender: *4 required: - action @@ -158464,10 +161099,10 @@ x-webhooks: type: string enum: - restored - changes: *782 - installation: *735 - organization: *736 - projects_v2_item: *779 + changes: *781 + installation: *734 + organization: *735 + projects_v2_item: *778 sender: *4 required: - action @@ -158549,9 +161184,9 @@ x-webhooks: type: string enum: - reopened - installation: *735 - organization: *736 - projects_v2: *276 + installation: *734 + organization: *735 + projects_v2: *275 sender: *4 required: - action @@ -158632,14 +161267,14 @@ x-webhooks: type: string enum: - created - installation: *735 - organization: *736 - projects_v2_status_update: &785 + installation: *734 + organization: *735 + projects_v2_status_update: &784 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *783 - required: *784 + properties: *782 + required: *783 sender: *4 required: - action @@ -158720,9 +161355,9 @@ x-webhooks: type: string enum: - deleted - installation: *735 - organization: *736 - projects_v2_status_update: *785 + installation: *734 + organization: *735 + projects_v2_status_update: *784 sender: *4 required: - action @@ -158858,9 +161493,9 @@ x-webhooks: type: string format: date nullable: true - installation: *735 - organization: *736 - projects_v2_status_update: *785 + installation: *734 + organization: *735 + projects_v2_status_update: *784 sender: *4 required: - action @@ -158931,10 +161566,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - repository @@ -159011,13 +161646,13 @@ x-webhooks: type: string enum: - assigned - assignee: *756 - enterprise: *734 - installation: *735 - number: &786 + assignee: *755 + enterprise: *733 + installation: *734 + number: &785 description: The pull request number. type: integer - organization: *736 + organization: *735 pull_request: title: Pull Request type: object @@ -161322,7 +163957,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 sender: *4 required: - action @@ -161404,11 +164039,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 number: type: integer - organization: *736 + organization: *735 pull_request: title: Pull Request type: object @@ -163708,7 +166343,7 @@ x-webhooks: - draft reason: type: string - repository: *737 + repository: *736 sender: *4 required: - action @@ -163790,11 +166425,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 number: type: integer - organization: *736 + organization: *735 pull_request: title: Pull Request type: object @@ -166094,7 +168729,7 @@ x-webhooks: - draft reason: type: string - repository: *737 + repository: *736 sender: *4 required: - action @@ -166176,13 +168811,13 @@ x-webhooks: type: string enum: - closed - enterprise: *734 - installation: *735 - number: *786 - organization: *736 - pull_request: &787 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 + pull_request: &786 allOf: - - *592 + - *591 - type: object properties: allow_auto_merge: @@ -166244,7 +168879,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *737 + repository: *736 sender: *4 required: - action @@ -166325,12 +168960,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *734 - installation: *735 - number: *786 - organization: *736 - pull_request: *787 - repository: *737 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 + pull_request: *786 + repository: *736 sender: *4 required: - action @@ -166410,11 +169045,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *734 - milestone: *576 - number: *786 - organization: *736 - pull_request: &788 + enterprise: *733 + milestone: *575 + number: *785 + organization: *735 + pull_request: &787 title: Pull Request type: object properties: @@ -168699,7 +171334,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 sender: *4 required: - action @@ -168778,11 +171413,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 number: type: integer - organization: *736 + organization: *735 pull_request: title: Pull Request type: object @@ -171086,7 +173721,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *737 + repository: *736 sender: *4 required: - action @@ -171210,12 +173845,12 @@ x-webhooks: type: string required: - from - enterprise: *734 - installation: *735 - number: *786 - organization: *736 - pull_request: *787 - repository: *737 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 + pull_request: *786 + repository: *736 sender: *4 required: - action @@ -171295,11 +173930,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 number: type: integer - organization: *736 + organization: *735 pull_request: title: Pull Request type: object @@ -173588,7 +176223,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 sender: *4 required: - action @@ -173668,11 +176303,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *734 - installation: *735 - label: *755 - number: *786 - organization: *736 + enterprise: *733 + installation: *734 + label: *754 + number: *785 + organization: *735 pull_request: title: Pull Request type: object @@ -175976,7 +178611,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 sender: *4 required: - action @@ -176057,10 +178692,10 @@ x-webhooks: type: string enum: - locked - enterprise: *734 - installation: *735 - number: *786 - organization: *736 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 pull_request: title: Pull Request type: object @@ -178362,7 +180997,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 sender: *4 required: - action @@ -178442,12 +181077,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *734 - milestone: *576 - number: *786 - organization: *736 - pull_request: *788 - repository: *737 + enterprise: *733 + milestone: *575 + number: *785 + organization: *735 + pull_request: *787 + repository: *736 sender: *4 required: - action @@ -178526,12 +181161,12 @@ x-webhooks: type: string enum: - opened - enterprise: *734 - installation: *735 - number: *786 - organization: *736 - pull_request: *787 - repository: *737 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 + pull_request: *786 + repository: *736 sender: *4 required: - action @@ -178612,12 +181247,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *734 - installation: *735 - number: *786 - organization: *736 - pull_request: *787 - repository: *737 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 + pull_request: *786 + repository: *736 sender: *4 required: - action @@ -178697,12 +181332,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *734 - installation: *735 - number: *786 - organization: *736 - pull_request: *787 - repository: *737 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 + pull_request: *786 + repository: *736 sender: *4 required: - action @@ -179068,9 +181703,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 pull_request: type: object properties: @@ -181262,7 +183897,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *737 + repository: *736 sender: *4 required: - action @@ -181342,7 +183977,7 @@ x-webhooks: type: string enum: - deleted - comment: &790 + comment: &789 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -181627,9 +184262,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 pull_request: type: object properties: @@ -183809,7 +186444,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *737 + repository: *736 sender: *4 required: - action @@ -183889,11 +186524,11 @@ x-webhooks: type: string enum: - edited - changes: *789 - comment: *790 - enterprise: *734 - installation: *735 - organization: *736 + changes: *788 + comment: *789 + enterprise: *733 + installation: *734 + organization: *735 pull_request: type: object properties: @@ -186076,7 +188711,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *737 + repository: *736 sender: *4 required: - action @@ -186157,9 +188792,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 pull_request: title: Simple Pull Request type: object @@ -188354,7 +190989,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *737 + repository: *736 review: description: The review that was affected. type: object @@ -188601,9 +191236,9 @@ x-webhooks: type: string required: - from - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 pull_request: title: Simple Pull Request type: object @@ -190657,8 +193292,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *737 - review: &791 + repository: *736 + review: &790 description: The review that was affected. type: object properties: @@ -190891,12 +193526,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 number: description: The pull request number. type: integer - organization: *736 + organization: *735 pull_request: title: Pull Request type: object @@ -193201,7 +195836,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 requested_reviewer: title: User type: object @@ -193285,12 +195920,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 number: description: The pull request number. type: integer - organization: *736 + organization: *735 pull_request: title: Pull Request type: object @@ -195602,7 +198237,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 requested_team: title: Team description: Groups of organization members that gives permissions @@ -195794,12 +198429,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 number: description: The pull request number. type: integer - organization: *736 + organization: *735 pull_request: title: Pull Request type: object @@ -198106,7 +200741,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 requested_reviewer: title: User type: object @@ -198191,12 +200826,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 number: description: The pull request number. type: integer - organization: *736 + organization: *735 pull_request: title: Pull Request type: object @@ -200494,7 +203129,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 requested_team: title: Team description: Groups of organization members that gives permissions @@ -200675,9 +203310,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 pull_request: title: Simple Pull Request type: object @@ -202874,8 +205509,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *737 - review: *791 + repository: *736 + review: *790 sender: *4 required: - action @@ -202955,9 +205590,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 pull_request: title: Simple Pull Request type: object @@ -205049,7 +207684,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *737 + repository: *736 sender: *4 thread: type: object @@ -205436,9 +208071,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 pull_request: title: Simple Pull Request type: object @@ -207516,7 +210151,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *737 + repository: *736 sender: *4 thread: type: object @@ -207906,10 +210541,10 @@ x-webhooks: type: string before: type: string - enterprise: *734 - installation: *735 - number: *786 - organization: *736 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 pull_request: title: Pull Request type: object @@ -210202,7 +212837,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 sender: *4 required: - action @@ -210284,11 +212919,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *792 - enterprise: *734 - installation: *735 - number: *786 - organization: *736 + assignee: *791 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 pull_request: title: Pull Request type: object @@ -212593,7 +215228,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 sender: *4 required: - action @@ -212672,11 +215307,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *734 - installation: *735 - label: *755 - number: *786 - organization: *736 + enterprise: *733 + installation: *734 + label: *754 + number: *785 + organization: *735 pull_request: title: Pull Request type: object @@ -214971,7 +217606,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 sender: *4 required: - action @@ -215052,10 +217687,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *734 - installation: *735 - number: *786 - organization: *736 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 pull_request: title: Pull Request type: object @@ -217342,7 +219977,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 sender: *4 required: - action @@ -217542,7 +220177,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *734 + enterprise: *733 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -217634,8 +220269,8 @@ x-webhooks: - url - author - committer - installation: *735 - organization: *736 + installation: *734 + organization: *735 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -218221,9 +220856,9 @@ x-webhooks: type: string enum: - published - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 registry_package: type: object properties: @@ -218669,7 +221304,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *773 + items: *772 summary: type: string tag_name: @@ -218723,7 +221358,7 @@ x-webhooks: - owner - package_version - registry - repository: *737 + repository: *736 sender: *4 required: - action @@ -218801,9 +221436,9 @@ x-webhooks: type: string enum: - updated - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 registry_package: type: object properties: @@ -219111,7 +221746,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *773 + items: *772 summary: type: string tag_name: @@ -219160,7 +221795,7 @@ x-webhooks: - owner - package_version - registry - repository: *737 + repository: *736 sender: *4 required: - action @@ -219237,10 +221872,10 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 - release: &793 + enterprise: *733 + installation: *734 + organization: *735 + release: &792 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -219558,7 +222193,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *737 + repository: *736 sender: *4 required: - action @@ -219635,11 +222270,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - organization: *736 - release: *793 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + release: *792 + repository: *736 sender: *4 required: - action @@ -219756,11 +222391,11 @@ x-webhooks: type: boolean required: - to - enterprise: *734 - installation: *735 - organization: *736 - release: *793 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + release: *792 + repository: *736 sender: *4 required: - action @@ -219838,9 +222473,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -220162,7 +222797,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *737 + repository: *736 sender: *4 required: - action @@ -220238,10 +222873,10 @@ x-webhooks: type: string enum: - published - enterprise: *734 - installation: *735 - organization: *736 - release: &794 + enterprise: *733 + installation: *734 + organization: *735 + release: &793 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -220560,7 +223195,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *737 + repository: *736 sender: *4 required: - action @@ -220636,11 +223271,11 @@ x-webhooks: type: string enum: - released - enterprise: *734 - installation: *735 - organization: *736 - release: *793 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + release: *792 + repository: *736 sender: *4 required: - action @@ -220716,11 +223351,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *734 - installation: *735 - organization: *736 - release: *794 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + release: *793 + repository: *736 sender: *4 required: - action @@ -220796,11 +223431,11 @@ x-webhooks: type: string enum: - published - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - repository_advisory: *656 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + repository_advisory: *655 sender: *4 required: - action @@ -220876,11 +223511,11 @@ x-webhooks: type: string enum: - reported - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - repository_advisory: *656 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + repository_advisory: *655 sender: *4 required: - action @@ -220956,10 +223591,10 @@ x-webhooks: type: string enum: - archived - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -221036,10 +223671,10 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -221117,10 +223752,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -221204,10 +223839,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -221319,10 +223954,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -221394,10 +224029,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 status: type: string @@ -221478,10 +224113,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -221558,10 +224193,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -221655,10 +224290,10 @@ x-webhooks: - name required: - repository - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -221738,11 +224373,11 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - repository_ruleset: *324 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + repository_ruleset: *323 sender: *4 required: - action @@ -221820,11 +224455,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - repository_ruleset: *324 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + repository_ruleset: *323 sender: *4 required: - action @@ -221902,11 +224537,11 @@ x-webhooks: type: string enum: - edited - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - repository_ruleset: *324 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + repository_ruleset: *323 changes: type: object properties: @@ -221925,16 +224560,16 @@ x-webhooks: properties: added: type: array - items: *298 + items: *297 deleted: type: array - items: *298 + items: *297 updated: type: array items: type: object properties: - condition: *298 + condition: *297 changes: type: object properties: @@ -221967,16 +224602,16 @@ x-webhooks: properties: added: type: array - items: *612 + items: *611 deleted: type: array - items: *612 + items: *611 updated: type: array items: type: object properties: - rule: *612 + rule: *611 changes: type: object properties: @@ -222210,10 +224845,10 @@ x-webhooks: - from required: - owner - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -222291,10 +224926,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -222372,7 +225007,7 @@ x-webhooks: type: string enum: - create - alert: &795 + alert: &794 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -222494,10 +225129,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -222703,10 +225338,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -222784,11 +225419,11 @@ x-webhooks: type: string enum: - reopen - alert: *795 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + alert: *794 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -222987,10 +225622,10 @@ x-webhooks: enum: - fixed - open - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -223068,11 +225703,11 @@ x-webhooks: type: string enum: - assigned - alert: &796 + alert: &795 type: object properties: - number: *179 - created_at: *180 + number: *178 + created_at: *179 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -223080,8 +225715,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *182 - html_url: *183 + url: *181 + html_url: *182 locations_url: type: string format: uri @@ -223187,10 +225822,10 @@ x-webhooks: required: *21 nullable: true assignee: *4 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -223268,11 +225903,11 @@ x-webhooks: type: string enum: - created - alert: *796 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + alert: *795 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -223353,11 +225988,11 @@ x-webhooks: type: string enum: - created - alert: *796 - installation: *735 - location: *797 - organization: *736 - repository: *737 + alert: *795 + installation: *734 + location: *796 + organization: *735 + repository: *736 sender: *4 required: - location @@ -223595,11 +226230,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *796 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + alert: *795 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -223677,11 +226312,11 @@ x-webhooks: type: string enum: - reopened - alert: *796 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + alert: *795 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -223759,11 +226394,11 @@ x-webhooks: type: string enum: - resolved - alert: *796 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + alert: *795 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -223841,12 +226476,12 @@ x-webhooks: type: string enum: - unassigned - alert: *796 + alert: *795 assignee: *4 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -223924,11 +226559,11 @@ x-webhooks: type: string enum: - validated - alert: *796 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + alert: *795 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -224054,10 +226689,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *737 - enterprise: *734 - installation: *735 - organization: *736 + repository: *736 + enterprise: *733 + installation: *734 + organization: *735 sender: *4 required: - action @@ -224135,11 +226770,11 @@ x-webhooks: type: string enum: - published - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - security_advisory: &798 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + security_advisory: &797 description: The details of the security advisory, including summary, description, and severity. type: object @@ -224322,11 +226957,11 @@ x-webhooks: type: string enum: - updated - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - security_advisory: *798 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + security_advisory: *797 sender: *4 required: - action @@ -224399,10 +227034,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -224586,11 +227221,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *297 - enterprise: *734 - installation: *735 - organization: *736 - repository: *345 + security_and_analysis: *296 + enterprise: *733 + installation: *734 + organization: *735 + repository: *344 sender: *4 required: - changes @@ -224668,12 +227303,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - sponsorship: &799 + sponsorship: &798 type: object properties: created_at: @@ -224974,12 +227609,12 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - sponsorship: *799 + sponsorship: *798 required: - action - sponsorship @@ -225067,12 +227702,12 @@ x-webhooks: type: string required: - from - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - sponsorship: *799 + sponsorship: *798 required: - action - changes @@ -225149,17 +227784,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &800 + effective_date: &799 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: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - sponsorship: *799 + sponsorship: *798 required: - action - sponsorship @@ -225233,7 +227868,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &801 + changes: &800 type: object properties: tier: @@ -225277,13 +227912,13 @@ x-webhooks: - from required: - tier - effective_date: *800 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + effective_date: *799 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - sponsorship: *799 + sponsorship: *798 required: - action - changes @@ -225360,13 +227995,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *801 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + changes: *800 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - sponsorship: *799 + sponsorship: *798 required: - action - changes @@ -225440,10 +228075,10 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -225526,10 +228161,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -225949,15 +228584,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *734 + enterprise: *733 id: description: The unique identifier of the status. type: integer - installation: *735 + installation: *734 name: type: string - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 sha: description: The Commit SHA. @@ -226072,9 +228707,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *85 - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -226164,9 +228799,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *85 - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -226256,9 +228891,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *85 - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -226348,9 +228983,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *85 - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -226427,12 +229062,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - team: &802 + team: &801 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -226655,9 +229290,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 repository: title: Repository description: A git repository @@ -227115,7 +229750,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *802 + team: *801 required: - action - team @@ -227191,9 +229826,9 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 repository: title: Repository description: A git repository @@ -227651,7 +230286,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *802 + team: *801 required: - action - team @@ -227728,9 +230363,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 repository: title: Repository description: A git repository @@ -228188,7 +230823,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *802 + team: *801 required: - action - team @@ -228332,9 +230967,9 @@ x-webhooks: - from required: - permissions - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 repository: title: Repository description: A git repository @@ -228792,7 +231427,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *802 + team: *801 required: - action - changes @@ -228870,9 +231505,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 repository: title: Repository description: A git repository @@ -229330,7 +231965,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *802 + team: *801 required: - action - team @@ -229406,10 +232041,10 @@ x-webhooks: type: string enum: - started - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -229482,16 +232117,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *734 + enterprise: *733 inputs: type: object nullable: true additionalProperties: true - installation: *735 - organization: *736 + installation: *734 + organization: *735 ref: type: string - repository: *737 + repository: *736 sender: *4 workflow: type: string @@ -229573,10 +232208,10 @@ x-webhooks: type: string enum: - completed - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 workflow_job: allOf: @@ -229813,7 +232448,7 @@ x-webhooks: type: string required: - conclusion - deployment: *503 + deployment: *502 required: - action - repository @@ -229892,10 +232527,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 workflow_job: allOf: @@ -230155,7 +232790,7 @@ x-webhooks: required: - status - steps - deployment: *503 + deployment: *502 required: - action - repository @@ -230234,10 +232869,10 @@ x-webhooks: type: string enum: - queued - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 workflow_job: type: object @@ -230372,7 +233007,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *503 + deployment: *502 required: - action - repository @@ -230451,10 +233086,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 workflow_job: type: object @@ -230590,7 +233225,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *503 + deployment: *502 required: - action - repository @@ -230670,12 +233305,12 @@ x-webhooks: type: string enum: - completed - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - workflow: *751 + workflow: *750 workflow_run: title: Workflow Run type: object @@ -231674,12 +234309,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - workflow: *751 + workflow: *750 workflow_run: title: Workflow Run type: object @@ -232663,12 +235298,12 @@ x-webhooks: type: string enum: - requested - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - workflow: *751 + workflow: *750 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index bca6e774e6..3a5bc41ec2 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -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": [ @@ -1216,12 +1220,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { @@ -1958,6 +1960,3291 @@ } } }, + "/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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", @@ -22644,7 +25931,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -23877,12 +27165,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -74744,10 +78030,7 @@ "type": "string" } } - }, - "required": [ - "include_claim_keys" - ] + } }, "examples": { "default": { @@ -89091,6 +92374,19 @@ "type": "string" } } + }, + "examples": { + "insufficient_repo_permissions": { + "value": { + "message": { + "cause": "artifact metadata write permission required on one or more repositories", + "repositories": [ + 123, + 345 + ] + } + } + } } } } @@ -110352,7 +113648,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -111585,12 +114882,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -146869,7 +150164,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" ], @@ -147596,7 +150891,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" ], @@ -200542,6 +203837,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -200623,6 +203924,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -200638,6 +203945,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -200653,6 +203966,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -200713,6 +204032,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -200728,6 +204053,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -200743,6 +204074,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -200758,6 +204095,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -200773,6 +204116,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ @@ -205668,6 +209017,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": [ @@ -205966,6 +209328,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." } } }, @@ -319527,7 +322902,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -320340,12 +323716,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -320843,7 +324217,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -321665,12 +325040,10 @@ "score": 8.5 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-532", @@ -321996,7 +325369,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -514821,6 +518195,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -514902,6 +518282,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -514917,6 +518303,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -514932,6 +518324,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -514992,6 +518390,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -515007,6 +518411,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -515022,6 +518432,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -515037,6 +518453,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -515052,6 +518474,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ @@ -515959,6 +519387,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -516040,6 +519474,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -516055,6 +519495,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -516070,6 +519516,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -516130,6 +519582,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -516145,6 +519603,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -516160,6 +519624,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -516175,6 +519645,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -516190,6 +519666,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ @@ -517073,6 +520555,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -517154,6 +520642,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -517169,6 +520663,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -517184,6 +520684,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -517244,6 +520750,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -517259,6 +520771,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -517274,6 +520792,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -517289,6 +520813,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -517304,6 +520834,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ @@ -517690,6 +521226,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -517771,6 +521313,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -517786,6 +521334,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -517801,6 +521355,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -517861,6 +521421,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -517876,6 +521442,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -517891,6 +521463,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -517906,6 +521484,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -517921,6 +521505,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ @@ -755920,7 +759510,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -758357,7 +761948,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -760794,7 +764386,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -763231,7 +766824,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -765668,7 +769262,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -768105,7 +771700,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -770542,7 +774138,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -772979,7 +776576,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -1298449,6 +1302047,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -1298530,6 +1302134,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -1298545,6 +1302155,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -1298560,6 +1302176,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -1298620,6 +1302242,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -1298635,6 +1302263,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -1298650,6 +1302284,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -1298665,6 +1302305,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -1298680,6 +1302326,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index f16f496be6..30f624a2a1 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -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: @@ -827,7 +829,7 @@ paths: - subscriptions_url - type - url - type: &330 + type: &329 type: string description: The type of credit the user is receiving. enum: @@ -915,7 +917,7 @@ paths: - cwe_id: CWE-400 name: Uncontrolled Resource Consumption epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 credits: - user: @@ -992,7 +994,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &658 + - &657 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1082,6 +1084,2534 @@ 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 @@ -1548,7 +4078,7 @@ paths: schema: type: integer default: 30 - - &216 + - &215 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 @@ -1557,7 +4087,7 @@ paths: required: false schema: type: string - - &217 + - &216 name: status description: Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries @@ -1577,7 +4107,7 @@ paths: application/json: schema: type: array - items: &218 + items: &217 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1657,7 +4187,7 @@ paths: - installation_id - repository_id examples: - default: &219 + default: &218 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1785,7 +4315,7 @@ paths: description: Response content: application/json: - schema: &220 + schema: &219 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1899,7 +4429,7 @@ paths: - request - response examples: - default: &221 + default: &220 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2876,7 +5406,7 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: &295 + properties: &294 id: description: Unique identifier of the repository example: 42 @@ -3312,7 +5842,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &296 + required: &295 - archive_url - assignees_url - blobs_url @@ -7945,7 +10475,7 @@ paths: description: Response content: application/json: - schema: &190 + schema: &189 type: array description: A list of default code security configurations items: @@ -7961,7 +10491,7 @@ paths: default configuration: *49 examples: - default: &191 + default: &190 value: - default_for_new_repos: public configuration: @@ -8301,7 +10831,7 @@ paths: - *40 - *51 responses: - '204': &192 + '204': &191 description: A header with no content is returned. '400': *14 '403': *29 @@ -8428,7 +10958,7 @@ paths: default: value: default_for_new_repos: all - configuration: &189 + configuration: &188 value: id: 1325 target_type: organization @@ -8513,7 +11043,7 @@ paths: application/json: schema: type: array - items: &193 + items: &192 type: object description: Repositories associated with a code security configuration and attachment status @@ -8814,7 +11344,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &194 + repository: &193 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -9114,7 +11644,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &200 + - &199 name: state in: query description: |- @@ -9123,7 +11653,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &201 + - &200 name: severity in: query description: |- @@ -9132,7 +11662,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &202 + - &201 name: ecosystem in: query description: |- @@ -9141,14 +11671,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &203 + - &202 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 - - &204 + - &203 name: epss_percentage in: query description: |- @@ -9160,7 +11690,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 - - &493 + - &492 name: has in: query description: |- @@ -9174,7 +11704,7 @@ paths: type: string enum: - patch - - &205 + - &204 name: assignee in: query description: |- @@ -9183,7 +11713,7 @@ paths: Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. schema: type: string - - &206 + - &205 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -9193,7 +11723,7 @@ paths: enum: - development - runtime - - &207 + - &206 name: sort in: query description: |- @@ -9219,11 +11749,11 @@ paths: application/json: schema: type: array - items: &208 + items: &207 type: object description: A Dependabot alert. properties: - number: &179 + number: &178 type: integer description: The security alert number. readOnly: true @@ -9285,7 +11815,8 @@ paths: - unknown - direct - transitive - security_advisory: &494 + - inconclusive + security_advisory: &493 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9466,29 +11997,29 @@ paths: - withdrawn_at additionalProperties: false security_vulnerability: *65 - url: &182 + url: &181 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &183 + html_url: &182 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &180 + created_at: &179 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: &181 + updated_at: &180 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: &185 + dismissed_at: &184 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -9518,21 +12049,21 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: &184 + fixed_at: &183 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - auto_dismissed_at: &495 + auto_dismissed_at: &494 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissal_request: &496 + dismissal_request: &495 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -9594,7 +12125,7 @@ paths: - repository additionalProperties: false examples: - default: &209 + default: &208 value: - number: 2 state: dismissed @@ -9643,7 +12174,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 @@ -10409,7 +12940,7 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: &196 + properties: &195 login: type: string example: github @@ -10450,7 +12981,7 @@ paths: type: string example: A great organization nullable: true - required: &197 + required: &196 - login - url - id @@ -10930,7 +13461,7 @@ paths: properties: action: type: string - discussion: &752 + discussion: &751 title: Discussion description: A Discussion in a repository. type: object @@ -11297,7 +13828,7 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &547 + properties: &546 id: type: integer format: int64 @@ -11403,7 +13934,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &279 + properties: &278 url: type: string format: uri @@ -11473,7 +14004,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &280 + required: &279 - closed_issues - creator - description @@ -11552,7 +14083,7 @@ paths: timeline_url: type: string format: uri - type: &242 + type: &241 title: Issue Type description: The type of issue. type: object @@ -11666,7 +14197,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &670 + sub_issues_summary: &669 title: Sub-issues Summary type: object properties: @@ -11753,7 +14284,7 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: &569 + properties: &568 pinned_at: type: string format: date-time @@ -11765,7 +14296,7 @@ paths: properties: *20 required: *21 nullable: true - required: &570 + required: &569 - pinned_at - pinned_by nullable: true @@ -11779,7 +14310,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &671 + issue_dependencies_summary: &670 title: Issue Dependencies Summary type: object properties: @@ -11798,7 +14329,7 @@ paths: - total_blocking issue_field_values: type: array - items: &554 + items: &553 title: Issue Field Value description: A value assigned to an issue field type: object @@ -11859,7 +14390,7 @@ paths: - node_id - data_type - value - required: &548 + required: &547 - closed_at - comments - comments_url @@ -11896,7 +14427,7 @@ paths: action: type: string issue: *85 - comment: &543 + comment: &542 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -12560,7 +15091,7 @@ paths: type: string release: allOf: - - &603 + - &602 title: Release description: A release. type: object @@ -12631,7 +15162,7 @@ paths: author: *4 assets: type: array - items: &604 + items: &603 title: Release Asset description: Data related to a release. type: object @@ -14869,7 +17400,7 @@ paths: - closed - all default: open - - &245 + - &244 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -14920,7 +17451,7 @@ paths: type: array items: *85 examples: - default: &246 + default: &245 value: - id: 1 node_id: MDU6SXNzdWUx @@ -16305,14 +18836,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &342 + - &341 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &343 + - &342 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -16374,7 +18905,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &346 + '301': &345 description: Moved permanently content: application/json: @@ -16396,7 +18927,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &579 + - &578 name: all description: If `true`, show notifications marked as read. in: query @@ -16404,7 +18935,7 @@ paths: schema: type: boolean default: false - - &580 + - &579 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -16414,7 +18945,7 @@ paths: type: boolean default: false - *92 - - &581 + - &580 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: @@ -16446,11 +18977,11 @@ paths: properties: id: type: string - repository: &161 + repository: &160 title: Minimal Repository description: Minimal Repository type: object - properties: &211 + properties: &210 id: type: integer format: int64 @@ -16734,7 +19265,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &297 + security_and_analysis: &296 nullable: true type: object properties: @@ -16847,7 +19378,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &212 + required: &211 - archive_url - assignees_url - blobs_url @@ -16935,7 +19466,7 @@ paths: - url - subscription_url examples: - default: &582 + default: &581 value: - id: '1' repository: @@ -18482,7 +21013,7 @@ paths: required: false schema: type: string - - &727 + - &726 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -18628,7 +21159,7 @@ paths: parameters: - *75 - *123 - - &728 + - &727 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 @@ -18740,7 +21271,7 @@ paths: - *123 - *125 - *124 - - &729 + - &728 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -18748,7 +21279,7 @@ paths: schema: type: string - *126 - - &730 + - &729 name: sku description: The SKU to query for usage. in: query @@ -19641,7 +22172,7 @@ paths: type: integer repository_cache_usages: type: array - items: &353 + items: &352 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -19864,7 +22395,7 @@ paths: - public_ip_enabled - platform examples: - default: &160 + default: &159 value: total_count: 2 runners: @@ -20838,7 +23369,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &143 + schema: title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -20852,7 +23383,7 @@ paths: required: - include_claim_keys examples: - default: &144 + default: &143 value: include_claim_keys: - repo @@ -20879,15 +23410,25 @@ paths: required: true content: application/json: - schema: *143 + 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: *144 + default: *143 responses: '201': description: Empty response content: application/json: - schema: &170 + schema: &169 title: Empty Object description: An object without any properties. type: object @@ -20926,7 +23467,7 @@ paths: schema: type: object properties: - enabled_repositories: &145 + enabled_repositories: &144 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -20939,7 +23480,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: &146 + allowed_actions: &145 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -20947,12 +23488,12 @@ paths: - all - local_only - selected - selected_actions_url: &359 + selected_actions_url: &358 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: &147 + sha_pinning_required: &146 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -20994,9 +23535,9 @@ paths: schema: type: object properties: - enabled_repositories: *145 - allowed_actions: *146 - sha_pinning_required: *147 + enabled_repositories: *144 + allowed_actions: *145 + sha_pinning_required: *146 required: - enabled_repositories examples: @@ -21030,7 +23571,7 @@ paths: description: Response content: application/json: - schema: &363 + schema: &362 type: object properties: days: @@ -21072,7 +23613,7 @@ paths: required: true content: application/json: - schema: &364 + schema: &363 type: object properties: days: @@ -21115,7 +23656,7 @@ paths: description: Response content: application/json: - schema: &148 + schema: &147 type: object properties: approval_policy: @@ -21129,7 +23670,7 @@ paths: required: - approval_policy examples: - default: &365 + default: &364 value: approval_policy: first_time_contributors '404': *6 @@ -21160,7 +23701,7 @@ paths: required: true content: application/json: - schema: *148 + schema: *147 examples: default: summary: Set approval policy to first time contributors @@ -21188,7 +23729,7 @@ paths: description: Response content: application/json: - schema: &366 + schema: &365 type: object required: - run_workflows_from_fork_pull_requests @@ -21214,7 +23755,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &149 + default: &148 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -21242,7 +23783,7 @@ paths: required: true content: application/json: - schema: &367 + schema: &366 type: object required: - run_workflows_from_fork_pull_requests @@ -21265,7 +23806,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *149 + default: *148 responses: '204': description: Empty response for successful settings update @@ -21315,7 +23856,7 @@ paths: type: array items: *79 examples: - default: &153 + default: &152 value: total_count: 1 repositories: @@ -21500,7 +24041,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *75 - - &150 + - &149 name: repository_id description: The unique identifier of the repository. in: path @@ -21529,7 +24070,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *75 - - *150 + - *149 responses: '204': description: Response @@ -21558,7 +24099,7 @@ paths: description: Response content: application/json: - schema: &151 + schema: &150 type: object properties: github_owned_allowed: @@ -21580,7 +24121,7 @@ paths: items: type: string examples: - default: &152 + default: &151 value: github_owned_allowed: true verified_allowed: false @@ -21613,9 +24154,9 @@ paths: required: false content: application/json: - schema: *151 + schema: *150 examples: - selected_actions: *152 + selected_actions: *151 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21747,7 +24288,7 @@ paths: type: array items: *79 examples: - default: *153 + default: *152 '403': *29 '404': *6 x-github: @@ -21816,7 +24357,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: - *75 - - *150 + - *149 responses: '204': description: No content @@ -21843,7 +24384,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: - *75 - - *150 + - *149 responses: '204': description: No content @@ -21877,17 +24418,17 @@ paths: description: Response content: application/json: - schema: &368 + schema: &367 type: object properties: - default_workflow_permissions: &154 + default_workflow_permissions: &153 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &155 + can_approve_pull_request_reviews: &154 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -21895,7 +24436,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &156 + default: &155 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -21928,13 +24469,13 @@ paths: required: false content: application/json: - schema: &369 + schema: &368 type: object properties: - default_workflow_permissions: *154 - can_approve_pull_request_reviews: *155 + default_workflow_permissions: *153 + can_approve_pull_request_reviews: *154 examples: - default: *156 + default: *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21979,7 +24520,7 @@ paths: type: number runner_groups: type: array - items: &157 + items: &156 type: object properties: id: @@ -22167,9 +24708,9 @@ paths: description: Response content: application/json: - schema: *157 + schema: *156 examples: - default: &159 + default: &158 value: id: 2 name: octo-runner-group @@ -22205,7 +24746,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - *75 - - &158 + - &157 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -22217,7 +24758,7 @@ paths: description: Response content: application/json: - schema: *157 + schema: *156 examples: default: value: @@ -22254,7 +24795,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - *75 - - *158 + - *157 requestBody: required: true content: @@ -22308,9 +24849,9 @@ paths: description: Response content: application/json: - schema: *157 + schema: *156 examples: - default: *159 + default: *158 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22330,7 +24871,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - *75 - - *158 + - *157 responses: '204': description: Response @@ -22354,7 +24895,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - *75 - - *158 + - *157 - *17 - *19 responses: @@ -22374,7 +24915,7 @@ paths: type: array items: *131 examples: - default: *160 + default: *159 headers: Link: *67 x-github: @@ -22397,7 +24938,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: - *75 - - *158 + - *157 - *19 - *17 responses: @@ -22415,9 +24956,9 @@ paths: type: number repositories: type: array - items: *161 + items: *160 examples: - default: &199 + default: &198 value: total_count: 1 repositories: @@ -22670,7 +25211,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: - *75 - - *158 + - *157 requestBody: required: true content: @@ -22715,8 +25256,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: - *75 - - *158 - - *150 + - *157 + - *149 responses: '204': description: Response @@ -22739,8 +25280,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: - *75 - - *158 - - *150 + - *157 + - *149 responses: '204': description: Response @@ -22764,7 +25305,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - *75 - - *158 + - *157 - *17 - *19 responses: @@ -22782,7 +25323,7 @@ paths: type: number runners: type: array - items: &163 + items: &162 title: Self hosted runners description: A self hosted runner type: object @@ -22811,7 +25352,7 @@ paths: type: boolean labels: type: array - items: &166 + items: &165 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -22841,7 +25382,7 @@ paths: - busy - labels examples: - default: &164 + default: &163 value: total_count: 2 runners: @@ -22901,7 +25442,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - *75 - - *158 + - *157 requestBody: required: true content: @@ -22946,8 +25487,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: - *75 - - *158 - - &162 + - *157 + - &161 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -22976,8 +25517,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: - *75 - - *158 - - *162 + - *157 + - *161 responses: '204': description: Response @@ -23025,9 +25566,9 @@ paths: type: integer runners: type: array - items: *163 + items: *162 examples: - default: *164 + default: *163 headers: Link: *67 x-github: @@ -23059,7 +25600,7 @@ paths: application/json: schema: type: array - items: &370 + items: &369 title: Runner Application description: Runner Application type: object @@ -23084,7 +25625,7 @@ paths: - download_url - filename examples: - default: &371 + default: &370 value: - os: osx architecture: x64 @@ -23170,7 +25711,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &372 + '201': &371 description: Response content: application/json: @@ -23180,7 +25721,7 @@ paths: - runner - encoded_jit_config properties: - runner: *163 + runner: *162 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -23243,7 +25784,7 @@ paths: description: Response content: application/json: - schema: &165 + schema: &164 title: Authentication Token description: Authentication Token type: object @@ -23281,7 +25822,7 @@ paths: - token - expires_at examples: - default: &373 + default: &372 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -23318,9 +25859,9 @@ paths: description: Response content: application/json: - schema: *165 + schema: *164 examples: - default: &374 + default: &373 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -23346,15 +25887,15 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - *75 - - *162 + - *161 responses: '200': description: Response content: application/json: - schema: *163 + schema: *162 examples: - default: &375 + default: &374 value: id: 23 name: MBP @@ -23396,7 +25937,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - *75 - - *162 + - *161 responses: '204': description: Response @@ -23423,9 +25964,9 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - *75 - - *162 + - *161 responses: - '200': &167 + '200': &166 description: Response content: application/json: @@ -23439,7 +25980,7 @@ paths: type: integer labels: type: array - items: *166 + items: *165 examples: default: value: @@ -23479,7 +26020,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - *75 - - *162 + - *161 requestBody: required: true content: @@ -23503,7 +26044,7 @@ paths: - gpu - accelerated responses: - '200': *167 + '200': *166 '404': *6 '422': *7 x-github: @@ -23528,7 +26069,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - *75 - - *162 + - *161 requestBody: required: true content: @@ -23553,7 +26094,7 @@ paths: - gpu - accelerated responses: - '200': *167 + '200': *166 '404': *6 '422': *7 x-github: @@ -23578,9 +26119,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: - *75 - - *162 + - *161 responses: - '200': &376 + '200': &375 description: Response content: application/json: @@ -23594,7 +26135,7 @@ paths: type: integer labels: type: array - items: *166 + items: *165 examples: default: value: @@ -23636,8 +26177,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: - *75 - - *162 - - &377 + - *161 + - &376 name: name description: The name of a self-hosted runner's custom label. in: path @@ -23645,7 +26186,7 @@ paths: schema: type: string responses: - '200': *167 + '200': *166 '404': *6 '422': *7 x-github: @@ -23688,7 +26229,7 @@ paths: type: integer secrets: type: array - items: &168 + items: &167 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -23767,7 +26308,7 @@ paths: description: Response content: application/json: - schema: &389 + schema: &388 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -23796,7 +26337,7 @@ paths: - key_id - key examples: - default: &390 + default: &389 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -23822,7 +26363,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - *75 - - &169 + - &168 name: secret_name description: The name of the secret. in: path @@ -23834,7 +26375,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *167 examples: default: value: @@ -23865,7 +26406,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -23922,7 +26463,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -23949,7 +26490,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - *75 - - *169 + - *168 responses: '204': description: Response @@ -23976,7 +26517,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - *75 - - *169 + - *168 - *19 - *17 responses: @@ -23994,9 +26535,9 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 examples: - default: &173 + default: &172 value: total_count: 1 repositories: @@ -24089,7 +26630,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -24142,7 +26683,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - *75 - - *169 + - *168 - name: repository_id in: path required: true @@ -24176,7 +26717,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - *75 - - *169 + - *168 - name: repository_id in: path required: true @@ -24209,7 +26750,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *75 - - &358 + - &357 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)." @@ -24233,7 +26774,7 @@ paths: type: integer variables: type: array - items: &171 + items: &170 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -24366,7 +26907,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -24392,7 +26933,7 @@ paths: url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - *75 - - &172 + - &171 name: name description: The name of the variable. in: path @@ -24404,7 +26945,7 @@ paths: description: Response content: application/json: - schema: *171 + schema: *170 examples: default: value: @@ -24435,7 +26976,7 @@ paths: url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - *75 - - *172 + - *171 requestBody: required: true content: @@ -24498,7 +27039,7 @@ paths: url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - *75 - - *172 + - *171 responses: '204': description: Response @@ -24525,7 +27066,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - *75 - - *172 + - *171 - *19 - *17 responses: @@ -24543,9 +27084,9 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 examples: - default: *173 + default: *172 '409': description: Response when the visibility of the variable is not set to `selected` @@ -24572,7 +27113,7 @@ paths: url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - *75 - - *172 + - *171 requestBody: required: true content: @@ -24622,7 +27163,7 @@ paths: url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - *75 - - *172 + - *171 - name: repository_id in: path required: true @@ -24657,7 +27198,7 @@ paths: url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - *75 - - *172 + - *171 - name: repository_id in: path required: true @@ -24814,7 +27355,7 @@ paths: type: integer deployment_records: type: array - items: &174 + items: &173 title: Artifact Deployment Record description: Artifact Metadata Deployment Record type: object @@ -24858,7 +27399,7 @@ paths: with the deployment record. nullable: true examples: - default: &175 + default: &174 value: total_count: 1 deployment_records: @@ -25031,10 +27572,23 @@ paths: type: integer deployment_records: type: array - items: *174 + items: *173 examples: - default: *175 - '403': *29 + default: *174 + '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 @@ -25234,9 +27788,9 @@ paths: type: integer deployment_records: type: array - items: *174 + items: *173 examples: - default: *175 + default: *174 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25365,12 +27919,12 @@ paths: required: - subject_digests examples: - default: &709 + default: &708 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &710 + withPredicateType: &709 value: subject_digests: - sha256:abc123 @@ -25414,7 +27968,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &711 + default: &710 value: attestations_subject_digests: - sha256:abc: @@ -25747,7 +28301,7 @@ paths: initiator: type: string examples: - default: &403 + default: &402 value: attestations: - bundle: @@ -25966,7 +28520,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &176 + schema: &175 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -25992,7 +28546,7 @@ paths: application/json: schema: type: array - items: &177 + items: &176 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -26023,7 +28577,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &198 + items: &197 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -26098,7 +28652,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &257 + properties: &256 id: description: Unique identifier of the team type: integer @@ -26170,7 +28724,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &258 + required: &257 - id - node_id - url @@ -26213,7 +28767,7 @@ paths: type: string format: date-time nullable: true - state: *176 + state: *175 contact_link: description: The contact link of the campaign. type: string @@ -26433,9 +28987,9 @@ paths: description: Response content: application/json: - schema: *177 + schema: *176 examples: - default: &178 + default: &177 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -26518,9 +29072,9 @@ paths: description: Response content: application/json: - schema: *177 + schema: *176 examples: - default: *178 + default: *177 '404': *6 '422': description: Unprocessable Entity @@ -26597,7 +29151,7 @@ paths: type: string format: uri nullable: true - state: *176 + state: *175 examples: default: value: @@ -26607,9 +29161,9 @@ paths: description: Response content: application/json: - schema: *177 + schema: *176 examples: - default: *178 + default: *177 '400': description: Bad Request content: @@ -26676,17 +29230,17 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *75 - - &428 + - &427 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: &186 + schema: &185 type: string description: The name of the tool used to generate the code scanning analysis. - - &429 + - &428 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 @@ -26694,7 +29248,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &187 + schema: &186 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, @@ -26709,7 +29263,7 @@ paths: be returned. in: query required: false - schema: &431 + schema: &430 type: string description: State of a code scanning alert. enum: @@ -26732,7 +29286,7 @@ paths: be returned. in: query required: false - schema: &432 + schema: &431 type: string description: Severity of a code scanning alert. enum: @@ -26761,18 +29315,18 @@ paths: items: type: object properties: - number: *179 - created_at: *180 - updated_at: *181 - url: *182 - html_url: *183 - instances_url: &433 + number: *178 + created_at: *179 + updated_at: *180 + url: *181 + html_url: *182 + instances_url: &432 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &188 + state: &187 type: string description: State of a code scanning alert. nullable: true @@ -26780,7 +29334,7 @@ paths: - open - dismissed - fixed - fixed_at: *184 + fixed_at: *183 dismissed_by: title: Simple User description: A GitHub user. @@ -26788,8 +29342,8 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *185 - dismissed_reason: &434 + dismissed_at: *184 + dismissed_reason: &433 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -26798,13 +29352,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &435 + dismissed_comment: &434 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &436 + rule: &435 type: object properties: id: @@ -26857,42 +29411,42 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &437 + tool: &436 type: object properties: - name: *186 + name: *185 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *187 - most_recent_instance: &438 + guid: *186 + most_recent_instance: &437 type: object properties: - ref: &430 + ref: &429 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &448 + analysis_key: &447 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: &449 + environment: &448 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: &450 + category: &449 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: *188 + state: *187 commit_sha: type: string message: @@ -26906,7 +29460,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: &451 + location: &450 type: object description: Describe a region within a file for the alert. properties: @@ -26927,7 +29481,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: &452 + items: &451 type: string description: A classification of the file. For example to identify it as generated. @@ -27564,7 +30118,7 @@ paths: application/json: schema: *49 examples: - default: *189 + default: *188 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27592,9 +30146,9 @@ paths: description: Response content: application/json: - schema: *190 + schema: *189 examples: - default: *191 + default: *190 '304': *37 '403': *29 '404': *6 @@ -27646,7 +30200,7 @@ paths: - 32 - 91 responses: - '204': *192 + '204': *191 '400': *14 '403': *29 '404': *6 @@ -27681,7 +30235,7 @@ paths: application/json: schema: *49 examples: - default: *189 + default: *188 '304': *37 '403': *29 '404': *6 @@ -27981,7 +30535,7 @@ paths: - *75 - *51 responses: - '204': *192 + '204': *191 '400': *14 '403': *29 '404': *6 @@ -28119,7 +30673,7 @@ paths: default: value: default_for_new_repos: all - configuration: *189 + configuration: *188 '403': *29 '404': *6 x-github: @@ -28172,13 +30726,13 @@ paths: application/json: schema: type: array - items: *193 + items: *192 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *194 + repository: *193 '403': *29 '404': *6 x-github: @@ -28218,7 +30772,7 @@ paths: type: integer codespaces: type: array - items: &247 + items: &246 type: object title: Codespace description: A codespace. @@ -28243,12 +30797,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *161 + repository: *160 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &464 + properties: &463 name: type: string description: The name of the machine. @@ -28290,7 +30844,7 @@ paths: - ready - in_progress nullable: true - required: &465 + required: &464 - name - display_name - operating_system @@ -28495,7 +31049,7 @@ paths: - pulls_url - recent_folders examples: - default: &248 + default: &247 value: total_count: 3 codespaces: @@ -29119,7 +31673,7 @@ paths: type: integer secrets: type: array - items: &195 + items: &194 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -29158,7 +31712,7 @@ paths: - updated_at - visibility examples: - default: &466 + default: &465 value: total_count: 2 secrets: @@ -29196,7 +31750,7 @@ paths: description: Response content: application/json: - schema: &467 + schema: &466 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -29225,7 +31779,7 @@ paths: - key_id - key examples: - default: &468 + default: &467 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -29249,15 +31803,15 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - *75 - - *169 + - *168 responses: '200': description: Response content: application/json: - schema: *195 + schema: *194 examples: - default: &470 + default: &469 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -29285,7 +31839,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -29340,7 +31894,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -29367,7 +31921,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - *75 - - *169 + - *168 responses: '204': description: Response @@ -29393,7 +31947,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - *75 - - *169 + - *168 - *19 - *17 responses: @@ -29411,9 +31965,9 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 examples: - default: *173 + default: *172 '404': *6 x-github: githubCloudOnly: false @@ -29436,7 +31990,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -29487,7 +32041,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - *75 - - *169 + - *168 - name: repository_id in: path required: true @@ -29521,7 +32075,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - *75 - - *169 + - *168 - name: repository_id in: path required: true @@ -29724,7 +32278,7 @@ paths: currently being billed. seats: type: array - items: &250 + items: &249 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -29741,14 +32295,14 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *196 - required: *197 + properties: *195 + required: *196 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *198 + - *197 - *68 nullable: true pending_cancellation_date: @@ -30355,12 +32909,12 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 required: - total_count - repositories examples: - default: *199 + default: *198 '500': *55 '401': *25 '403': *29 @@ -30446,7 +33000,7 @@ paths: url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization parameters: - *75 - - *150 + - *149 responses: '204': description: No Content @@ -30480,7 +33034,7 @@ paths: url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization parameters: - *75 - - *150 + - *149 responses: '204': description: No Content @@ -30695,7 +33249,7 @@ paths: application/json: schema: type: array - items: &335 + items: &334 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -31002,7 +33556,7 @@ paths: - date additionalProperties: true examples: - default: &336 + default: &335 value: - date: '2024-06-24' total_active_users: 24 @@ -31104,7 +33658,7 @@ paths: '500': *55 '403': *29 '404': *6 - '422': &337 + '422': &336 description: Copilot Usage Metrics API setting is disabled at the organization or enterprise level. content: @@ -31145,7 +33699,7 @@ paths: schema: *57 examples: default: *58 - '204': *192 + '204': *191 '500': *55 '403': *29 '404': *6 @@ -31221,7 +33775,7 @@ paths: schema: *57 examples: default: *58 - '204': *192 + '204': *191 '500': *55 '403': *29 '404': *6 @@ -31284,11 +33838,11 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *75 + - *199 - *200 - *201 - *202 - *203 - - *204 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -31318,7 +33872,7 @@ paths: enum: - patch - deployment - - *205 + - *204 - name: runtime_risk in: query description: |- @@ -31327,8 +33881,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string + - *205 - *206 - - *207 - *61 - *47 - *48 @@ -31340,9 +33894,9 @@ paths: application/json: schema: type: array - items: *208 + items: *207 examples: - default: *209 + default: *208 '304': *37 '400': *14 '403': *29 @@ -31386,7 +33940,7 @@ paths: type: integer secrets: type: array - items: &210 + items: &209 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -31463,7 +34017,7 @@ paths: description: Response content: application/json: - schema: &499 + schema: &498 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -31480,7 +34034,7 @@ paths: - key_id - key examples: - default: &500 + default: &499 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -31504,13 +34058,13 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - *75 - - *169 + - *168 responses: '200': description: Response content: application/json: - schema: *210 + schema: *209 examples: default: value: @@ -31539,7 +34093,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -31594,7 +34148,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -31619,7 +34173,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - *75 - - *169 + - *168 responses: '204': description: Response @@ -31644,7 +34198,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - *75 - - *169 + - *168 - *19 - *17 responses: @@ -31662,9 +34216,9 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 examples: - default: *173 + default: *172 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31686,7 +34240,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -31737,7 +34291,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - *75 - - *169 + - *168 - name: repository_id in: path required: true @@ -31769,7 +34323,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - *75 - - *169 + - *168 - name: repository_id in: path required: true @@ -31807,7 +34361,7 @@ paths: application/json: schema: type: array - items: &260 + items: &259 title: Package description: A software package type: object @@ -31857,8 +34411,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *211 - required: *212 + properties: *210 + required: *211 nullable: true created_at: type: string @@ -31877,7 +34431,7 @@ paths: - created_at - updated_at examples: - default: &261 + default: &260 value: - id: 197 name: hello_docker @@ -32047,7 +34601,7 @@ paths: application/json: schema: type: array - items: &236 + items: &235 title: Organization Invitation description: Organization Invitation type: object @@ -32094,7 +34648,7 @@ paths: - invitation_teams_url - node_id examples: - default: &237 + default: &236 value: - id: 1 login: monalisa @@ -32161,7 +34715,7 @@ paths: application/json: schema: type: array - items: &213 + items: &212 title: Org Hook description: Org Hook type: object @@ -32332,9 +34886,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *212 examples: - default: &214 + default: &213 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -32382,7 +34936,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - *75 - - &215 + - &214 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. @@ -32395,9 +34949,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *212 examples: - default: *214 + default: *213 '404': *6 x-github: githubCloudOnly: false @@ -32425,7 +34979,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - *75 - - *215 + - *214 requestBody: required: false content: @@ -32470,7 +35024,7 @@ paths: description: Response content: application/json: - schema: *213 + schema: *212 examples: default: value: @@ -32512,7 +35066,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - *75 - - *215 + - *214 responses: '204': description: Response @@ -32540,7 +35094,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *75 - - *215 + - *214 responses: '200': description: Response @@ -32571,7 +35125,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *75 - - *215 + - *214 requestBody: required: false content: @@ -32622,10 +35176,10 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *75 - - *215 + - *214 - *17 + - *215 - *216 - - *217 responses: '200': description: Response @@ -32633,9 +35187,9 @@ paths: application/json: schema: type: array - items: *218 + items: *217 examples: - default: *219 + default: *218 '400': *14 '422': *15 x-github: @@ -32661,16 +35215,16 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *75 - - *215 + - *214 - *16 responses: '200': description: Response content: application/json: - schema: *220 + schema: *219 examples: - default: *221 + default: *220 '400': *14 '422': *15 x-github: @@ -32696,7 +35250,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *75 - - *215 + - *214 - *16 responses: '202': *39 @@ -32726,7 +35280,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - *75 - - *215 + - *214 responses: '204': description: Response @@ -32749,7 +35303,7 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - *75 - - &226 + - &225 name: actor_type in: path description: The type of the actor @@ -32762,14 +35316,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &227 + - &226 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &222 + - &221 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`.' @@ -32777,7 +35331,7 @@ paths: required: true schema: type: string - - &223 + - &222 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) @@ -32871,12 +35425,12 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - *75 + - *221 - *222 - - *223 - *19 - *17 - *61 - - &232 + - &231 name: sort description: The property to sort the results by. in: query @@ -32954,14 +35508,14 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - *75 + - *221 - *222 - - *223 responses: '200': description: Response content: application/json: - schema: &224 + schema: &223 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -32977,7 +35531,7 @@ paths: type: integer format: int64 examples: - default: &225 + default: &224 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -32998,23 +35552,23 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - *75 - - &228 + - &227 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string + - *221 - *222 - - *223 responses: '200': description: Response content: application/json: - schema: *224 + schema: *223 examples: - default: *225 + default: *224 x-github: enabledForGitHubApps: true category: orgs @@ -33033,18 +35587,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *75 + - *221 - *222 - - *223 + - *225 - *226 - - *227 responses: '200': description: Response content: application/json: - schema: *224 + schema: *223 examples: - default: *225 + default: *224 x-github: enabledForGitHubApps: true category: orgs @@ -33062,9 +35616,9 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - *75 + - *221 - *222 - - *223 - - &229 + - &228 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -33077,7 +35631,7 @@ paths: description: Response content: application/json: - schema: &230 + schema: &229 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -33093,7 +35647,7 @@ paths: type: integer format: int64 examples: - default: &231 + default: &230 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -33130,18 +35684,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - *75 - - *228 + - *227 + - *221 - *222 - - *223 - - *229 + - *228 responses: '200': description: Response content: application/json: - schema: *230 + schema: *229 examples: - default: *231 + default: *230 x-github: enabledForGitHubApps: true category: orgs @@ -33159,19 +35713,19 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - *75 + - *225 - *226 - - *227 + - *221 - *222 - - *223 - - *229 + - *228 responses: '200': description: Response content: application/json: - schema: *230 + schema: *229 examples: - default: *231 + default: *230 x-github: enabledForGitHubApps: true category: orgs @@ -33189,13 +35743,13 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - *75 - - *228 + - *227 + - *221 - *222 - - *223 - *19 - *17 - *61 - - *232 + - *231 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -33276,7 +35830,7 @@ paths: application/json: schema: *22 examples: - default: &538 + default: &537 value: id: 1 account: @@ -33442,12 +35996,12 @@ paths: application/json: schema: anyOf: - - &234 + - &233 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &233 + limit: &232 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -33472,7 +36026,7 @@ paths: properties: {} additionalProperties: false examples: - default: &235 + default: &234 value: limit: collaborators_only origin: organization @@ -33501,13 +36055,13 @@ paths: required: true content: application/json: - schema: &539 + schema: &538 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *233 + limit: *232 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -33531,9 +36085,9 @@ paths: description: Response content: application/json: - schema: *234 + schema: *233 examples: - default: *235 + default: *234 '422': *15 x-github: githubCloudOnly: false @@ -33609,9 +36163,9 @@ paths: application/json: schema: type: array - items: *236 + items: *235 examples: - default: *237 + default: *236 headers: Link: *67 '404': *6 @@ -33688,7 +36242,7 @@ paths: description: Response content: application/json: - schema: *236 + schema: *235 examples: default: value: @@ -33743,7 +36297,7 @@ paths: url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - *75 - - &238 + - &237 name: invitation_id description: The unique identifier of the invitation. in: path @@ -33774,7 +36328,7 @@ paths: url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - *75 - - *238 + - *237 - *17 - *19 responses: @@ -33784,9 +36338,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: &259 + default: &258 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -33829,7 +36383,7 @@ paths: application/json: schema: type: array - items: &239 + items: &238 title: Issue Field description: A custom attribute defined at the organization level for attaching structured data to issues. @@ -34062,9 +36616,9 @@ paths: description: Response content: application/json: - schema: *239 + schema: *238 examples: - default: &240 + default: &239 value: id: 512 node_id: IF_kwDNAd3NAZr @@ -34120,7 +36674,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-fields#update-issue-field-for-an-organization parameters: - *75 - - &241 + - &240 name: issue_field_id description: The unique identifier of the issue field. in: path @@ -34219,9 +36773,9 @@ paths: description: Response content: application/json: - schema: *239 + schema: *238 examples: - default: *240 + default: *239 '404': *6 '422': *7 x-github: @@ -34246,9 +36800,9 @@ paths: url: https://docs.github.com/rest/orgs/issue-fields#delete-issue-field-for-an-organization parameters: - *75 - - *241 + - *240 responses: - '204': *192 + '204': *191 '404': *6 '422': *7 x-github: @@ -34276,7 +36830,7 @@ paths: application/json: schema: type: array - items: *242 + items: *241 examples: default: value: @@ -34361,9 +36915,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *241 examples: - default: &243 + default: &242 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -34396,7 +36950,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *75 - - &244 + - &243 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -34449,9 +37003,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *241 examples: - default: *243 + default: *242 '404': *6 '422': *7 x-github: @@ -34476,7 +37030,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *75 - - *244 + - *243 responses: '204': description: Response @@ -34539,7 +37093,7 @@ paths: - closed - all default: open - - *245 + - *244 - name: type description: Can be the name of an issue type. in: query @@ -34570,7 +37124,7 @@ paths: type: array items: *85 examples: - default: *246 + default: *245 headers: Link: *67 '404': *6 @@ -34730,9 +37284,9 @@ paths: type: integer codespaces: type: array - items: *247 + items: *246 examples: - default: *248 + default: *247 '304': *37 '500': *55 '401': *25 @@ -34759,7 +37313,7 @@ paths: parameters: - *75 - *71 - - &249 + - &248 name: codespace_name in: path required: true @@ -34794,15 +37348,15 @@ paths: parameters: - *75 - *71 - - *249 + - *248 responses: '200': description: Response content: application/json: - schema: *247 + schema: *246 examples: - default: &463 + default: &462 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -34982,7 +37536,7 @@ paths: description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *250 + schema: *249 examples: default: value: @@ -35058,7 +37612,7 @@ paths: description: Response content: application/json: - schema: &251 + schema: &250 title: Org Membership description: Org Membership type: object @@ -35125,7 +37679,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &252 + response-if-user-has-an-active-admin-membership-with-organization: &251 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -35226,9 +37780,9 @@ paths: description: Response content: application/json: - schema: *251 + schema: *250 examples: - response-if-user-already-had-membership-with-organization: *252 + response-if-user-already-had-membership-with-organization: *251 '422': *15 '403': *29 '451': *15 @@ -35300,7 +37854,7 @@ paths: application/json: schema: type: array - items: &253 + items: &252 title: Migration description: A migration. type: object @@ -35629,7 +38183,7 @@ paths: description: Response content: application/json: - schema: *253 + schema: *252 examples: default: value: @@ -35808,7 +38362,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - *75 - - &254 + - &253 name: migration_id description: The unique identifier of the migration. in: path @@ -35835,7 +38389,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *253 + schema: *252 examples: default: value: @@ -36005,7 +38559,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - *75 - - *254 + - *253 responses: '302': description: Response @@ -36027,7 +38581,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *75 - - *254 + - *253 responses: '204': description: Response @@ -36051,8 +38605,8 @@ paths: url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - *75 - - *254 - - &691 + - *253 + - &690 name: repo_name description: repo_name parameter in: path @@ -36080,7 +38634,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *75 - - *254 + - *253 - *17 - *19 responses: @@ -36108,7 +38662,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: @@ -36134,7 +38688,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &256 + items: &255 title: Organization Role description: Organization roles type: object @@ -36309,7 +38863,7 @@ paths: parameters: - *75 - *77 - - &255 + - &254 name: role_id description: The unique identifier of the role. in: path @@ -36346,7 +38900,7 @@ paths: parameters: - *75 - *77 - - *255 + - *254 responses: '204': description: Response @@ -36399,7 +38953,7 @@ paths: parameters: - *75 - *71 - - *255 + - *254 responses: '204': description: Response @@ -36431,7 +38985,7 @@ paths: parameters: - *75 - *71 - - *255 + - *254 responses: '204': description: Response @@ -36449,7 +39003,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: @@ -36460,13 +39014,13 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - *75 - - *255 + - *254 responses: '200': description: Response content: application/json: - schema: *256 + schema: *255 examples: default: value: @@ -36517,7 +39071,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - *75 - - *255 + - *254 - *17 - *19 responses: @@ -36595,8 +39149,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *257 - required: *258 + properties: *256 + required: *257 nullable: true type: description: The ownership type of the team @@ -36628,7 +39182,7 @@ paths: - type - parent examples: - default: *259 + default: *258 headers: Link: *67 '404': @@ -36658,7 +39212,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - *75 - - *255 + - *254 - *17 - *19 responses: @@ -36686,13 +39240,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &331 + items: &330 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *257 - required: *258 + properties: *256 + required: *257 name: nullable: true type: string @@ -36980,7 +39534,7 @@ paths: - nuget - container - *75 - - &692 + - &691 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -37016,12 +39570,12 @@ paths: application/json: schema: type: array - items: *260 + items: *259 examples: - default: *261 + default: *260 '403': *29 '401': *25 - '400': &694 + '400': &693 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -37043,7 +39597,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &262 + - &261 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 @@ -37061,7 +39615,7 @@ paths: - docker - nuget - container - - &263 + - &262 name: package_name description: The name of the package. in: path @@ -37074,7 +39628,7 @@ paths: description: Response content: application/json: - schema: *260 + schema: *259 examples: default: value: @@ -37126,8 +39680,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: + - *261 - *262 - - *263 - *75 responses: '204': @@ -37160,8 +39714,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: + - *261 - *262 - - *263 - *75 - name: token description: package token @@ -37194,8 +39748,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: + - *261 - *262 - - *263 - *75 - *19 - *17 @@ -37216,7 +39770,7 @@ paths: application/json: schema: type: array - items: &264 + items: &263 title: Package Version description: A version of a software package type: object @@ -37341,10 +39895,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: + - *261 - *262 - - *263 - *75 - - &265 + - &264 name: package_version_id description: Unique identifier of the package version. in: path @@ -37356,7 +39910,7 @@ paths: description: Response content: application/json: - schema: *264 + schema: *263 examples: default: value: @@ -37392,10 +39946,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: + - *261 - *262 - - *263 - *75 - - *265 + - *264 responses: '204': description: Response @@ -37427,10 +39981,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: + - *261 - *262 - - *263 - *75 - - *265 + - *264 responses: '204': description: Response @@ -37460,7 +40014,7 @@ paths: - *75 - *17 - *19 - - &266 + - &265 name: sort description: The property by which to sort the results. in: query @@ -37471,7 +40025,7 @@ paths: - created_at default: created_at - *61 - - &267 + - &266 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -37482,7 +40036,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &268 + - &267 name: repository description: The name of the repository to use to filter the results. in: query @@ -37490,7 +40044,7 @@ paths: schema: type: string example: Hello-World - - &269 + - &268 name: permission description: The permission to use to filter the results. in: query @@ -37498,7 +40052,7 @@ paths: schema: type: string example: issues_read - - &270 + - &269 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) @@ -37508,7 +40062,7 @@ paths: schema: type: string format: date-time - - &271 + - &270 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) @@ -37518,7 +40072,7 @@ paths: schema: type: string format: date-time - - &272 + - &271 name: token_id description: The ID of the token in: query @@ -37788,7 +40342,7 @@ paths: '422': *15 '404': *6 '403': *29 - '204': *192 + '204': *191 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37829,9 +40383,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: &273 + default: &272 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -37968,14 +40522,14 @@ paths: - *75 - *17 - *19 - - *266 + - *265 - *61 + - *266 - *267 - *268 - *269 - *270 - *271 - - *272 responses: '500': *55 '422': *15 @@ -38214,7 +40768,7 @@ paths: responses: '500': *55 '404': *6 - '204': *192 + '204': *191 '403': *29 '422': *15 x-github: @@ -38255,9 +40809,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *273 + default: *272 headers: Link: *67 x-github: @@ -38299,7 +40853,7 @@ paths: type: integer configurations: type: array - items: &274 + items: &273 title: Organization private registry description: Private registry configuration for an organization type: object @@ -38727,7 +41281,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &275 + org-private-registry-with-selected-visibility: &274 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -38817,15 +41371,15 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - *75 - - *169 + - *168 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *274 + schema: *273 examples: - default: *275 + default: *274 '404': *6 x-github: githubCloudOnly: false @@ -38848,7 +41402,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -39012,7 +41566,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - *75 - - *169 + - *168 responses: '204': description: Response @@ -39052,7 +41606,7 @@ paths: application/json: schema: type: array - items: &276 + items: &275 title: Projects v2 Project description: A projects v2 project type: object @@ -39122,7 +41676,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &783 + properties: &782 id: type: number description: The unique identifier of the status update. @@ -39170,7 +41724,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &784 + required: &783 - id - node_id - created_at @@ -39195,7 +41749,7 @@ paths: - deleted_at - deleted_by examples: - default: &277 + default: &276 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -39298,7 +41852,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &278 + - &277 name: project_number description: The project's number. in: path @@ -39311,9 +41865,9 @@ paths: description: Response content: application/json: - schema: *276 + schema: *275 examples: - default: *277 + default: *276 headers: Link: *67 '304': *37 @@ -39336,7 +41890,7 @@ paths: url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - *75 - - *278 + - *277 requestBody: required: true description: Details of the draft item to create in the project. @@ -39370,7 +41924,7 @@ paths: description: Response content: application/json: - schema: &284 + schema: &283 title: Projects v2 Item description: An item belonging to a project type: object @@ -39384,7 +41938,7 @@ paths: content: oneOf: - *85 - - &480 + - &479 title: Pull Request Simple description: Pull Request Simple type: object @@ -39490,8 +42044,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *279 - required: *280 + properties: *278 + required: *279 nullable: true active_lock_reason: type: string @@ -39523,7 +42077,7 @@ paths: items: *4 requested_teams: type: array - items: *198 + items: *197 head: type: object properties: @@ -39573,7 +42127,7 @@ paths: _links: type: object properties: - comments: &281 + comments: &280 title: Link description: Hypermedia Link type: object @@ -39582,13 +42136,13 @@ paths: type: string required: - href - commits: *281 - statuses: *281 - html: *281 - issue: *281 - review_comments: *281 - review_comment: *281 - self: *281 + commits: *280 + statuses: *280 + html: *280 + issue: *280 + review_comments: *280 + review_comment: *280 + self: *280 required: - comments - commits @@ -39599,7 +42153,7 @@ paths: - review_comment - self author_association: *82 - auto_merge: &589 + auto_merge: &588 title: Auto merge description: The status of auto merging a pull request. type: object @@ -39699,7 +42253,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &283 + content_type: &282 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -39739,7 +42293,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &285 + draft_issue: &284 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -39813,7 +42367,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *278 + - *277 - *75 - *17 - *47 @@ -39825,7 +42379,7 @@ paths: application/json: schema: type: array - items: &282 + items: &281 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -39975,7 +42529,7 @@ paths: - updated_at - project_url examples: - default: &714 + default: &713 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -40105,7 +42659,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project parameters: - - *278 + - *277 - *75 requestBody: required: true @@ -40152,7 +42706,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &715 + items: &714 type: object properties: name: @@ -40189,7 +42743,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &716 + iteration_configuration: &715 type: object description: The configuration for iteration fields. properties: @@ -40239,7 +42793,7 @@ paths: value: name: Due date data_type: date - single_select_field: &717 + single_select_field: &716 summary: Create a single select field value: name: Priority @@ -40266,7 +42820,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &718 + iteration_field: &717 summary: Create an iteration field value: name: Sprint @@ -40290,9 +42844,9 @@ paths: description: Response for adding a field to an organization-owned project. content: application/json: - schema: *282 + schema: *281 examples: - text_field: &719 + text_field: &718 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -40301,7 +42855,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: &720 + number_field: &719 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -40310,7 +42864,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: &721 + date_field: &720 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -40319,7 +42873,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: &722 + single_select_field: &721 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -40353,7 +42907,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &723 + iteration_field: &722 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -40398,8 +42952,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *278 - - &724 + - *277 + - &723 name: field_id description: The unique identifier of the field. in: path @@ -40412,9 +42966,9 @@ paths: description: Response content: application/json: - schema: *282 + schema: *281 examples: - default: &725 + default: &724 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -40470,7 +43024,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *278 + - *277 - *75 - 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) @@ -40503,7 +43057,7 @@ paths: application/json: schema: type: array - items: &286 + items: &285 title: Projects v2 Item description: An item belonging to a project type: object @@ -40519,7 +43073,7 @@ paths: format: uri example: https://api.github.com/users/monalisa/2/projectsV2/3 description: The API URL of the project that contains this item. - content_type: *283 + content_type: *282 content: type: object additionalProperties: true @@ -40562,7 +43116,7 @@ paths: - updated_at - archived_at examples: - default: &287 + default: &286 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -41260,7 +43814,7 @@ paths: url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - *75 - - *278 + - *277 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -41330,22 +43884,22 @@ paths: description: Response content: application/json: - schema: *284 + schema: *283 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *285 + value: *284 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *285 + value: *284 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *285 + value: *284 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *285 + value: *284 '304': *37 '403': *29 '401': *25 @@ -41365,9 +43919,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *278 + - *277 - *75 - - &288 + - &287 name: item_id description: The unique identifier of the project item. in: path @@ -41393,9 +43947,9 @@ paths: description: Response content: application/json: - schema: *286 + schema: *285 examples: - default: *287 + default: *286 headers: Link: *67 '304': *37 @@ -41416,9 +43970,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *278 + - *277 - *75 - - *288 + - *287 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -41488,13 +44042,13 @@ paths: description: Response content: application/json: - schema: *286 + schema: *285 examples: - text_field: *287 - number_field: *287 - date_field: *287 - single_select_field: *287 - iteration_field: *287 + text_field: *286 + number_field: *286 + date_field: *286 + single_select_field: *286 + iteration_field: *286 '401': *25 '403': *29 '404': *6 @@ -41514,9 +44068,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *278 + - *277 - *75 - - *288 + - *287 responses: '204': description: Response @@ -41540,7 +44094,7 @@ paths: url: https://docs.github.com/rest/projects/views#create-a-view-for-an-organization-owned-project parameters: - *75 - - *278 + - *277 requestBody: required: true content: @@ -41611,7 +44165,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &706 + schema: &705 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -41709,7 +44263,7 @@ paths: examples: table_view: summary: Response for creating a table view - value: &289 + value: &288 value: id: 1 number: 1 @@ -41755,10 +44309,10 @@ paths: - 456 board_view: summary: Response for creating a board view with filter - value: *289 + value: *288 roadmap_view: summary: Response for creating a roadmap view - value: *289 + value: *288 '304': *37 '403': *29 '401': *25 @@ -41786,9 +44340,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-project-view parameters: - - *278 + - *277 - *75 - - &726 + - &725 name: view_number description: The number that identifies the project view. in: path @@ -41820,9 +44374,9 @@ paths: application/json: schema: type: array - items: *286 + items: *285 examples: - default: *287 + default: *286 headers: Link: *67 '304': *37 @@ -41855,7 +44409,7 @@ paths: application/json: schema: type: array - items: &290 + items: &289 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -41923,7 +44477,7 @@ paths: - property_name - value_type examples: - default: &291 + default: &290 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -41983,7 +44537,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *290 + items: *289 minItems: 1 maxItems: 100 required: @@ -42013,9 +44567,9 @@ paths: application/json: schema: type: array - items: *290 + items: *289 examples: - default: *291 + default: *290 '403': *29 '404': *6 x-github: @@ -42037,7 +44591,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - *75 - - &292 + - &291 name: custom_property_name description: The custom property name in: path @@ -42049,9 +44603,9 @@ paths: description: Response content: application/json: - schema: *290 + schema: *289 examples: - default: &293 + default: &292 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -42086,7 +44640,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - *75 - - *292 + - *291 requestBody: required: true content: @@ -42157,9 +44711,9 @@ paths: description: Response content: application/json: - schema: *290 + schema: *289 examples: - default: *293 + default: *292 '403': *29 '404': *6 x-github: @@ -42183,9 +44737,9 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - *75 - - *292 + - *291 responses: - '204': *192 + '204': *191 '403': *29 '404': *6 x-github: @@ -42244,7 +44798,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &294 + items: &293 title: Custom Property Value description: Custom property name and associated value type: object @@ -42331,7 +44885,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *294 + items: *293 required: - repository_names - properties @@ -42521,9 +45075,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *273 + default: *272 headers: Link: *67 x-github: @@ -42725,7 +45279,7 @@ paths: description: Response content: application/json: - schema: &345 + schema: &344 title: Full Repository description: Full Repository type: object @@ -43010,8 +45564,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *295 - required: *296 + properties: *294 + required: *295 nullable: true temp_clone_token: type: string @@ -43123,7 +45677,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &485 + properties: &484 url: type: string format: uri @@ -43139,12 +45693,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &486 + required: &485 - url - key - name - html_url - security_and_analysis: *297 + security_and_analysis: *296 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -43228,7 +45782,7 @@ paths: - network_count - subscribers_count examples: - default: &347 + default: &346 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -43750,7 +46304,7 @@ paths: - *75 - *17 - *19 - - &611 + - &610 name: targets description: | A comma-separated list of rule targets to filter by. @@ -43768,7 +46322,7 @@ paths: application/json: schema: type: array - items: &324 + items: &323 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -43803,7 +46357,7 @@ paths: source: type: string description: The name of the source - enforcement: &300 + enforcement: &299 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -43816,7 +46370,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &301 + items: &300 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -43886,7 +46440,7 @@ paths: conditions: nullable: true anyOf: - - &298 + - &297 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -43910,7 +46464,7 @@ paths: match. items: type: string - - &302 + - &301 title: Organization ruleset conditions type: object description: |- @@ -43924,7 +46478,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *298 + - *297 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -43958,7 +46512,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *298 + - *297 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -43980,7 +46534,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *298 + - *297 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -43993,7 +46547,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &299 + items: &298 title: Repository ruleset property targeting definition type: object @@ -44026,17 +46580,17 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *299 + items: *298 required: - repository_property rules: type: array - items: &612 + items: &611 title: Repository Rule type: object description: A repository rule. oneOf: - - &303 + - &302 title: creation description: Only allow users with bypass permission to create matching refs. @@ -44048,7 +46602,7 @@ paths: type: string enum: - creation - - &304 + - &303 title: update description: Only allow users with bypass permission to update matching refs. @@ -44069,7 +46623,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &305 + - &304 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -44081,7 +46635,7 @@ paths: type: string enum: - deletion - - &306 + - &305 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -44093,7 +46647,7 @@ paths: type: string enum: - required_linear_history - - &610 + - &609 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -44171,7 +46725,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &307 + - &306 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -44195,7 +46749,7 @@ paths: type: string required: - required_deployment_environments - - &308 + - &307 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -44207,7 +46761,7 @@ paths: type: string enum: - required_signatures - - &309 + - &308 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -44313,7 +46867,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &310 + - &309 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -44361,7 +46915,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &311 + - &310 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -44373,7 +46927,7 @@ paths: type: string enum: - non_fast_forward - - &312 + - &311 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -44410,7 +46964,7 @@ paths: required: - operator - pattern - - &313 + - &312 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -44447,7 +47001,7 @@ paths: required: - operator - pattern - - &314 + - &313 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -44484,7 +47038,7 @@ paths: required: - operator - pattern - - &315 + - &314 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -44521,7 +47075,7 @@ paths: required: - operator - pattern - - &316 + - &315 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -44558,7 +47112,7 @@ paths: required: - operator - pattern - - &317 + - &316 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -44583,7 +47137,7 @@ paths: type: string required: - restricted_file_paths - - &318 + - &317 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -44607,7 +47161,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &319 + - &318 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -44630,7 +47184,7 @@ paths: type: string required: - restricted_file_extensions - - &320 + - &319 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -44655,7 +47209,7 @@ paths: maximum: 100 required: - max_file_size - - &321 + - &320 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -44705,7 +47259,7 @@ paths: - repository_id required: - workflows - - &322 + - &321 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -44766,7 +47320,7 @@ paths: - tool required: - code_scanning_tools - - &323 + - &322 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -44865,20 +47419,21 @@ paths: - push - repository default: branch - enforcement: *300 + enforcement: *299 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *301 - conditions: *302 + items: *300 + conditions: *301 rules: type: array description: An array of rules within the ruleset. - items: &326 + items: &325 title: Repository Rule type: object description: A repository rule. oneOf: + - *302 - *303 - *304 - *305 @@ -44899,7 +47454,6 @@ paths: - *320 - *321 - *322 - - *323 required: - name - enforcement @@ -44937,9 +47491,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *323 examples: - default: &325 + default: &324 value: id: 21 name: super cool ruleset @@ -44995,7 +47549,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *75 - - &613 + - &612 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 @@ -45010,7 +47564,7 @@ paths: in: query schema: type: string - - &614 + - &613 name: time_period description: |- The time period to filter by. @@ -45026,14 +47580,14 @@ paths: - week - month default: day - - &615 + - &614 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 - - &616 + - &615 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -45053,7 +47607,7 @@ paths: description: Response content: application/json: - schema: &617 + schema: &616 title: Rule Suites description: Response type: array @@ -45108,7 +47662,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &618 + default: &617 value: - id: 21 actor_id: 12 @@ -45152,7 +47706,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *75 - - &619 + - &618 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -45168,7 +47722,7 @@ paths: description: Response content: application/json: - schema: &620 + schema: &619 title: Rule Suite description: Response type: object @@ -45267,7 +47821,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &621 + default: &620 value: id: 21 actor_id: 12 @@ -45340,9 +47894,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *323 examples: - default: *325 + default: *324 '404': *6 '500': *55 put: @@ -45386,16 +47940,16 @@ paths: - tag - push - repository - enforcement: *300 + enforcement: *299 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *301 - conditions: *302 + items: *300 + conditions: *301 rules: description: An array of rules within the ruleset. type: array - items: *326 + items: *325 examples: default: value: @@ -45430,9 +47984,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *323 examples: - default: *325 + default: *324 '404': *6 '422': *15 '500': *55 @@ -45490,7 +48044,7 @@ paths: application/json: schema: type: array - items: &327 + items: &326 title: Ruleset version type: object description: The historical version of a ruleset @@ -45514,7 +48068,7 @@ paths: type: string format: date-time examples: - default: &623 + default: &622 value: - version_id: 3 actor: @@ -45567,9 +48121,9 @@ paths: description: Response content: application/json: - schema: &624 + schema: &623 allOf: - - *327 + - *326 - type: object required: - state @@ -45639,7 +48193,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *75 - - &625 + - &624 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -45650,7 +48204,7 @@ paths: enum: - open - resolved - - &626 + - &625 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -45660,7 +48214,7 @@ paths: required: false schema: type: string - - &627 + - &626 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -45669,7 +48223,7 @@ paths: required: false schema: type: string - - &628 + - &627 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -45688,7 +48242,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &629 + - &628 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. @@ -45703,7 +48257,7 @@ paths: - *61 - *19 - *17 - - &630 + - &629 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 @@ -45713,7 +48267,7 @@ paths: required: false schema: type: string - - &631 + - &630 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 @@ -45723,7 +48277,7 @@ paths: required: false schema: type: string - - &632 + - &631 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -45732,7 +48286,7 @@ paths: required: false schema: type: string - - &633 + - &632 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -45741,7 +48295,7 @@ paths: schema: type: boolean default: false - - &634 + - &633 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -45750,7 +48304,7 @@ paths: schema: type: boolean default: false - - &635 + - &634 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -45769,8 +48323,8 @@ paths: items: type: object properties: - number: *179 - created_at: *180 + number: *178 + created_at: *179 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -45778,21 +48332,21 @@ paths: format: date-time readOnly: true nullable: true - url: *182 - html_url: *183 + url: *181 + html_url: *182 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &636 + state: &635 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: &637 + resolution: &636 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -45899,8 +48453,8 @@ paths: pull request. ' - oneOf: &638 - - &640 + oneOf: &637 + - &639 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -45942,6 +48496,12 @@ 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. + example: https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1 required: - path - start_line @@ -45952,7 +48512,7 @@ paths: - blob_url - commit_sha - commit_url - - &641 + - &640 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. @@ -46007,7 +48567,7 @@ paths: - page_url - commit_sha - commit_url - - &642 + - &641 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -46019,9 +48579,15 @@ paths: description: The API URL to get the issue where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &643 + - &642 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -46033,9 +48599,15 @@ paths: description: The API URL to get the issue where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &644 + - &643 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -46047,9 +48619,15 @@ paths: description: The API URL to get the issue comment where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &645 + - &644 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -46063,7 +48641,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &646 + - &645 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -46077,7 +48655,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &647 + - &646 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -46091,7 +48669,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &648 + - &647 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. @@ -46103,9 +48681,15 @@ paths: description: The API URL to get the pull request where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &649 + - &648 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. @@ -46117,9 +48701,15 @@ paths: description: The API URL to get the pull request where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &650 + - &649 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. @@ -46131,9 +48721,15 @@ paths: description: The API URL to get the pull request comment where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &651 + - &650 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. @@ -46145,9 +48741,15 @@ paths: description: The API URL to get the pull request review where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &652 + - &651 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -46159,6 +48761,12 @@ paths: description: The API URL to get the pull request review comment where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846#discussion_r12 required: - pull_request_review_comment_url nullable: true @@ -46389,7 +48997,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &329 + pattern_config_version: &328 type: string description: The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate @@ -46398,7 +49006,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &328 + items: &327 type: object properties: token_type: @@ -46464,7 +49072,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *328 + items: *327 examples: default: value: @@ -46521,7 +49129,7 @@ paths: schema: type: object properties: - pattern_config_version: *329 + pattern_config_version: *328 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -46547,7 +49155,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *329 + custom_pattern_version: *328 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -46645,7 +49253,7 @@ paths: application/json: schema: type: array - items: &656 + items: &655 description: A repository security advisory. type: object properties: @@ -46847,7 +49455,7 @@ paths: login: type: string description: The username of the user credited. - type: *330 + type: *329 credits_detailed: type: array nullable: true @@ -46857,7 +49465,7 @@ paths: type: object properties: user: *4 - type: *330 + type: *329 state: type: string description: The state of the user's acceptance of the @@ -46881,7 +49489,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *198 + items: *197 private_fork: readOnly: true nullable: true @@ -46917,7 +49525,7 @@ paths: - private_fork additionalProperties: false examples: - default: &657 + default: &656 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -47304,7 +49912,7 @@ paths: application/json: schema: type: array - items: *331 + items: *330 examples: default: value: @@ -47522,9 +50130,9 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 examples: - default: *173 + default: *172 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47593,7 +50201,7 @@ paths: url: https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *75 - - *150 + - *149 responses: '204': description: Response @@ -47616,7 +50224,7 @@ paths: url: https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *75 - - *150 + - *149 responses: '204': description: Response @@ -47657,7 +50265,7 @@ paths: type: integer network_configurations: type: array - items: &332 + items: &331 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -47775,6 +50383,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 @@ -47790,9 +50411,9 @@ paths: description: Response content: application/json: - schema: *332 + schema: *331 examples: - default: &333 + default: &332 value: id: 123456789ABCDEF name: My network configuration @@ -47821,7 +50442,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - *75 - - &334 + - &333 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -47833,9 +50454,9 @@ paths: description: Response content: application/json: - schema: *332 + schema: *331 examples: - default: *333 + default: *332 headers: Link: *67 x-github: @@ -47857,7 +50478,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - *75 - - *334 + - *333 requestBody: required: true content: @@ -47885,6 +50506,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: @@ -47897,9 +50531,9 @@ paths: description: Response content: application/json: - schema: *332 + schema: *331 examples: - default: *333 + default: *332 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47919,7 +50553,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - *75 - - *334 + - *333 responses: '204': description: Response @@ -48059,13 +50693,13 @@ paths: application/json: schema: type: array - items: *335 + items: *334 examples: - default: *336 + default: *335 '500': *55 '403': *29 '404': *6 - '422': *337 + '422': *336 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48105,9 +50739,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *259 + default: *258 headers: Link: *67 '403': *29 @@ -48193,7 +50827,7 @@ paths: description: Response content: application/json: - schema: &338 + schema: &337 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -48256,8 +50890,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *257 - required: *258 + properties: *256 + required: *257 nullable: true members_count: type: integer @@ -48520,7 +51154,7 @@ paths: - repos_count - organization examples: - default: &339 + default: &338 value: id: 1 node_id: MDQ6VGVhbTE= @@ -48597,9 +51231,9 @@ paths: description: Response content: application/json: - schema: *338 + schema: *337 examples: - default: *339 + default: *338 '404': *6 x-github: githubCloudOnly: false @@ -48683,16 +51317,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *338 + schema: *337 examples: - default: *339 + default: *338 '201': description: Response content: application/json: - schema: *338 + schema: *337 examples: - default: *339 + default: *338 '404': *6 '422': *15 '403': *29 @@ -48722,7 +51356,7 @@ paths: responses: '204': description: Response - '422': &340 + '422': &339 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -48756,12 +51390,12 @@ paths: application/json: schema: type: array - items: *236 + items: *235 examples: - default: *237 + default: *236 headers: Link: *67 - '422': *340 + '422': *339 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48843,7 +51477,7 @@ paths: description: Response content: application/json: - schema: &341 + schema: &340 title: Team Membership description: Team Membership type: object @@ -48870,7 +51504,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &673 + response-if-user-is-a-team-maintainer: &672 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -48933,9 +51567,9 @@ paths: description: Response content: application/json: - schema: *341 + schema: *340 examples: - response-if-users-membership-with-team-is-now-pending: &674 + response-if-users-membership-with-team-is-now-pending: &673 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -49009,9 +51643,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *273 + default: *272 headers: Link: *67 x-github: @@ -49042,14 +51676,14 @@ paths: parameters: - *75 - *77 + - *341 - *342 - - *343 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &675 + schema: &674 title: Team Repository description: A team's access to a repository. type: object @@ -49614,8 +52248,8 @@ paths: parameters: - *75 - *77 + - *341 - *342 - - *343 requestBody: required: false content: @@ -49662,8 +52296,8 @@ paths: parameters: - *75 - *77 + - *341 - *342 - - *343 responses: '204': description: Response @@ -49698,9 +52332,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - response-if-child-teams-exist: &676 + response-if-child-teams-exist: &675 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -49854,7 +52488,7 @@ paths: resources: type: object properties: - core: &344 + core: &343 title: Rate Limit type: object properties: @@ -49871,17 +52505,17 @@ paths: - remaining - reset - used - graphql: *344 - search: *344 - code_search: *344 - source_import: *344 - integration_manifest: *344 - code_scanning_upload: *344 - actions_runner_registration: *344 - scim: *344 - dependency_snapshots: *344 - dependency_sbom: *344 - code_scanning_autofix: *344 + graphql: *343 + search: *343 + code_search: *343 + source_import: *343 + integration_manifest: *343 + code_scanning_upload: *343 + actions_runner_registration: *343 + scim: *343 + dependency_snapshots: *343 + dependency_sbom: *343 + code_scanning_autofix: *343 required: - core - search @@ -49988,14 +52622,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *345 + schema: *344 examples: default-response: summary: Default response @@ -50500,7 +53134,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *346 + '301': *345 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50518,8 +53152,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: + - *341 - *342 - - *343 requestBody: required: false content: @@ -50810,10 +53444,10 @@ paths: description: Response content: application/json: - schema: *345 + schema: *344 examples: - default: *347 - '307': &348 + default: *346 + '307': &347 description: Temporary Redirect content: application/json: @@ -50842,8 +53476,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -50865,7 +53499,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *348 + '307': *347 '404': *6 '409': *54 x-github: @@ -50889,11 +53523,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: + - *341 - *342 - - *343 - *17 - *19 - - &381 + - &380 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -50916,7 +53550,7 @@ paths: type: integer artifacts: type: array - items: &349 + items: &348 title: Artifact description: An artifact type: object @@ -50994,7 +53628,7 @@ paths: - expires_at - updated_at examples: - default: &382 + default: &381 value: total_count: 2 artifacts: @@ -51055,9 +53689,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: + - *341 - *342 - - *343 - - &350 + - &349 name: artifact_id description: The unique identifier of the artifact. in: path @@ -51069,7 +53703,7 @@ paths: description: Response content: application/json: - schema: *349 + schema: *348 examples: default: value: @@ -51107,9 +53741,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: + - *341 - *342 - - *343 - - *350 + - *349 responses: '204': description: Response @@ -51133,9 +53767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: + - *341 - *342 - - *343 - - *350 + - *349 - name: archive_format in: path required: true @@ -51149,7 +53783,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': &542 + '410': &541 description: Gone content: application/json: @@ -51174,14 +53808,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: &351 + schema: &350 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -51214,13 +53848,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: + - *341 - *342 - - *343 requestBody: required: true content: application/json: - schema: *351 + schema: *350 examples: selected_actions: *42 responses: @@ -51249,14 +53883,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: &352 + schema: &351 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -51289,13 +53923,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: + - *341 - *342 - - *343 requestBody: required: true content: application/json: - schema: *352 + schema: *351 examples: selected_actions: *44 responses: @@ -51326,14 +53960,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *353 + schema: *352 examples: default: value: @@ -51359,11 +53993,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: + - *341 - *342 - - *343 - *17 - *19 - - &354 + - &353 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 @@ -51397,7 +54031,7 @@ paths: description: Response content: application/json: - schema: &355 + schema: &354 title: Repository actions caches description: Repository actions caches type: object @@ -51439,7 +54073,7 @@ paths: - total_count - actions_caches examples: - default: &356 + default: &355 value: total_count: 1 actions_caches: @@ -51471,23 +54105,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: + - *341 - *342 - - *343 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *354 + - *353 responses: '200': description: Response content: application/json: - schema: *355 + schema: *354 examples: - default: *356 + default: *355 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51507,8 +54141,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: + - *341 - *342 - - *343 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -51539,9 +54173,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: + - *341 - *342 - - *343 - - &357 + - &356 name: job_id description: The unique identifier of the job. in: path @@ -51553,7 +54187,7 @@ paths: description: Response content: application/json: - schema: &385 + schema: &384 title: Job description: Information of a job execution in a workflow run type: object @@ -51860,9 +54494,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: + - *341 - *342 - - *343 - - *357 + - *356 responses: '302': description: Response @@ -51890,9 +54524,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: + - *341 - *342 - - *343 - - *357 + - *356 requestBody: required: false content: @@ -51913,7 +54547,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -51937,8 +54571,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: + - *341 - *342 - - *343 responses: '200': description: Status response @@ -51988,8 +54622,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: + - *341 - *342 - - *343 requestBody: required: true content: @@ -52023,7 +54657,7 @@ paths: description: Empty response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -52052,8 +54686,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -52071,7 +54705,7 @@ paths: type: integer secrets: type: array - items: &387 + items: &386 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -52091,7 +54725,7 @@ paths: - created_at - updated_at examples: - default: &388 + default: &387 value: total_count: 2 secrets: @@ -52124,9 +54758,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: + - *341 - *342 - - *343 - - *358 + - *357 - *19 responses: '200': @@ -52143,7 +54777,7 @@ paths: type: integer variables: type: array - items: &391 + items: &390 title: Actions Variable type: object properties: @@ -52173,7 +54807,7 @@ paths: - created_at - updated_at examples: - default: &392 + default: &391 value: total_count: 2 variables: @@ -52206,8 +54840,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -52216,12 +54850,12 @@ paths: schema: type: object properties: - enabled: &360 + enabled: &359 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *146 - selected_actions_url: *359 - sha_pinning_required: *147 + allowed_actions: *145 + selected_actions_url: *358 + sha_pinning_required: *146 required: - enabled examples: @@ -52249,8 +54883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -52261,9 +54895,9 @@ paths: schema: type: object properties: - enabled: *360 - allowed_actions: *146 - sha_pinning_required: *147 + enabled: *359 + allowed_actions: *145 + sha_pinning_required: *146 required: - enabled examples: @@ -52293,14 +54927,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: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: &361 + schema: &360 type: object properties: access_level: @@ -52317,7 +54951,7 @@ paths: required: - access_level examples: - default: &362 + default: &361 value: access_level: organization x-github: @@ -52341,15 +54975,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: + - *341 - *342 - - *343 requestBody: required: true content: application/json: - schema: *361 + schema: *360 examples: - default: *362 + default: *361 responses: '204': description: Response @@ -52373,14 +55007,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *363 + schema: *362 examples: default: value: @@ -52404,8 +55038,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: + - *341 - *342 - - *343 responses: '204': description: Empty response for successful settings update @@ -52415,7 +55049,7 @@ paths: required: true content: application/json: - schema: *364 + schema: *363 examples: default: summary: Set retention days @@ -52439,16 +55073,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *148 + schema: *147 examples: - default: *365 + default: *364 '404': *6 x-github: enabledForGitHubApps: true @@ -52467,8 +55101,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -52478,7 +55112,7 @@ paths: required: true content: application/json: - schema: *148 + schema: *147 examples: default: summary: Set approval policy to first time contributors @@ -52502,16 +55136,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: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *366 + schema: *365 examples: - default: *149 + default: *148 '403': *29 '404': *6 x-github: @@ -52531,15 +55165,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: + - *341 - *342 - - *343 requestBody: required: true content: application/json: - schema: *367 + schema: *366 examples: - default: *149 + default: *148 responses: '204': description: Empty response for successful settings update @@ -52563,16 +55197,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *151 + schema: *150 examples: - default: *152 + default: *151 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52591,8 +55225,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -52600,9 +55234,9 @@ paths: required: false content: application/json: - schema: *151 + schema: *150 examples: - selected_actions: *152 + selected_actions: *151 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52624,16 +55258,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *368 + schema: *367 examples: - default: *156 + default: *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52654,8 +55288,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: + - *341 - *342 - - *343 responses: '204': description: Success response @@ -52666,9 +55300,9 @@ paths: required: true content: application/json: - schema: *369 + schema: *368 examples: - default: *156 + default: *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52695,8 +55329,8 @@ paths: in: query schema: type: string + - *341 - *342 - - *343 - *17 - *19 responses: @@ -52714,9 +55348,9 @@ paths: type: integer runners: type: array - items: *163 + items: *162 examples: - default: *164 + default: *163 headers: Link: *67 x-github: @@ -52740,8 +55374,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -52749,9 +55383,9 @@ paths: application/json: schema: type: array - items: *370 + items: *369 examples: - default: *371 + default: *370 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52773,8 +55407,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: + - *341 - *342 - - *343 requestBody: required: true content: @@ -52817,7 +55451,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *372 + '201': *371 '404': *6 '422': *7 '409': *54 @@ -52848,16 +55482,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: + - *341 - *342 - - *343 responses: '201': description: Response content: application/json: - schema: *165 + schema: *164 examples: - default: *373 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52885,16 +55519,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: + - *341 - *342 - - *343 responses: '201': description: Response content: application/json: - schema: *165 + schema: *164 examples: - default: *374 + default: *373 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52916,17 +55550,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: + - *341 - *342 - - *343 - - *162 + - *161 responses: '200': description: Response content: application/json: - schema: *163 + schema: *162 examples: - default: *375 + default: *374 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52947,9 +55581,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: + - *341 - *342 - - *343 - - *162 + - *161 responses: '204': description: Response @@ -52975,11 +55609,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: + - *341 - *342 - - *343 - - *162 + - *161 responses: - '200': *167 + '200': *166 '404': *6 x-github: githubCloudOnly: false @@ -53001,9 +55635,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: + - *341 - *342 - - *343 - - *162 + - *161 requestBody: required: true content: @@ -53027,7 +55661,7 @@ paths: - gpu - accelerated responses: - '200': *167 + '200': *166 '404': *6 '422': *7 x-github: @@ -53051,9 +55685,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: + - *341 - *342 - - *343 - - *162 + - *161 requestBody: required: true content: @@ -53078,7 +55712,7 @@ paths: - gpu - accelerated responses: - '200': *167 + '200': *166 '404': *6 '422': *7 x-github: @@ -53102,11 +55736,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: + - *341 - *342 - - *343 - - *162 + - *161 responses: - '200': *376 + '200': *375 '404': *6 x-github: githubCloudOnly: false @@ -53133,12 +55767,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: + - *341 - *342 - - *343 - - *162 - - *377 + - *161 + - *376 responses: - '200': *167 + '200': *166 '404': *6 '422': *7 x-github: @@ -53164,9 +55798,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: + - *341 - *342 - - *343 - - &395 + - &394 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. @@ -53174,7 +55808,7 @@ paths: required: false schema: type: string - - &396 + - &395 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -53182,7 +55816,7 @@ paths: required: false schema: type: string - - &397 + - &396 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -53191,7 +55825,7 @@ paths: required: false schema: type: string - - &398 + - &397 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 @@ -53218,7 +55852,7 @@ paths: - pending - *17 - *19 - - &399 + - &398 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)." @@ -53227,7 +55861,7 @@ paths: schema: type: string format: date-time - - &378 + - &377 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -53236,13 +55870,13 @@ paths: schema: type: boolean default: false - - &400 + - &399 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &401 + - &400 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -53265,7 +55899,7 @@ paths: type: integer workflow_runs: type: array - items: &379 + items: &378 title: Workflow Run description: An invocation of a workflow type: object @@ -53413,7 +56047,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &423 + properties: &422 id: type: string description: SHA for the commit @@ -53464,7 +56098,7 @@ paths: - name - email nullable: true - required: &424 + required: &423 - id - tree_id - message @@ -53472,8 +56106,8 @@ paths: - author - committer nullable: true - repository: *161 - head_repository: *161 + repository: *160 + head_repository: *160 head_repository_id: type: integer example: 5 @@ -53511,7 +56145,7 @@ paths: - workflow_url - pull_requests examples: - default: &402 + default: &401 value: total_count: 1 workflow_runs: @@ -53747,24 +56381,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: + - *341 - *342 - - *343 - - &380 + - &379 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *378 + - *377 responses: '200': description: Response content: application/json: - schema: *379 + schema: *378 examples: - default: &383 + default: &382 value: id: 30433642 name: Build @@ -54005,9 +56639,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: + - *341 - *342 - - *343 - - *380 + - *379 responses: '204': description: Response @@ -54030,9 +56664,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: + - *341 - *342 - - *343 - - *380 + - *379 responses: '200': description: Response @@ -54151,15 +56785,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: + - *341 - *342 - - *343 - - *380 + - *379 responses: '201': description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -54186,12 +56820,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: + - *341 - *342 - - *343 - - *380 + - *379 - *17 - *19 - - *381 + - *380 - *61 responses: '200': @@ -54208,9 +56842,9 @@ paths: type: integer artifacts: type: array - items: *349 + items: *348 examples: - default: *382 + default: *381 headers: Link: *67 x-github: @@ -54234,25 +56868,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: + - *341 - *342 - - *343 - - *380 - - &384 + - *379 + - &383 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *378 + - *377 responses: '200': description: Response content: application/json: - schema: *379 + schema: *378 examples: - default: *383 + default: *382 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54275,10 +56909,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: + - *341 - *342 - - *343 - - *380 - - *384 + - *379 + - *383 - *17 - *19 responses: @@ -54296,9 +56930,9 @@ paths: type: integer jobs: type: array - items: *385 + items: *384 examples: - default: &386 + default: &385 value: total_count: 1 jobs: @@ -54411,10 +57045,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: + - *341 - *342 - - *343 - - *380 - - *384 + - *379 + - *383 responses: '302': description: Response @@ -54442,15 +57076,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: + - *341 - *342 - - *343 - - *380 + - *379 responses: '202': description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -54477,9 +57111,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: + - *341 - *342 - - *343 - - *380 + - *379 requestBody: required: true content: @@ -54546,15 +57180,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: + - *341 - *342 - - *343 - - *380 + - *379 responses: '202': description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -54581,9 +57215,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: + - *341 - *342 - - *343 - - *380 + - *379 - 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 @@ -54613,9 +57247,9 @@ paths: type: integer jobs: type: array - items: *385 + items: *384 examples: - default: *386 + default: *385 headers: Link: *67 x-github: @@ -54640,9 +57274,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: + - *341 - *342 - - *343 - - *380 + - *379 responses: '302': description: Response @@ -54669,9 +57303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: + - *341 - *342 - - *343 - - *380 + - *379 responses: '204': description: Response @@ -54698,9 +57332,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: + - *341 - *342 - - *343 - - *380 + - *379 responses: '200': description: Response @@ -54760,7 +57394,7 @@ paths: items: type: object properties: - type: &508 + type: &507 type: string description: The type of reviewer. enum: @@ -54770,7 +57404,7 @@ paths: reviewer: anyOf: - *4 - - *198 + - *197 required: - environment - wait_timer @@ -54845,9 +57479,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: + - *341 - *342 - - *343 - - *380 + - *379 requestBody: required: true content: @@ -54894,12 +57528,12 @@ paths: application/json: schema: type: array - items: &503 + items: &502 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &746 + properties: &745 url: type: string format: uri @@ -54984,7 +57618,7 @@ paths: nullable: true properties: *80 required: *81 - required: &747 + required: &746 - id - node_id - sha @@ -55000,7 +57634,7 @@ paths: - created_at - updated_at examples: - default: &504 + default: &503 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -55056,9 +57690,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: + - *341 - *342 - - *343 - - *380 + - *379 requestBody: required: false content: @@ -55079,7 +57713,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -55102,9 +57736,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: + - *341 - *342 - - *343 - - *380 + - *379 requestBody: required: false content: @@ -55125,7 +57759,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -55157,9 +57791,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: + - *341 - *342 - - *343 - - *380 + - *379 responses: '200': description: Response @@ -55296,8 +57930,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -55315,9 +57949,9 @@ paths: type: integer secrets: type: array - items: *387 + items: *386 examples: - default: *388 + default: *387 headers: Link: *67 x-github: @@ -55342,16 +57976,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *389 + schema: *388 examples: - default: *390 + default: *389 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55373,17 +58007,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: + - *341 - *342 - - *343 - - *169 + - *168 responses: '200': description: Response content: application/json: - schema: *387 + schema: *386 examples: - default: &521 + default: &520 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -55409,9 +58043,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: + - *341 - *342 - - *343 - - *169 + - *168 requestBody: required: true content: @@ -55442,7 +58076,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -55468,9 +58102,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: + - *341 - *342 - - *343 - - *169 + - *168 responses: '204': description: Response @@ -55495,9 +58129,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: + - *341 - *342 - - *343 - - *358 + - *357 - *19 responses: '200': @@ -55514,9 +58148,9 @@ paths: type: integer variables: type: array - items: *391 + items: *390 examples: - default: *392 + default: *391 headers: Link: *67 x-github: @@ -55539,8 +58173,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -55567,7 +58201,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -55592,17 +58226,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: + - *341 - *342 - - *343 - - *172 + - *171 responses: '200': description: Response content: application/json: - schema: *391 + schema: *390 examples: - default: &522 + default: &521 value: name: USERNAME value: octocat @@ -55628,9 +58262,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: + - *341 - *342 - - *343 - - *172 + - *171 requestBody: required: true content: @@ -55672,9 +58306,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: + - *341 - *342 - - *343 - - *172 + - *171 responses: '204': description: Response @@ -55699,8 +58333,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -55718,7 +58352,7 @@ paths: type: integer workflows: type: array - items: &393 + items: &392 title: Workflow description: A GitHub Actions workflow type: object @@ -55825,9 +58459,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: + - *341 - *342 - - *343 - - &394 + - &393 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -55842,7 +58476,7 @@ paths: description: Response content: application/json: - schema: *393 + schema: *392 examples: default: value: @@ -55875,9 +58509,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: + - *341 - *342 - - *343 - - *394 + - *393 responses: '204': description: Response @@ -55902,9 +58536,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: + - *341 - *342 - - *343 - - *394 + - *393 responses: '200': description: Response including the workflow run ID and URLs when `return_run_details` @@ -55985,9 +58619,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: + - *341 - *342 - - *343 - - *394 + - *393 responses: '204': description: Response @@ -56014,19 +58648,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: + - *341 - *342 - - *343 + - *393 - *394 - *395 - *396 - *397 - - *398 - *17 - *19 + - *398 + - *377 - *399 - - *378 - *400 - - *401 responses: '200': description: Response @@ -56042,9 +58676,9 @@ paths: type: integer workflow_runs: type: array - items: *379 + items: *378 examples: - default: *402 + default: *401 headers: Link: *67 x-github: @@ -56076,9 +58710,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: + - *341 - *342 - - *343 - - *394 + - *393 responses: '200': description: Response @@ -56139,8 +58773,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: + - *341 - *342 - - *343 - *61 - *17 - *47 @@ -56304,8 +58938,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -56342,8 +58976,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: + - *341 - *342 - - *343 - name: assignee in: path required: true @@ -56379,8 +59013,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -56490,8 +59124,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: + - *341 - *342 - - *343 - *17 - *47 - *48 @@ -56532,7 +59166,7 @@ paths: initiator: type: string examples: - default: *403 + default: *402 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56552,8 +59186,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -56561,7 +59195,7 @@ paths: application/json: schema: type: array - items: &404 + items: &403 title: Autolink reference description: An autolink reference. type: object @@ -56615,8 +59249,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -56655,9 +59289,9 @@ paths: description: response content: application/json: - schema: *404 + schema: *403 examples: - default: &405 + default: &404 value: id: 1 key_prefix: TICKET- @@ -56688,9 +59322,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: + - *341 - *342 - - *343 - - &406 + - &405 name: autolink_id description: The unique identifier of the autolink. in: path @@ -56702,9 +59336,9 @@ paths: description: Response content: application/json: - schema: *404 + schema: *403 examples: - default: *405 + default: *404 '404': *6 x-github: githubCloudOnly: false @@ -56724,9 +59358,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: + - *341 - *342 - - *343 - - *406 + - *405 responses: '204': description: Response @@ -56750,8 +59384,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: + - *341 - *342 - - *343 responses: '200': description: Response if Dependabot is enabled @@ -56799,8 +59433,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -56821,8 +59455,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -56842,8 +59476,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: + - *341 - *342 - - *343 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -56881,7 +59515,7 @@ paths: - url protected: type: boolean - protection: &408 + protection: &407 title: Branch Protection description: Branch Protection type: object @@ -56923,7 +59557,7 @@ paths: required: - contexts - checks - enforce_admins: &411 + enforce_admins: &410 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -56938,7 +59572,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &413 + required_pull_request_reviews: &412 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -56959,7 +59593,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *198 + items: *197 apps: description: The list of apps with review dismissal access. @@ -56988,7 +59622,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *198 + items: *197 apps: description: The list of apps allowed to bypass pull request requirements. @@ -57014,7 +59648,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &410 + restrictions: &409 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -57077,7 +59711,7 @@ paths: type: string teams: type: array - items: *198 + items: *197 apps: type: array items: @@ -57291,9 +59925,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: + - *341 - *342 - - *343 - - &409 + - &408 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). @@ -57307,14 +59941,14 @@ paths: description: Response content: application/json: - schema: &419 + schema: &418 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &476 + commit: &475 title: Commit description: Commit type: object @@ -57348,7 +59982,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &407 + properties: &406 name: type: string example: '"Chris Wanstrath"' @@ -57364,7 +59998,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *407 + properties: *406 nullable: true message: type: string @@ -57385,7 +60019,7 @@ paths: required: - sha - url - verification: &528 + verification: &527 title: Verification type: object properties: @@ -57419,12 +60053,12 @@ paths: nullable: true oneOf: - *4 - - *170 + - *169 committer: nullable: true oneOf: - *4 - - *170 + - *169 parents: type: array items: @@ -57455,7 +60089,7 @@ paths: type: integer files: type: array - items: &489 + items: &488 title: Diff Entry description: Diff Entry type: object @@ -57539,7 +60173,7 @@ paths: - self protected: type: boolean - protection: *408 + protection: *407 protection_url: type: string format: uri @@ -57646,7 +60280,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *346 + '301': *345 '404': *6 x-github: githubCloudOnly: false @@ -57668,15 +60302,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response content: application/json: - schema: *408 + schema: *407 examples: default: value: @@ -57870,9 +60504,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: true content: @@ -58127,7 +60761,7 @@ paths: url: type: string format: uri - required_status_checks: &416 + required_status_checks: &415 title: Status Check Policy description: Status Check Policy type: object @@ -58203,7 +60837,7 @@ paths: items: *4 teams: type: array - items: *198 + items: *197 apps: type: array items: *5 @@ -58221,7 +60855,7 @@ paths: items: *4 teams: type: array - items: *198 + items: *197 apps: type: array items: *5 @@ -58279,7 +60913,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *410 + restrictions: *409 required_conversation_resolution: type: object properties: @@ -58391,9 +61025,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '204': description: Response @@ -58418,17 +61052,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response content: application/json: - schema: *411 + schema: *410 examples: - default: &412 + default: &411 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -58450,17 +61084,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response content: application/json: - schema: *411 + schema: *410 examples: - default: *412 + default: *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58479,9 +61113,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '204': description: Response @@ -58506,17 +61140,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response content: application/json: - schema: *413 + schema: *412 examples: - default: &414 + default: &413 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -58612,9 +61246,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: false content: @@ -58712,9 +61346,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *412 examples: - default: *414 + default: *413 '422': *15 x-github: githubCloudOnly: false @@ -58735,9 +61369,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '204': description: Response @@ -58764,17 +61398,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response content: application/json: - schema: *411 + schema: *410 examples: - default: &415 + default: &414 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -58797,17 +61431,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response content: application/json: - schema: *411 + schema: *410 examples: - default: *415 + default: *414 '404': *6 x-github: githubCloudOnly: false @@ -58827,9 +61461,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '204': description: Response @@ -58854,17 +61488,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response content: application/json: - schema: *416 + schema: *415 examples: - default: &417 + default: &416 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -58890,9 +61524,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: false content: @@ -58944,9 +61578,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *415 examples: - default: *417 + default: *416 '404': *6 '422': *15 x-github: @@ -58968,9 +61602,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '204': description: Response @@ -58994,9 +61628,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response @@ -59030,9 +61664,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: false content: @@ -59099,9 +61733,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: false content: @@ -59165,9 +61799,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: content: application/json: @@ -59233,15 +61867,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response content: application/json: - schema: *410 + schema: *409 examples: default: value: @@ -59332,9 +61966,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '204': description: Response @@ -59357,9 +61991,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response @@ -59369,7 +62003,7 @@ paths: type: array items: *5 examples: - default: &418 + default: &417 value: - id: 1 slug: octoapp @@ -59426,9 +62060,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: true content: @@ -59462,7 +62096,7 @@ paths: type: array items: *5 examples: - default: *418 + default: *417 '422': *15 x-github: githubCloudOnly: false @@ -59483,9 +62117,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: true content: @@ -59519,7 +62153,7 @@ paths: type: array items: *5 examples: - default: *418 + default: *417 '422': *15 x-github: githubCloudOnly: false @@ -59540,9 +62174,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: true content: @@ -59576,7 +62210,7 @@ paths: type: array items: *5 examples: - default: *418 + default: *417 '422': *15 x-github: githubCloudOnly: false @@ -59598,9 +62232,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response @@ -59608,9 +62242,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *259 + default: *258 '404': *6 x-github: githubCloudOnly: false @@ -59630,9 +62264,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: false content: @@ -59668,9 +62302,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *259 + default: *258 '422': *15 x-github: githubCloudOnly: false @@ -59691,9 +62325,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: false content: @@ -59729,9 +62363,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *259 + default: *258 '422': *15 x-github: githubCloudOnly: false @@ -59752,9 +62386,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: content: application/json: @@ -59789,9 +62423,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *259 + default: *258 '422': *15 x-github: githubCloudOnly: false @@ -59813,9 +62447,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: + - *341 - *342 - - *343 - - *409 + - *408 responses: '200': description: Response @@ -59849,9 +62483,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: true content: @@ -59909,9 +62543,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: true content: @@ -59969,9 +62603,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: true content: @@ -60031,9 +62665,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: + - *341 - *342 - - *343 - - *409 + - *408 requestBody: required: true content: @@ -60055,7 +62689,7 @@ paths: description: Response content: application/json: - schema: *419 + schema: *418 examples: default: value: @@ -60171,8 +62805,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -60451,7 +63085,7 @@ paths: description: Response content: application/json: - schema: &420 + schema: &419 title: CheckRun description: A check performed on the code of a given code change type: object @@ -60571,7 +63205,7 @@ paths: check. type: array items: *90 - deployment: &739 + deployment: &738 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -60851,9 +63485,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: + - *341 - *342 - - *343 - - &421 + - &420 name: check_run_id description: The unique identifier of the check run. in: path @@ -60865,9 +63499,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *419 examples: - default: &422 + default: &421 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -60967,9 +63601,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: + - *341 - *342 - - *343 - - *421 + - *420 requestBody: required: true content: @@ -61209,9 +63843,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *419 examples: - default: *422 + default: *421 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61231,9 +63865,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: + - *341 - *342 - - *343 - - *421 + - *420 - *17 - *19 responses: @@ -61328,15 +63962,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: + - *341 - *342 - - *343 - - *421 + - *420 responses: '201': description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -61374,8 +64008,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -61397,7 +64031,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &425 + schema: &424 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -61474,7 +64108,7 @@ paths: nullable: true properties: *80 required: *81 - repository: *161 + repository: *160 created_at: type: string format: date-time @@ -61483,12 +64117,12 @@ paths: type: string format: date-time nullable: true - head_commit: &767 + head_commit: &766 title: Simple Commit description: A commit. type: object - properties: *423 - required: *424 + properties: *422 + required: *423 latest_check_runs_count: type: integer check_runs_url: @@ -61516,7 +64150,7 @@ paths: - check_runs_url - pull_requests examples: - default: &426 + default: &425 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -61807,9 +64441,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *425 + schema: *424 examples: - default: *426 + default: *425 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61828,8 +64462,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -61890,7 +64524,7 @@ paths: required: - app_id - setting - repository: *161 + repository: *160 examples: default: value: @@ -62138,9 +64772,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: + - *341 - *342 - - *343 - - &427 + - &426 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -62152,9 +64786,9 @@ paths: description: Response content: application/json: - schema: *425 + schema: *424 examples: - default: *426 + default: *425 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62177,17 +64811,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: + - *341 - *342 - - *343 - - *427 - - &482 + - *426 + - &481 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &483 + - &482 name: status description: Returns check runs with the specified `status`. in: query @@ -62226,9 +64860,9 @@ paths: type: integer check_runs: type: array - items: *420 + items: *419 examples: - default: &484 + default: &483 value: total_count: 1 check_runs: @@ -62330,15 +64964,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: + - *341 - *342 - - *343 - - *427 + - *426 responses: '201': description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -62365,21 +64999,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: + - *341 - *342 - - *343 + - *427 - *428 - - *429 - *19 - *17 - - &446 + - &445 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: *430 - - &447 + schema: *429 + - &446 name: pr description: The number of the pull request for the results you want to list. in: query @@ -62404,13 +65038,13 @@ paths: be returned. in: query required: false - schema: *431 + schema: *430 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *432 + schema: *431 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -62429,14 +65063,14 @@ paths: items: type: object properties: - number: *179 - created_at: *180 - updated_at: *181 - url: *182 - html_url: *183 - instances_url: *433 - state: *188 - fixed_at: *184 + number: *178 + created_at: *179 + updated_at: *180 + url: *181 + html_url: *182 + instances_url: *432 + state: *187 + fixed_at: *183 dismissed_by: title: Simple User description: A GitHub user. @@ -62444,12 +65078,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *185 - dismissed_reason: *434 - dismissed_comment: *435 - rule: *436 - tool: *437 - most_recent_instance: *438 + dismissed_at: *184 + dismissed_reason: *433 + dismissed_comment: *434 + rule: *435 + tool: *436 + most_recent_instance: *437 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -62575,7 +65209,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &439 + '403': &438 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -62602,9 +65236,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: + - *341 - *342 - - *343 - - &440 + - &439 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -62612,23 +65246,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *179 + schema: *178 responses: '200': description: Response content: application/json: - schema: &441 + schema: &440 type: object properties: - number: *179 - created_at: *180 - updated_at: *181 - url: *182 - html_url: *183 - instances_url: *433 - state: *188 - fixed_at: *184 + number: *178 + created_at: *179 + updated_at: *180 + url: *181 + html_url: *182 + instances_url: *432 + state: *187 + fixed_at: *183 dismissed_by: title: Simple User description: A GitHub user. @@ -62636,9 +65270,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *185 - dismissed_reason: *434 - dismissed_comment: *435 + dismissed_at: *184 + dismissed_reason: *433 + dismissed_comment: *434 rule: type: object properties: @@ -62692,8 +65326,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *437 - most_recent_instance: *438 + tool: *436 + most_recent_instance: *437 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -62792,7 +65426,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *439 + '403': *438 '404': *6 '503': *121 x-github: @@ -62812,9 +65446,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: + - *341 - *342 - - *343 - - *440 + - *439 requestBody: required: true content: @@ -62829,8 +65463,8 @@ paths: enum: - open - dismissed - dismissed_reason: *434 - dismissed_comment: *435 + dismissed_reason: *433 + dismissed_comment: *434 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -62858,7 +65492,7 @@ paths: description: Response content: application/json: - schema: *441 + schema: *440 examples: default: value: @@ -62934,7 +65568,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &445 + '403': &444 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -62961,15 +65595,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: + - *341 - *342 - - *343 - - *440 + - *439 responses: '200': description: Response content: application/json: - schema: &442 + schema: &441 type: object properties: status: @@ -62995,13 +65629,13 @@ paths: - description - started_at examples: - default: &443 + default: &442 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &444 + '400': &443 description: Bad Request content: application/json: @@ -63012,7 +65646,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': *439 + '403': *438 '404': *6 '503': *121 x-github: @@ -63037,29 +65671,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: + - *341 - *342 - - *343 - - *440 + - *439 responses: '200': description: OK content: application/json: - schema: *442 + schema: *441 examples: - default: *443 + default: *442 '202': description: Accepted content: application/json: - schema: *442 + schema: *441 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *444 + '400': *443 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -63091,9 +65725,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: + - *341 - *342 - - *343 - - *440 + - *439 requestBody: required: false content: @@ -63138,8 +65772,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *444 - '403': *445 + '400': *443 + '403': *444 '404': *6 '422': description: Unprocessable Entity @@ -63163,13 +65797,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: + - *341 - *342 - - *343 - - *440 + - *439 - *19 - *17 + - *445 - *446 - - *447 responses: '200': description: Response @@ -63180,10 +65814,10 @@ paths: items: type: object properties: - ref: *430 - analysis_key: *448 - environment: *449 - category: *450 + ref: *429 + analysis_key: *447 + environment: *448 + category: *449 state: type: string description: State of a code scanning alert instance. @@ -63198,7 +65832,7 @@ paths: properties: text: type: string - location: *451 + location: *450 html_url: type: string classifications: @@ -63206,7 +65840,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: *452 + items: *451 examples: default: value: @@ -63243,7 +65877,7 @@ paths: end_column: 50 classifications: - source - '403': *439 + '403': *438 '404': *6 '503': *121 x-github: @@ -63277,25 +65911,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: + - *341 - *342 - - *343 + - *427 - *428 - - *429 - *19 - *17 - - *447 + - *446 - 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: *430 + schema: *429 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &453 + schema: &452 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -63316,23 +65950,23 @@ paths: application/json: schema: type: array - items: &454 + items: &453 type: object properties: - ref: *430 - commit_sha: &462 + ref: *429 + commit_sha: &461 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: *448 + analysis_key: *447 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *450 + category: *449 error: type: string example: error reading field xyz @@ -63356,8 +65990,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *453 - tool: *437 + sarif_id: *452 + tool: *436 deletable: type: boolean warning: @@ -63418,7 +66052,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *439 + '403': *438 '404': *6 '503': *121 x-github: @@ -63454,8 +66088,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: + - *341 - *342 - - *343 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -63468,7 +66102,7 @@ paths: description: Response content: application/json: - schema: *454 + schema: *453 examples: response: summary: application/json response @@ -63522,7 +66156,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *439 + '403': *438 '404': *6 '422': description: Response if analysis could not be processed @@ -63609,8 +66243,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: + - *341 - *342 - - *343 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -63663,7 +66297,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': *445 + '403': *444 '404': *6 '503': *121 x-github: @@ -63685,8 +66319,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -63694,7 +66328,7 @@ paths: application/json: schema: type: array - items: &455 + items: &454 title: CodeQL Database description: A CodeQL database. type: object @@ -63805,7 +66439,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': *439 + '403': *438 '404': *6 '503': *121 x-github: @@ -63834,8 +66468,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: + - *341 - *342 - - *343 - name: language in: path description: The language of the CodeQL database. @@ -63847,7 +66481,7 @@ paths: description: Response content: application/json: - schema: *455 + schema: *454 examples: default: value: @@ -63879,9 +66513,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': &491 + '302': &490 description: Found - '403': *439 + '403': *438 '404': *6 '503': *121 x-github: @@ -63903,8 +66537,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: + - *341 - *342 - - *343 - name: language in: path description: The language of the CodeQL database. @@ -63914,7 +66548,7 @@ paths: responses: '204': description: Response - '403': *445 + '403': *444 '404': *6 '503': *121 x-github: @@ -63942,8 +66576,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -63952,7 +66586,7 @@ paths: type: object additionalProperties: false properties: - language: &456 + language: &455 type: string description: The language targeted by the CodeQL query enum: @@ -64032,7 +66666,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &460 + schema: &459 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -64042,7 +66676,7 @@ paths: description: The ID of the variant analysis. controller_repo: *66 actor: *4 - query_language: *456 + query_language: *455 query_pack_url: type: string description: The download url for the query pack. @@ -64089,7 +66723,7 @@ paths: items: type: object properties: - repository: &457 + repository: &456 title: Repository Identifier description: Repository Identifier type: object @@ -64125,7 +66759,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &461 + analysis_status: &460 type: string description: The new status of the CodeQL variant analysis repository task. @@ -64157,7 +66791,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &458 + access_mismatch_repos: &457 type: object properties: repository_count: @@ -64171,7 +66805,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: *457 + items: *456 required: - repository_count - repositories @@ -64193,8 +66827,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *458 - over_limit_repos: *458 + no_codeql_db_repos: *457 + over_limit_repos: *457 required: - access_mismatch_repos - not_found_repos @@ -64210,7 +66844,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &459 + value: &458 summary: Default response value: id: 1 @@ -64356,10 +66990,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *459 + value: *458 repository_lists: summary: Response for a successful variant analysis submission - value: *459 + value: *458 '404': *6 '422': description: Unable to process variant analysis submission @@ -64387,8 +67021,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: + - *341 - *342 - - *343 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -64400,9 +67034,9 @@ paths: description: Response content: application/json: - schema: *460 + schema: *459 examples: - default: *459 + default: *458 '404': *6 '503': *121 x-github: @@ -64425,7 +67059,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: - - *342 + - *341 - name: repo in: path description: The name of the controller repository. @@ -64460,7 +67094,7 @@ paths: type: object properties: repository: *66 - analysis_status: *461 + analysis_status: *460 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -64585,8 +67219,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -64669,7 +67303,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *439 + '403': *438 '404': *6 '503': *121 x-github: @@ -64690,8 +67324,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -64758,7 +67392,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -64783,7 +67417,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *445 + '403': *444 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -64854,8 +67488,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -64863,7 +67497,7 @@ paths: schema: type: object properties: - commit_sha: *462 + commit_sha: *461 ref: type: string description: |- @@ -64921,7 +67555,7 @@ paths: schema: type: object properties: - id: *453 + id: *452 url: type: string description: The REST API URL for checking the status of the upload. @@ -64935,7 +67569,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': *445 + '403': *444 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -64958,8 +67592,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: + - *341 - *342 - - *343 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -65005,7 +67639,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': *439 + '403': *438 '404': description: Not Found if the sarif id does not match any upload '503': *121 @@ -65030,8 +67664,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: + - *341 - *342 - - *343 responses: '200': description: Response @@ -65087,7 +67721,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': *192 + '204': *191 '304': *37 '403': *29 '404': *6 @@ -65112,8 +67746,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: + - *341 - *342 - - *343 - 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 @@ -65233,8 +67867,8 @@ paths: parameters: - *17 - *19 + - *341 - *342 - - *343 responses: '200': description: Response @@ -65250,7 +67884,7 @@ paths: type: integer codespaces: type: array - items: *247 + items: *246 examples: default: value: @@ -65548,8 +68182,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -65612,17 +68246,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '400': *14 '401': *25 '403': *29 @@ -65651,8 +68285,8 @@ paths: parameters: - *17 - *19 + - *341 - *342 - - *343 responses: '200': description: Response @@ -65716,8 +68350,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: + - *341 - *342 - - *343 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -65752,14 +68386,14 @@ paths: type: integer machines: type: array - items: &681 + items: &680 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *464 - required: *465 + properties: *463 + required: *464 examples: - default: &682 + default: &681 value: total_count: 2 machines: @@ -65799,8 +68433,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: + - *341 - *342 - - *343 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -65884,8 +68518,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: + - *341 - *342 - - *343 - 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 @@ -65951,8 +68585,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -65970,7 +68604,7 @@ paths: type: integer secrets: type: array - items: &469 + items: &468 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -65990,7 +68624,7 @@ paths: - created_at - updated_at examples: - default: *466 + default: *465 headers: Link: *67 x-github: @@ -66013,16 +68647,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *467 + schema: *466 examples: - default: *468 + default: *467 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66042,17 +68676,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: + - *341 - *342 - - *343 - - *169 + - *168 responses: '200': description: Response content: application/json: - schema: *469 + schema: *468 examples: - default: *470 + default: *469 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66072,9 +68706,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: + - *341 - *342 - - *343 - - *169 + - *168 requestBody: required: true content: @@ -66102,7 +68736,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -66126,9 +68760,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: + - *341 - *342 - - *343 - - *169 + - *168 responses: '204': description: Response @@ -66156,8 +68790,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: + - *341 - *342 - - *343 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -66199,7 +68833,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &471 + properties: &470 login: type: string example: octocat @@ -66292,7 +68926,7 @@ paths: user_view_type: type: string example: public - required: &472 + required: &471 - avatar_url - events_url - followers_url @@ -66366,8 +69000,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: + - *341 - *342 - - *343 - *71 responses: '204': @@ -66414,8 +69048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: + - *341 - *342 - - *343 - *71 requestBody: required: false @@ -66442,7 +69076,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &541 + schema: &540 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -66453,7 +69087,7 @@ paths: example: 42 type: integer format: int64 - repository: *161 + repository: *160 invitee: title: Simple User description: A GitHub user. @@ -66671,8 +69305,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: + - *341 - *342 - - *343 - *71 responses: '204': @@ -66704,8 +69338,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: + - *341 - *342 - - *343 - *71 responses: '200': @@ -66726,8 +69360,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *471 - required: *472 + properties: *470 + required: *471 nullable: true required: - permission @@ -66782,8 +69416,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -66793,7 +69427,7 @@ paths: application/json: schema: type: array - items: &473 + items: &472 title: Commit Comment description: Commit Comment type: object @@ -66851,7 +69485,7 @@ paths: - created_at - updated_at examples: - default: &478 + default: &477 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66910,17 +69544,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: + - *341 - *342 - - *343 - *101 responses: '200': description: Response content: application/json: - schema: *473 + schema: *472 examples: - default: &479 + default: &478 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66977,8 +69611,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: + - *341 - *342 - - *343 - *101 requestBody: required: true @@ -67001,7 +69635,7 @@ paths: description: Response content: application/json: - schema: *473 + schema: *472 examples: default: value: @@ -67052,8 +69686,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: + - *341 - *342 - - *343 - *101 responses: '204': @@ -67075,8 +69709,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: + - *341 - *342 - - *343 - *101 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -67103,7 +69737,7 @@ paths: application/json: schema: type: array - items: &474 + items: &473 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -67146,7 +69780,7 @@ paths: - content - created_at examples: - default: &545 + default: &544 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -67191,8 +69825,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: + - *341 - *342 - - *343 - *101 requestBody: required: true @@ -67225,9 +69859,9 @@ paths: description: Reaction exists content: application/json: - schema: *474 + schema: *473 examples: - default: &475 + default: &474 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -67256,9 +69890,9 @@ paths: description: Reaction created content: application/json: - schema: *474 + schema: *473 examples: - default: *475 + default: *474 '422': *15 x-github: githubCloudOnly: false @@ -67280,10 +69914,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: + - *341 - *342 - - *343 - *101 - - &546 + - &545 name: reaction_id description: The unique identifier of the reaction. in: path @@ -67338,8 +69972,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: + - *341 - *342 - - *343 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -67395,9 +70029,9 @@ paths: application/json: schema: type: array - items: *476 + items: *475 examples: - default: &596 + default: &595 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -67491,9 +70125,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: + - *341 - *342 - - *343 - - &477 + - &476 name: commit_sha description: The SHA of the commit. in: path @@ -67565,9 +70199,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: + - *341 - *342 - - *343 - - *477 + - *476 - *17 - *19 responses: @@ -67577,9 +70211,9 @@ paths: application/json: schema: type: array - items: *473 + items: *472 examples: - default: *478 + default: *477 headers: Link: *67 x-github: @@ -67607,9 +70241,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: + - *341 - *342 - - *343 - - *477 + - *476 requestBody: required: true content: @@ -67644,9 +70278,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *472 examples: - default: *479 + default: *478 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -67674,9 +70308,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: + - *341 - *342 - - *343 - - *477 + - *476 - *17 - *19 responses: @@ -67686,9 +70320,9 @@ paths: application/json: schema: type: array - items: *480 + items: *479 examples: - default: &588 + default: &587 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -68225,11 +70859,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: + - *341 - *342 - - *343 - *19 - *17 - - &481 + - &480 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)" @@ -68244,9 +70878,9 @@ paths: description: Response content: application/json: - schema: *476 + schema: *475 examples: - default: &575 + default: &574 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -68359,11 +70993,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: + - *341 - *342 - - *343 + - *480 - *481 - *482 - - *483 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -68397,9 +71031,9 @@ paths: type: integer check_runs: type: array - items: *420 + items: *419 examples: - default: *484 + default: *483 headers: Link: *67 x-github: @@ -68424,9 +71058,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: + - *341 - *342 - - *343 - - *481 + - *480 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -68434,7 +71068,7 @@ paths: schema: type: integer example: 1 - - *482 + - *481 - *17 - *19 responses: @@ -68452,7 +71086,7 @@ paths: type: integer check_suites: type: array - items: *425 + items: *424 examples: default: value: @@ -68652,9 +71286,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: + - *341 - *342 - - *343 - - *481 + - *480 - *17 - *19 responses: @@ -68721,7 +71355,7 @@ paths: type: string total_count: type: integer - repository: *161 + repository: *160 commit_url: type: string format: uri @@ -68852,9 +71486,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: + - *341 - *342 - - *343 - - *481 + - *480 - *17 - *19 responses: @@ -68864,7 +71498,7 @@ paths: application/json: schema: type: array - items: &661 + items: &660 title: Status description: The status of a commit. type: object @@ -68945,7 +71579,7 @@ paths: site_admin: false headers: Link: *67 - '301': *346 + '301': *345 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68973,8 +71607,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -69003,20 +71637,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *485 - required: *486 + properties: *484 + required: *485 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &487 + properties: &486 url: type: string format: uri html_url: type: string format: uri - required: &488 + required: &487 - url - html_url nullable: true @@ -69030,26 +71664,26 @@ paths: contributing: title: Community Health File type: object - properties: *487 - required: *488 + properties: *486 + required: *487 nullable: true readme: title: Community Health File type: object - properties: *487 - required: *488 + properties: *486 + required: *487 nullable: true issue_template: title: Community Health File type: object - properties: *487 - required: *488 + properties: *486 + required: *487 nullable: true pull_request_template: title: Community Health File type: object - properties: *487 - required: *488 + properties: *486 + required: *487 nullable: true required: - code_of_conduct @@ -69176,8 +71810,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: + - *341 - *342 - - *343 - *19 - *17 - name: basehead @@ -69220,8 +71854,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *476 - merge_base_commit: *476 + base_commit: *475 + merge_base_commit: *475 status: type: string enum: @@ -69241,10 +71875,10 @@ paths: example: 6 commits: type: array - items: *476 + items: *475 files: type: array - items: *489 + items: *488 required: - url - html_url @@ -69530,8 +72164,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: + - *341 - *342 - - *343 - name: path description: path parameter in: path @@ -69691,7 +72325,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &490 + response-if-content-is-a-file-github-object: &489 summary: Response if content is a file value: type: file @@ -69823,7 +72457,7 @@ paths: - size - type - url - - &601 + - &600 title: Content File description: Content File type: object @@ -70024,7 +72658,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *490 + response-if-content-is-a-file: *489 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -70093,7 +72727,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *491 + '302': *490 '304': *37 x-github: githubCloudOnly: false @@ -70116,8 +72750,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: + - *341 - *342 - - *343 - name: path description: path parameter in: path @@ -70210,7 +72844,7 @@ paths: description: Response content: application/json: - schema: &492 + schema: &491 title: File Commit description: File Commit type: object @@ -70362,7 +72996,7 @@ paths: description: Response content: application/json: - schema: *492 + schema: *491 examples: example-for-creating-a-file: value: @@ -70416,7 +73050,7 @@ paths: schema: oneOf: - *3 - - &523 + - &522 description: Repository rule violation was detected type: object properties: @@ -70437,7 +73071,7 @@ paths: items: type: object properties: - placeholder_id: &653 + placeholder_id: &652 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -70469,8 +73103,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: + - *341 - *342 - - *343 - name: path description: path parameter in: path @@ -70531,7 +73165,7 @@ paths: description: Response content: application/json: - schema: *492 + schema: *491 examples: default: value: @@ -70586,8 +73220,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: + - *341 - *342 - - *343 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -70710,23 +73344,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: + - *341 - *342 - - *343 + - *199 - *200 - *201 - *202 - - *203 - 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 + - *203 + - *492 - *204 - - *493 - *205 - *206 - - *207 - *61 - *47 - *48 @@ -70738,11 +73372,11 @@ paths: application/json: schema: type: array - items: &497 + items: &496 type: object description: A Dependabot alert. properties: - number: *179 + number: *178 state: type: string description: The state of the Dependabot alert. @@ -70784,13 +73418,14 @@ paths: - unknown - direct - transitive - security_advisory: *494 + - inconclusive + security_advisory: *493 security_vulnerability: *65 - url: *182 - html_url: *183 - created_at: *180 - updated_at: *181 - dismissed_at: *185 + url: *181 + html_url: *182 + created_at: *179 + updated_at: *180 + dismissed_at: *184 dismissed_by: title: Simple User description: A GitHub user. @@ -70814,9 +73449,9 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *184 - auto_dismissed_at: *495 - dismissal_request: *496 + fixed_at: *183 + auto_dismissed_at: *494 + dismissal_request: *495 assignees: type: array description: The users assigned to this alert. @@ -70888,7 +73523,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 @@ -71071,9 +73706,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: + - *341 - *342 - - *343 - - &498 + - &497 name: alert_number in: path description: |- @@ -71082,13 +73717,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *179 + schema: *178 responses: '200': description: Response content: application/json: - schema: *497 + schema: *496 examples: default: value: @@ -71145,7 +73780,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 @@ -71220,9 +73855,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: + - *341 - *342 - - *343 - - *498 + - *497 requestBody: required: true content: @@ -71278,7 +73913,7 @@ paths: description: Response content: application/json: - schema: *497 + schema: *496 examples: default: value: @@ -71408,8 +74043,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -71427,7 +74062,7 @@ paths: type: integer secrets: type: array - items: &501 + items: &500 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -71480,16 +74115,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *499 + schema: *498 examples: - default: *500 + default: *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71509,15 +74144,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: + - *341 - *342 - - *343 - - *169 + - *168 responses: '200': description: Response content: application/json: - schema: *501 + schema: *500 examples: default: value: @@ -71543,9 +74178,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: + - *341 - *342 - - *343 - - *169 + - *168 requestBody: required: true content: @@ -71573,7 +74208,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -71597,9 +74232,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: + - *341 - *342 - - *343 - - *169 + - *168 responses: '204': description: Response @@ -71621,8 +74256,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: + - *341 - *342 - - *343 - 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 @@ -71782,8 +74417,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: + - *341 - *342 - - *343 responses: '200': description: Response @@ -72022,8 +74657,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: + - *341 - *342 - - *343 requestBody: required: true content: @@ -72098,7 +74733,7 @@ paths: - version - url additionalProperties: false - metadata: &502 + metadata: &501 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -72131,7 +74766,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *502 + metadata: *501 resolved: type: object description: A collection of resolved package dependencies. @@ -72144,7 +74779,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *502 + metadata: *501 relationship: type: string description: A notation of whether a dependency is requested @@ -72273,8 +74908,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: + - *341 - *342 - - *343 - name: sha description: The SHA recorded at creation time. in: query @@ -72314,9 +74949,9 @@ paths: application/json: schema: type: array - items: *503 + items: *502 examples: - default: *504 + default: *503 headers: Link: *67 x-github: @@ -72382,8 +75017,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -72464,7 +75099,7 @@ paths: description: Response content: application/json: - schema: *503 + schema: *502 examples: simple-example: summary: Simple example @@ -72537,9 +75172,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: + - *341 - *342 - - *343 - - &505 + - &504 name: deployment_id description: deployment_id parameter in: path @@ -72551,7 +75186,7 @@ paths: description: Response content: application/json: - schema: *503 + schema: *502 examples: default: value: @@ -72616,9 +75251,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: + - *341 - *342 - - *343 - - *505 + - *504 responses: '204': description: Response @@ -72640,9 +75275,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: + - *341 - *342 - - *343 - - *505 + - *504 - *17 - *19 responses: @@ -72652,7 +75287,7 @@ paths: application/json: schema: type: array - items: &506 + items: &505 title: Deployment Status description: The status of a deployment. type: object @@ -72813,9 +75448,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: + - *341 - *342 - - *343 - - *505 + - *504 requestBody: required: true content: @@ -72890,9 +75525,9 @@ paths: description: Response content: application/json: - schema: *506 + schema: *505 examples: - default: &507 + default: &506 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -72948,9 +75583,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: + - *341 - *342 - - *343 - - *505 + - *504 - name: status_id in: path required: true @@ -72961,9 +75596,9 @@ paths: description: Response content: application/json: - schema: *506 + schema: *505 examples: - default: *507 + default: *506 '404': *6 x-github: githubCloudOnly: false @@ -72988,8 +75623,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -73046,8 +75681,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -73064,7 +75699,7 @@ paths: type: integer environments: type: array - items: &509 + items: &508 title: Environment description: Details of a deployment environment type: object @@ -73116,7 +75751,7 @@ paths: type: type: string example: wait_timer - wait_timer: &511 + wait_timer: &510 type: integer example: 30 description: The amount of time to delay a job after @@ -73153,11 +75788,11 @@ paths: items: type: object properties: - type: *508 + type: *507 reviewer: anyOf: - *4 - - *198 + - *197 required: - id - node_id @@ -73177,7 +75812,7 @@ paths: - id - node_id - type - deployment_branch_policy: &512 + deployment_branch_policy: &511 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -73293,9 +75928,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: + - *341 - *342 - - *343 - - &510 + - &509 name: environment_name in: path required: true @@ -73308,9 +75943,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *508 examples: - default: &513 + default: &512 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -73394,9 +76029,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: + - *341 - *342 - - *343 - - *510 + - *509 requestBody: required: false content: @@ -73405,7 +76040,7 @@ paths: type: object nullable: true properties: - wait_timer: *511 + wait_timer: *510 prevent_self_review: type: boolean example: false @@ -73422,13 +76057,13 @@ paths: items: type: object properties: - type: *508 + type: *507 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *512 + deployment_branch_policy: *511 additionalProperties: false examples: default: @@ -73448,9 +76083,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *508 examples: - default: *513 + default: *512 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -73474,9 +76109,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: + - *341 - *342 - - *343 - - *510 + - *509 responses: '204': description: Default response @@ -73501,9 +76136,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: + - *341 - *342 - - *343 - - *510 + - *509 - *17 - *19 responses: @@ -73521,7 +76156,7 @@ paths: example: 2 branch_policies: type: array - items: &514 + items: &513 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -73578,9 +76213,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: + - *341 - *342 - - *343 - - *510 + - *509 requestBody: required: true content: @@ -73626,9 +76261,9 @@ paths: description: Response content: application/json: - schema: *514 + schema: *513 examples: - example-wildcard: &515 + example-wildcard: &514 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -73670,10 +76305,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: + - *341 - *342 - - *343 - - *510 - - &516 + - *509 + - &515 name: branch_policy_id in: path required: true @@ -73685,9 +76320,9 @@ paths: description: Response content: application/json: - schema: *514 + schema: *513 examples: - default: *515 + default: *514 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73706,10 +76341,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: + - *341 - *342 - - *343 - - *510 - - *516 + - *509 + - *515 requestBody: required: true content: @@ -73737,9 +76372,9 @@ paths: description: Response content: application/json: - schema: *514 + schema: *513 examples: - default: *515 + default: *514 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73758,10 +76393,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: + - *341 - *342 - - *343 - - *510 - - *516 + - *509 + - *515 responses: '204': description: Response @@ -73786,9 +76421,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *510 - - *343 + - *509 - *342 + - *341 responses: '200': description: List of deployment protection rules @@ -73804,7 +76439,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &517 + items: &516 title: Deployment protection rule description: Deployment protection rule type: object @@ -73823,7 +76458,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &518 + app: &517 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -73922,9 +76557,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: - - *510 - - *343 + - *509 - *342 + - *341 requestBody: content: application/json: @@ -73945,9 +76580,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *517 + schema: *516 examples: - default: &519 + default: &518 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -73982,9 +76617,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: - - *510 - - *343 + - *509 - *342 + - *341 - *19 - *17 responses: @@ -74003,7 +76638,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *518 + items: *517 examples: default: value: @@ -74038,10 +76673,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: + - *341 - *342 - - *343 - - *510 - - &520 + - *509 + - &519 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -74053,9 +76688,9 @@ paths: description: Response content: application/json: - schema: *517 + schema: *516 examples: - default: *519 + default: *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74076,10 +76711,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *510 - - *343 + - *509 - *342 - - *520 + - *341 + - *519 responses: '204': description: Response @@ -74105,9 +76740,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: + - *341 - *342 - - *343 - - *510 + - *509 - *17 - *19 responses: @@ -74125,9 +76760,9 @@ paths: type: integer secrets: type: array - items: *387 + items: *386 examples: - default: *388 + default: *387 headers: Link: *67 x-github: @@ -74152,17 +76787,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: + - *341 - *342 - - *343 - - *510 + - *509 responses: '200': description: Response content: application/json: - schema: *389 + schema: *388 examples: - default: *390 + default: *389 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74184,18 +76819,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: + - *341 - *342 - - *343 - - *510 - - *169 + - *509 + - *168 responses: '200': description: Response content: application/json: - schema: *387 + schema: *386 examples: - default: *521 + default: *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74217,10 +76852,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: + - *341 - *342 - - *343 - - *510 - - *169 + - *509 + - *168 requestBody: required: true content: @@ -74251,7 +76886,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -74277,10 +76912,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: + - *341 - *342 - - *343 - - *510 - - *169 + - *509 + - *168 responses: '204': description: Default response @@ -74305,10 +76940,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: + - *341 - *342 - - *343 - - *510 - - *358 + - *509 + - *357 - *19 responses: '200': @@ -74325,9 +76960,9 @@ paths: type: integer variables: type: array - items: *391 + items: *390 examples: - default: *392 + default: *391 headers: Link: *67 x-github: @@ -74350,9 +76985,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: + - *341 - *342 - - *343 - - *510 + - *509 requestBody: required: true content: @@ -74379,7 +77014,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -74404,18 +77039,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: + - *341 - *342 - - *343 - - *510 - - *172 + - *509 + - *171 responses: '200': description: Response content: application/json: - schema: *391 + schema: *390 examples: - default: *522 + default: *521 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74436,10 +77071,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: + - *341 - *342 - - *343 - - *172 - - *510 + - *171 + - *509 requestBody: required: true content: @@ -74481,10 +77116,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: + - *341 - *342 - - *343 - - *172 - - *510 + - *171 + - *509 responses: '204': description: Response @@ -74506,8 +77141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -74575,8 +77210,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: + - *341 - *342 - - *343 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -74598,7 +77233,7 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: default: value: @@ -74735,8 +77370,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: + - *341 - *342 - - *343 requestBody: required: false content: @@ -74768,9 +77403,9 @@ paths: description: Response content: application/json: - schema: *345 + schema: *344 examples: - default: *347 + default: *346 '400': *14 '422': *15 '403': *29 @@ -74791,8 +77426,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -74852,7 +77487,7 @@ paths: schema: oneOf: - *129 - - *523 + - *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74877,8 +77512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: + - *341 - *342 - - *343 - name: file_sha in: path required: true @@ -74977,8 +77612,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -75087,7 +77722,7 @@ paths: description: Response content: application/json: - schema: &524 + schema: &523 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -75301,15 +77936,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: + - *341 - *342 - - *343 - - *477 + - *476 responses: '200': description: Response content: application/json: - schema: *524 + schema: *523 examples: default: value: @@ -75365,9 +78000,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: + - *341 - *342 - - *343 - - &525 + - &524 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. @@ -75384,7 +78019,7 @@ paths: application/json: schema: type: array - items: &526 + items: &525 title: Git Reference description: Git references within a repository type: object @@ -75459,17 +78094,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: + - *341 - *342 - - *343 - - *525 + - *524 responses: '200': description: Response content: application/json: - schema: *526 + schema: *525 examples: - default: &527 + default: &526 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -75498,8 +78133,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -75528,9 +78163,9 @@ paths: description: Response content: application/json: - schema: *526 + schema: *525 examples: - default: *527 + default: *526 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -75556,9 +78191,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: + - *341 - *342 - - *343 - - *525 + - *524 requestBody: required: true content: @@ -75587,9 +78222,9 @@ paths: description: Response content: application/json: - schema: *526 + schema: *525 examples: - default: *527 + default: *526 '422': *15 '409': *54 x-github: @@ -75607,9 +78242,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: + - *341 - *342 - - *343 - - *525 + - *524 responses: '204': description: Response @@ -75664,8 +78299,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -75732,7 +78367,7 @@ paths: description: Response content: application/json: - schema: &529 + schema: &528 title: Git Tag description: Metadata for a Git tag type: object @@ -75783,7 +78418,7 @@ paths: - sha - type - url - verification: *528 + verification: *527 required: - sha - url @@ -75793,7 +78428,7 @@ paths: - tag - message examples: - default: &530 + default: &529 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -75866,8 +78501,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: + - *341 - *342 - - *343 - name: tag_sha in: path required: true @@ -75878,9 +78513,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *528 examples: - default: *530 + default: *529 '404': *6 '409': *54 x-github: @@ -75904,8 +78539,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -75978,7 +78613,7 @@ paths: description: Response content: application/json: - schema: &531 + schema: &530 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -76074,8 +78709,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: + - *341 - *342 - - *343 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -76098,7 +78733,7 @@ paths: description: Response content: application/json: - schema: *531 + schema: *530 examples: default-response: summary: Default response @@ -76157,8 +78792,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -76168,7 +78803,7 @@ paths: application/json: schema: type: array - items: &532 + items: &531 title: Webhook description: Webhooks for repositories. type: object @@ -76222,7 +78857,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &775 + last_response: &774 title: Hook Response type: object properties: @@ -76296,8 +78931,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: + - *341 - *342 - - *343 requestBody: required: false content: @@ -76349,9 +78984,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *531 examples: - default: &533 + default: &532 value: type: Repository id: 12345678 @@ -76399,17 +79034,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: + - *341 - *342 - - *343 - - *215 + - *214 responses: '200': description: Response content: application/json: - schema: *532 + schema: *531 examples: - default: *533 + default: *532 '404': *6 x-github: githubCloudOnly: false @@ -76429,9 +79064,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: + - *341 - *342 - - *343 - - *215 + - *214 requestBody: required: true content: @@ -76476,9 +79111,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *531 examples: - default: *533 + default: *532 '422': *15 '404': *6 x-github: @@ -76499,9 +79134,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: + - *341 - *342 - - *343 - - *215 + - *214 responses: '204': description: Response @@ -76525,9 +79160,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: + - *341 - *342 - - *343 - - *215 + - *214 responses: '200': description: Response @@ -76554,9 +79189,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: + - *341 - *342 - - *343 - - *215 + - *214 requestBody: required: false content: @@ -76600,12 +79235,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: + - *341 - *342 - - *343 - - *215 + - *214 - *17 + - *215 - *216 - - *217 responses: '200': description: Response @@ -76613,9 +79248,9 @@ paths: application/json: schema: type: array - items: *218 + items: *217 examples: - default: *219 + default: *218 '400': *14 '422': *15 x-github: @@ -76634,18 +79269,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: + - *341 - *342 - - *343 - - *215 + - *214 - *16 responses: '200': description: Response content: application/json: - schema: *220 + schema: *219 examples: - default: *221 + default: *220 '400': *14 '422': *15 x-github: @@ -76664,9 +79299,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: + - *341 - *342 - - *343 - - *215 + - *214 - *16 responses: '202': *39 @@ -76689,9 +79324,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: + - *341 - *342 - - *343 - - *215 + - *214 responses: '204': description: Response @@ -76716,9 +79351,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: + - *341 - *342 - - *343 - - *215 + - *214 responses: '204': description: Response @@ -76741,8 +79376,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response if immutable releases are enabled @@ -76788,10 +79423,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: + - *341 - *342 - - *343 responses: - '204': *192 + '204': *191 '409': *54 x-github: githubCloudOnly: false @@ -76809,10 +79444,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: + - *341 - *342 - - *343 responses: - '204': *192 + '204': *191 '409': *54 x-github: githubCloudOnly: false @@ -76867,14 +79502,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: &534 + schema: &533 title: Import description: A repository import from an external source. type: object @@ -76973,7 +79608,7 @@ paths: - html_url - authors_url examples: - default: &537 + default: &536 value: vcs: subversion use_lfs: true @@ -76989,7 +79624,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': &535 + '503': &534 description: Unavailable due to service under maintenance. content: application/json: @@ -77018,8 +79653,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -77067,7 +79702,7 @@ paths: description: Response content: application/json: - schema: *534 + schema: *533 examples: default: value: @@ -77092,7 +79727,7 @@ paths: type: string '422': *15 '404': *6 - '503': *535 + '503': *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77120,8 +79755,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: + - *341 - *342 - - *343 requestBody: required: false content: @@ -77170,7 +79805,7 @@ paths: description: Response content: application/json: - schema: *534 + schema: *533 examples: example-1: summary: Example 1 @@ -77218,7 +79853,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': *535 + '503': *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77241,12 +79876,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: + - *341 - *342 - - *343 responses: '204': description: Response - '503': *535 + '503': *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77272,9 +79907,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: + - *341 - *342 - - *343 - - &704 + - &703 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -77288,7 +79923,7 @@ paths: application/json: schema: type: array - items: &536 + items: &535 title: Porter Author description: Porter Author type: object @@ -77342,7 +79977,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': *535 + '503': *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77367,8 +80002,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: + - *341 - *342 - - *343 - name: author_id in: path required: true @@ -77398,7 +80033,7 @@ paths: description: Response content: application/json: - schema: *536 + schema: *535 examples: default: value: @@ -77411,7 +80046,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *535 + '503': *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77435,8 +80070,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -77477,7 +80112,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *535 + '503': *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77505,8 +80140,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -77533,11 +80168,11 @@ paths: description: Response content: application/json: - schema: *534 + schema: *533 examples: - default: *537 + default: *536 '422': *15 - '503': *535 + '503': *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77560,8 +80195,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -77569,8 +80204,8 @@ paths: application/json: schema: *22 examples: - default: *538 - '301': *346 + default: *537 + '301': *345 '404': *6 x-github: githubCloudOnly: false @@ -77590,8 +80225,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -77599,12 +80234,12 @@ paths: application/json: schema: anyOf: - - *234 + - *233 - type: object properties: {} additionalProperties: false examples: - default: &540 + default: &539 value: limit: collaborators_only origin: repository @@ -77629,13 +80264,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: + - *341 - *342 - - *343 requestBody: required: true content: application/json: - schema: *539 + schema: *538 examples: default: summary: Example request body @@ -77647,9 +80282,9 @@ paths: description: Response content: application/json: - schema: *234 + schema: *233 examples: - default: *540 + default: *539 '409': description: Response x-github: @@ -77671,8 +80306,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -77695,8 +80330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -77706,9 +80341,9 @@ paths: application/json: schema: type: array - items: *541 + items: *540 examples: - default: &696 + default: &695 value: - id: 1 repository: @@ -77839,9 +80474,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: + - *341 - *342 - - *343 - - *238 + - *237 requestBody: required: false content: @@ -77870,7 +80505,7 @@ paths: description: Response content: application/json: - schema: *541 + schema: *540 examples: default: value: @@ -78001,9 +80636,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: + - *341 - *342 - - *343 - - *238 + - *237 responses: '204': description: Response @@ -78034,8 +80669,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: + - *341 - *342 - - *343 - 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 @@ -78083,7 +80718,7 @@ paths: required: false schema: type: string - - *245 + - *244 - name: sort description: What to sort results by. in: query @@ -78108,7 +80743,7 @@ paths: type: array items: *85 examples: - default: &553 + default: &552 value: - id: 1 node_id: MDU6SXNzdWUx @@ -78257,7 +80892,7 @@ paths: state_reason: completed headers: Link: *67 - '301': *346 + '301': *345 '422': *15 '404': *6 x-github: @@ -78286,8 +80921,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -78364,7 +80999,7 @@ paths: application/json: schema: *85 examples: - default: &550 + default: &549 value: id: 1 node_id: MDU6SXNzdWUx @@ -78521,7 +81156,7 @@ paths: '422': *15 '503': *121 '404': *6 - '410': *542 + '410': *541 x-github: triggersNotification: true githubCloudOnly: false @@ -78549,8 +81184,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: + - *341 - *342 - - *343 - *109 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -78571,9 +81206,9 @@ paths: application/json: schema: type: array - items: *543 + items: *542 examples: - default: &552 + default: &551 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -78631,17 +81266,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: + - *341 - *342 - - *343 - *101 responses: '200': description: Response content: application/json: - schema: *543 + schema: *542 examples: - default: &544 + default: &543 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -78696,8 +81331,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: + - *341 - *342 - - *343 - *101 requestBody: required: true @@ -78720,9 +81355,9 @@ paths: description: Response content: application/json: - schema: *543 + schema: *542 examples: - default: *544 + default: *543 '422': *15 x-github: githubCloudOnly: false @@ -78740,8 +81375,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: + - *341 - *342 - - *343 - *101 responses: '204': @@ -78770,15 +81405,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment parameters: + - *341 - *342 - - *343 - *101 responses: '200': description: Response content: application/json: - schema: *543 + schema: *542 examples: default: value: @@ -78834,7 +81469,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *542 + '410': *541 '422': *15 x-github: githubCloudOnly: false @@ -78851,8 +81486,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment parameters: + - *341 - *342 - - *343 - *101 responses: '204': @@ -78860,7 +81495,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *542 + '410': *541 '503': *121 x-github: githubCloudOnly: false @@ -78878,8 +81513,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: + - *341 - *342 - - *343 - *101 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -78906,9 +81541,9 @@ paths: application/json: schema: type: array - items: *474 + items: *473 examples: - default: *545 + default: *544 headers: Link: *67 '404': *6 @@ -78929,8 +81564,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: + - *341 - *342 - - *343 - *101 requestBody: required: true @@ -78963,16 +81598,16 @@ paths: description: Reaction exists content: application/json: - schema: *474 + schema: *473 examples: - default: *475 + default: *474 '201': description: Reaction created content: application/json: - schema: *474 + schema: *473 examples: - default: *475 + default: *474 '422': *15 x-github: githubCloudOnly: false @@ -78994,10 +81629,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: + - *341 - *342 - - *343 - *101 - - *546 + - *545 responses: '204': description: Response @@ -79017,8 +81652,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -79028,7 +81663,7 @@ paths: application/json: schema: type: array - items: &549 + items: &548 title: Issue Event description: Issue Event type: object @@ -79071,8 +81706,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *547 - required: *548 + properties: *546 + required: *547 nullable: true label: title: Issue Event Label @@ -79116,7 +81751,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *198 + requested_team: *197 dismissed_review: title: Issue Event Dismissed Review type: object @@ -79380,8 +82015,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: + - *341 - *342 - - *343 - name: event_id in: path required: true @@ -79392,7 +82027,7 @@ paths: description: Response content: application/json: - schema: *549 + schema: *548 examples: default: value: @@ -79585,7 +82220,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *542 + '410': *541 '403': *29 x-github: githubCloudOnly: false @@ -79619,9 +82254,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: + - *341 - *342 - - *343 - - &551 + - &550 name: issue_number description: The number that identifies the issue. in: path @@ -79637,7 +82272,7 @@ paths: examples: default: summary: Issue - value: *550 + value: *549 pinned_comment: summary: Issue with pinned comment value: @@ -79836,9 +82471,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *346 + '301': *345 '404': *6 - '410': *542 + '410': *541 '304': *37 x-github: githubCloudOnly: false @@ -79863,9 +82498,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: false content: @@ -79986,13 +82621,13 @@ paths: application/json: schema: *85 examples: - default: *550 + default: *549 '422': *15 '503': *121 '403': *29 - '301': *346 + '301': *345 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80010,9 +82645,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: false content: @@ -80040,7 +82675,7 @@ paths: application/json: schema: *85 examples: - default: *550 + default: *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80056,9 +82691,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: content: application/json: @@ -80085,7 +82720,7 @@ paths: application/json: schema: *85 examples: - default: *550 + default: *549 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80107,9 +82742,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: + - *341 - *342 - - *343 - - *551 + - *550 - name: assignee in: path required: true @@ -80149,9 +82784,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: + - *341 - *342 - - *343 - - *551 + - *550 - *92 - *17 - *19 @@ -80162,13 +82797,13 @@ paths: application/json: schema: type: array - items: *543 + items: *542 examples: - default: *552 + default: *551 headers: Link: *67 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80197,9 +82832,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: true content: @@ -80221,16 +82856,16 @@ paths: description: Response content: application/json: - schema: *543 + schema: *542 examples: - default: *544 + default: *543 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *542 + '410': *541 '422': *15 '404': *6 x-github: @@ -80258,9 +82893,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: + - *341 - *342 - - *343 - - *551 + - *550 - *17 - *19 responses: @@ -80272,12 +82907,12 @@ paths: type: array items: *85 examples: - default: *553 + default: *552 headers: Link: *67 - '301': *346 + '301': *345 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80305,9 +82940,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: true content: @@ -80331,15 +82966,15 @@ paths: application/json: schema: *85 examples: - default: *550 + default: *549 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *346 + '301': *345 '403': *29 - '410': *542 + '410': *541 '422': *15 '404': *6 x-github: @@ -80370,9 +83005,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: + - *341 - *342 - - *343 - - *551 + - *550 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -80386,13 +83021,13 @@ paths: application/json: schema: *85 examples: - default: *550 - '301': *346 + default: *549 + '301': *345 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *542 + '410': *541 x-github: triggersNotification: true githubCloudOnly: false @@ -80418,9 +83053,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: + - *341 - *342 - - *343 - - *551 + - *550 - *17 - *19 responses: @@ -80432,12 +83067,12 @@ paths: type: array items: *85 examples: - default: *553 + default: *552 headers: Link: *67 - '301': *346 + '301': *345 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80454,9 +83089,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: + - *341 - *342 - - *343 - - *551 + - *550 - *17 - *19 responses: @@ -80470,7 +83105,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &556 + - &555 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -80524,7 +83159,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &557 + - &556 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -80660,7 +83295,7 @@ paths: - performed_via_github_app - assignee - assigner - - &558 + - &557 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -80711,7 +83346,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &559 + - &558 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -80762,7 +83397,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &560 + - &559 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -80816,7 +83451,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &561 + - &560 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -80850,7 +83485,7 @@ paths: properties: *80 required: *81 review_requester: *4 - requested_team: *198 + requested_team: *197 requested_reviewer: *4 required: - review_requester @@ -80863,7 +83498,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &562 + - &561 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -80897,7 +83532,7 @@ paths: properties: *80 required: *81 review_requester: *4 - requested_team: *198 + requested_team: *197 requested_reviewer: *4 required: - review_requester @@ -80910,7 +83545,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &563 + - &562 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -80970,7 +83605,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &564 + - &563 title: Locked Issue Event description: Locked Issue Event type: object @@ -81018,7 +83653,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &565 + - &564 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -81084,7 +83719,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &566 + - &565 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -81150,7 +83785,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &567 + - &566 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -81216,7 +83851,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &568 + - &567 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -81307,7 +83942,7 @@ paths: color: red headers: Link: *67 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81324,9 +83959,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 - *17 - *19 responses: @@ -81336,9 +83971,9 @@ paths: application/json: schema: type: array - items: *554 + items: *553 examples: - default: &667 + default: &666 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -81362,9 +83997,9 @@ paths: value: '2025-12-25' headers: Link: *67 - '301': *346 + '301': *345 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81381,9 +84016,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 - *17 - *19 responses: @@ -81395,7 +84030,7 @@ paths: type: array items: *84 examples: - default: &555 + default: &554 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -81413,9 +84048,9 @@ paths: default: false headers: Link: *67 - '301': *346 + '301': *345 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81431,9 +84066,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: false content: @@ -81478,10 +84113,10 @@ paths: type: array items: *84 examples: - default: *555 - '301': *346 + default: *554 + '301': *345 '404': *6 - '410': *542 + '410': *541 '422': *15 x-github: githubCloudOnly: false @@ -81498,9 +84133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: false content: @@ -81562,10 +84197,10 @@ paths: type: array items: *84 examples: - default: *555 - '301': *346 + default: *554 + '301': *345 '404': *6 - '410': *542 + '410': *541 '422': *15 x-github: githubCloudOnly: false @@ -81582,15 +84217,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 responses: '204': description: Response - '301': *346 + '301': *345 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81609,9 +84244,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 - name: name in: path required: true @@ -81635,9 +84270,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *346 + '301': *345 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81657,9 +84292,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: false content: @@ -81687,7 +84322,7 @@ paths: '204': description: Response '403': *29 - '410': *542 + '410': *541 '404': *6 '422': *15 x-github: @@ -81705,9 +84340,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 responses: '204': description: Response @@ -81737,9 +84372,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 responses: '200': description: Response @@ -81747,10 +84382,10 @@ paths: application/json: schema: *85 examples: - default: *550 - '301': *346 + default: *549 + '301': *345 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81767,9 +84402,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 - 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. @@ -81795,13 +84430,13 @@ paths: application/json: schema: type: array - items: *474 + items: *473 examples: - default: *545 + default: *544 headers: Link: *67 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81819,9 +84454,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: true content: @@ -81853,16 +84488,16 @@ paths: description: Response content: application/json: - schema: *474 + schema: *473 examples: - default: *475 + default: *474 '201': description: Response content: application/json: - schema: *474 + schema: *473 examples: - default: *475 + default: *474 '422': *15 x-github: githubCloudOnly: false @@ -81884,10 +84519,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: + - *341 - *342 - - *343 - - *551 - - *546 + - *550 + - *545 responses: '204': description: Response @@ -81916,9 +84551,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: true content: @@ -81942,7 +84577,7 @@ paths: application/json: schema: *85 examples: - default: *550 + default: *549 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -81975,9 +84610,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: + - *341 - *342 - - *343 - - *551 + - *550 - *17 - *19 responses: @@ -81989,11 +84624,11 @@ paths: type: array items: *85 examples: - default: *553 + default: *552 headers: Link: *67 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82021,9 +84656,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: true content: @@ -82052,14 +84687,14 @@ paths: application/json: schema: *85 examples: - default: *550 + default: *549 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *542 + '410': *541 '422': *15 '404': *6 x-github: @@ -82079,9 +84714,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 requestBody: required: true content: @@ -82114,7 +84749,7 @@ paths: application/json: schema: *85 examples: - default: *550 + default: *549 '403': *29 '404': *6 '422': *7 @@ -82136,9 +84771,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: + - *341 - *342 - - *343 - - *551 + - *550 - *17 - *19 responses: @@ -82153,6 +84788,7 @@ paths: description: Timeline Event type: object anyOf: + - *555 - *556 - *557 - *558 @@ -82165,7 +84801,6 @@ paths: - *565 - *566 - *567 - - *568 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -82226,8 +84861,8 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *569 - required: *570 + properties: *568 + required: *569 nullable: true required: - event @@ -82482,7 +85117,7 @@ paths: type: string comments: type: array - items: &590 + items: &589 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -82697,7 +85332,7 @@ paths: type: string comments: type: array - items: *473 + items: *472 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -82986,7 +85621,7 @@ paths: headers: Link: *67 '404': *6 - '410': *542 + '410': *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83003,8 +85638,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -83014,7 +85649,7 @@ paths: application/json: schema: type: array - items: &571 + items: &570 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -83080,8 +85715,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -83117,9 +85752,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *570 examples: - default: &572 + default: &571 value: id: 1 key: ssh-rsa AAA... @@ -83153,9 +85788,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: + - *341 - *342 - - *343 - - &573 + - &572 name: key_id description: The unique identifier of the key. in: path @@ -83167,9 +85802,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *570 examples: - default: *572 + default: *571 '404': *6 x-github: githubCloudOnly: false @@ -83187,9 +85822,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: + - *341 - *342 - - *343 - - *573 + - *572 responses: '204': description: Response @@ -83209,8 +85844,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -83222,7 +85857,7 @@ paths: type: array items: *84 examples: - default: *555 + default: *554 headers: Link: *67 '404': *6 @@ -83243,8 +85878,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -83282,7 +85917,7 @@ paths: application/json: schema: *84 examples: - default: &574 + default: &573 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -83314,8 +85949,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: + - *341 - *342 - - *343 - name: name in: path required: true @@ -83328,7 +85963,7 @@ paths: application/json: schema: *84 examples: - default: *574 + default: *573 '404': *6 x-github: githubCloudOnly: false @@ -83345,8 +85980,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: + - *341 - *342 - - *343 - name: name in: path required: true @@ -83411,8 +86046,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: + - *341 - *342 - - *343 - name: name in: path required: true @@ -83438,8 +86073,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -83478,9 +86113,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: + - *341 - *342 - - *343 - - *446 + - *445 responses: '200': description: Response @@ -83625,8 +86260,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -83691,8 +86326,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -83726,9 +86361,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *476 + schema: *475 examples: - default: *575 + default: *574 '204': description: Response when already merged '404': @@ -83753,8 +86388,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: + - *341 - *342 - - *343 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -83795,12 +86430,12 @@ paths: application/json: schema: type: array - items: &576 + items: &575 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *279 - required: *280 + properties: *278 + required: *279 examples: default: value: @@ -83856,8 +86491,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -83897,9 +86532,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *575 examples: - default: &577 + default: &576 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -83958,9 +86593,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: + - *341 - *342 - - *343 - - &578 + - &577 name: milestone_number description: The number that identifies the milestone. in: path @@ -83972,9 +86607,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *575 examples: - default: *577 + default: *576 '404': *6 x-github: githubCloudOnly: false @@ -83991,9 +86626,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: + - *341 - *342 - - *343 - - *578 + - *577 requestBody: required: false content: @@ -84031,9 +86666,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *575 examples: - default: *577 + default: *576 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84049,9 +86684,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: + - *341 - *342 - - *343 - - *578 + - *577 responses: '204': description: Response @@ -84072,9 +86707,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: + - *341 - *342 - - *343 - - *578 + - *577 - *17 - *19 responses: @@ -84086,7 +86721,7 @@ paths: type: array items: *84 examples: - default: *555 + default: *554 headers: Link: *67 x-github: @@ -84105,12 +86740,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: + - *341 - *342 - - *343 + - *578 - *579 - - *580 - *92 - - *581 + - *580 - *17 - *19 responses: @@ -84122,7 +86757,7 @@ paths: type: array items: *112 examples: - default: *582 + default: *581 headers: Link: *67 x-github: @@ -84146,8 +86781,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: + - *341 - *342 - - *343 requestBody: required: false content: @@ -84205,14 +86840,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: &583 + schema: &582 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -84337,7 +86972,7 @@ paths: - custom_404 - public examples: - default: &584 + default: &583 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -84378,8 +87013,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -84433,9 +87068,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *582 examples: - default: *584 + default: *583 '422': *15 '409': *54 x-github: @@ -84458,8 +87093,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -84558,8 +87193,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -84585,8 +87220,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -84596,7 +87231,7 @@ paths: application/json: schema: type: array - items: &585 + items: &584 title: Page Build description: Page Build type: object @@ -84690,8 +87325,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: + - *341 - *342 - - *343 responses: '201': description: Response @@ -84736,16 +87371,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *585 + schema: *584 examples: - default: &586 + default: &585 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -84793,8 +87428,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: + - *341 - *342 - - *343 - name: build_id in: path required: true @@ -84805,9 +87440,9 @@ paths: description: Response content: application/json: - schema: *585 + schema: *584 examples: - default: *586 + default: *585 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84827,8 +87462,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -84933,9 +87568,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: + - *341 - *342 - - *343 - - &587 + - &586 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -84993,11 +87628,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: + - *341 - *342 - - *343 - - *587 + - *586 responses: - '204': *192 + '204': *191 '404': *6 x-github: githubCloudOnly: false @@ -85022,8 +87657,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -85254,7 +87889,7 @@ paths: description: Empty response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -85281,8 +87916,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: + - *341 - *342 - - *343 responses: '200': description: Private vulnerability reporting status @@ -85319,10 +87954,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: + - *341 - *342 - - *343 responses: - '204': *192 + '204': *191 '422': *14 x-github: githubCloudOnly: false @@ -85341,10 +87976,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: + - *341 - *342 - - *343 responses: - '204': *192 + '204': *191 '422': *14 x-github: githubCloudOnly: false @@ -85364,8 +87999,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -85373,7 +88008,7 @@ paths: application/json: schema: type: array - items: *294 + items: *293 examples: default: value: @@ -85404,8 +88039,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: + - *341 - *342 - - *343 requestBody: required: true content: @@ -85417,7 +88052,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *294 + items: *293 required: - properties examples: @@ -85467,8 +88102,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: + - *341 - *342 - - *343 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -85528,9 +88163,9 @@ paths: application/json: schema: type: array - items: *480 + items: *479 examples: - default: *588 + default: *587 headers: Link: *67 '304': *37 @@ -85562,8 +88197,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -85628,7 +88263,7 @@ paths: description: Response content: application/json: - schema: &592 + schema: &591 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -85739,8 +88374,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *279 - required: *280 + properties: *278 + required: *279 nullable: true active_lock_reason: type: string @@ -85772,7 +88407,7 @@ paths: items: *4 requested_teams: type: array - items: *331 + items: *330 head: type: object properties: @@ -85810,14 +88445,14 @@ paths: _links: type: object properties: - comments: *281 - commits: *281 - statuses: *281 - html: *281 - issue: *281 - review_comments: *281 - review_comment: *281 - self: *281 + comments: *280 + commits: *280 + statuses: *280 + html: *280 + issue: *280 + review_comments: *280 + review_comment: *280 + self: *280 required: - comments - commits @@ -85828,7 +88463,7 @@ paths: - review_comment - self author_association: *82 - auto_merge: *589 + auto_merge: *588 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -85918,7 +88553,7 @@ paths: - merged_by - review_comments examples: - default: &593 + default: &592 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -86445,8 +89080,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: + - *341 - *342 - - *343 - name: sort in: query required: false @@ -86475,9 +89110,9 @@ paths: application/json: schema: type: array - items: *590 + items: *589 examples: - default: &595 + default: &594 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -86554,17 +89189,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: + - *341 - *342 - - *343 - *101 responses: '200': description: Response content: application/json: - schema: *590 + schema: *589 examples: - default: &591 + default: &590 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -86639,8 +89274,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: + - *341 - *342 - - *343 - *101 requestBody: required: true @@ -86663,9 +89298,9 @@ paths: description: Response content: application/json: - schema: *590 + schema: *589 examples: - default: *591 + default: *590 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86681,8 +89316,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: + - *341 - *342 - - *343 - *101 responses: '204': @@ -86704,8 +89339,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: + - *341 - *342 - - *343 - *101 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -86732,9 +89367,9 @@ paths: application/json: schema: type: array - items: *474 + items: *473 examples: - default: *545 + default: *544 headers: Link: *67 '404': *6 @@ -86755,8 +89390,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: + - *341 - *342 - - *343 - *101 requestBody: required: true @@ -86789,16 +89424,16 @@ paths: description: Reaction exists content: application/json: - schema: *474 + schema: *473 examples: - default: *475 + default: *474 '201': description: Reaction created content: application/json: - schema: *474 + schema: *473 examples: - default: *475 + default: *474 '422': *15 x-github: githubCloudOnly: false @@ -86820,10 +89455,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: + - *341 - *342 - - *343 - *101 - - *546 + - *545 responses: '204': description: Response @@ -86866,9 +89501,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: + - *341 - *342 - - *343 - - &594 + - &593 name: pull_number description: The number that identifies the pull request. in: path @@ -86881,9 +89516,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *592 + schema: *591 examples: - default: *593 + default: *592 '304': *37 '404': *6 '406': @@ -86918,9 +89553,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 requestBody: required: false content: @@ -86962,9 +89597,9 @@ paths: description: Response content: application/json: - schema: *592 + schema: *591 examples: - default: *593 + default: *592 '422': *15 '403': *29 x-github: @@ -86986,9 +89621,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 requestBody: required: true content: @@ -87048,17 +89683,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '401': *25 '403': *29 '404': *6 @@ -87088,9 +89723,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 - *109 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -87111,9 +89746,9 @@ paths: application/json: schema: type: array - items: *590 + items: *589 examples: - default: *595 + default: *594 headers: Link: *67 x-github: @@ -87146,9 +89781,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 requestBody: required: true content: @@ -87253,7 +89888,7 @@ paths: description: Response content: application/json: - schema: *590 + schema: *589 examples: example-for-a-multi-line-comment: value: @@ -87341,9 +89976,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: + - *341 - *342 - - *343 - - *594 + - *593 - *101 requestBody: required: true @@ -87366,7 +90001,7 @@ paths: description: Response content: application/json: - schema: *590 + schema: *589 examples: default: value: @@ -87452,9 +90087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 - *17 - *19 responses: @@ -87464,9 +90099,9 @@ paths: application/json: schema: type: array - items: *476 + items: *475 examples: - default: *596 + default: *595 headers: Link: *67 x-github: @@ -87496,9 +90131,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: + - *341 - *342 - - *343 - - *594 + - *593 - *17 - *19 responses: @@ -87508,7 +90143,7 @@ paths: application/json: schema: type: array - items: *489 + items: *488 examples: default: value: @@ -87546,9 +90181,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: + - *341 - *342 - - *343 - - *594 + - *593 responses: '204': description: Response if pull request has been merged @@ -87571,9 +90206,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 requestBody: required: false content: @@ -87684,9 +90319,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 responses: '200': description: Response @@ -87702,7 +90337,7 @@ paths: items: *4 teams: type: array - items: *198 + items: *197 required: - users - teams @@ -87761,9 +90396,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 requestBody: required: false content: @@ -87800,7 +90435,7 @@ paths: description: Response content: application/json: - schema: *480 + schema: *479 examples: default: value: @@ -88336,9 +90971,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 requestBody: required: true content: @@ -88372,7 +91007,7 @@ paths: description: Response content: application/json: - schema: *480 + schema: *479 examples: default: value: @@ -88877,9 +91512,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 - *17 - *19 responses: @@ -88889,7 +91524,7 @@ paths: application/json: schema: type: array - items: &597 + items: &596 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -89040,9 +91675,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 + - *593 requestBody: required: false content: @@ -89128,9 +91763,9 @@ paths: description: Response content: application/json: - schema: *597 + schema: *596 examples: - default: &599 + default: &598 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -89193,10 +91828,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 - - &598 + - *593 + - &597 name: review_id description: The unique identifier of the review. in: path @@ -89208,9 +91843,9 @@ paths: description: Response content: application/json: - schema: *597 + schema: *596 examples: - default: &600 + default: &599 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -89269,10 +91904,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 - - *598 + - *593 + - *597 requestBody: required: true content: @@ -89295,7 +91930,7 @@ paths: description: Response content: application/json: - schema: *597 + schema: *596 examples: default: value: @@ -89357,18 +91992,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 - - *598 + - *593 + - *597 responses: '200': description: Response content: application/json: - schema: *597 + schema: *596 examples: - default: *599 + default: *598 '422': *7 '404': *6 x-github: @@ -89395,10 +92030,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: + - *341 - *342 - - *343 - - *594 - - *598 + - *593 + - *597 - *17 - *19 responses: @@ -89481,9 +92116,9 @@ paths: _links: type: object properties: - self: *281 - html: *281 - pull_request: *281 + self: *280 + html: *280 + pull_request: *280 required: - self - html @@ -89633,10 +92268,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 - - *598 + - *593 + - *597 requestBody: required: true content: @@ -89664,7 +92299,7 @@ paths: description: Response content: application/json: - schema: *597 + schema: *596 examples: default: value: @@ -89727,10 +92362,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: + - *341 - *342 - - *343 - - *594 - - *598 + - *593 + - *597 requestBody: required: true content: @@ -89765,9 +92400,9 @@ paths: description: Response content: application/json: - schema: *597 + schema: *596 examples: - default: *600 + default: *599 '404': *6 '422': *7 '403': *29 @@ -89789,9 +92424,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: + - *341 - *342 - - *343 - - *594 + - *593 requestBody: required: false content: @@ -89854,8 +92489,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: + - *341 - *342 - - *343 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -89868,9 +92503,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *600 examples: - default: &602 + default: &601 value: type: file encoding: base64 @@ -89912,8 +92547,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: + - *341 - *342 - - *343 - name: dir description: The alternate path to look for a README file in: path @@ -89933,9 +92568,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *600 examples: - default: *602 + default: *601 '404': *6 '422': *15 x-github: @@ -89957,8 +92592,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -89968,7 +92603,7 @@ paths: application/json: schema: type: array - items: *603 + items: *602 examples: default: value: @@ -90062,8 +92697,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -90139,9 +92774,9 @@ paths: description: Response content: application/json: - schema: *603 + schema: *602 examples: - default: &607 + default: &606 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -90246,9 +92881,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: + - *341 - *342 - - *343 - - &605 + - &604 name: asset_id description: The unique identifier of the asset. in: path @@ -90260,9 +92895,9 @@ paths: description: Response content: application/json: - schema: *604 + schema: *603 examples: - default: &606 + default: &605 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 @@ -90297,7 +92932,7 @@ paths: type: User site_admin: false '404': *6 - '302': *491 + '302': *490 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90313,9 +92948,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: + - *341 - *342 - - *343 - - *605 + - *604 requestBody: required: false content: @@ -90343,9 +92978,9 @@ paths: description: Response content: application/json: - schema: *604 + schema: *603 examples: - default: *606 + default: *605 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90361,9 +92996,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: + - *341 - *342 - - *343 - - *605 + - *604 responses: '204': description: Response @@ -90388,8 +93023,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -90474,16 +93109,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: + - *341 - *342 - - *343 responses: '200': description: Response content: application/json: - schema: *603 + schema: *602 examples: - default: *607 + default: *606 '404': *6 x-github: githubCloudOnly: false @@ -90501,8 +93136,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: + - *341 - *342 - - *343 - name: tag description: tag parameter in: path @@ -90515,9 +93150,9 @@ paths: description: Response content: application/json: - schema: *603 + schema: *602 examples: - default: *607 + default: *606 '404': *6 x-github: githubCloudOnly: false @@ -90539,9 +93174,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: + - *341 - *342 - - *343 - - &608 + - &607 name: release_id description: The unique identifier of the release. in: path @@ -90555,9 +93190,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: *603 + schema: *602 examples: - default: *607 + default: *606 '401': description: Unauthorized x-github: @@ -90575,9 +93210,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: + - *341 - *342 - - *343 - - *608 + - *607 requestBody: required: false content: @@ -90641,9 +93276,9 @@ paths: description: Response content: application/json: - schema: *603 + schema: *602 examples: - default: *607 + default: *606 '404': description: Not Found if the discussion category name is invalid content: @@ -90664,9 +93299,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: + - *341 - *342 - - *343 - - *608 + - *607 responses: '204': description: Response @@ -90687,9 +93322,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: + - *341 - *342 - - *343 - - *608 + - *607 - *17 - *19 responses: @@ -90699,7 +93334,7 @@ paths: application/json: schema: type: array - items: *604 + items: *603 examples: default: value: @@ -90780,9 +93415,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: + - *341 - *342 - - *343 - - *608 + - *607 - name: name in: query required: true @@ -90808,7 +93443,7 @@ paths: description: Response for successful upload content: application/json: - schema: *604 + schema: *603 examples: response-for-successful-upload: value: @@ -90863,9 +93498,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: + - *341 - *342 - - *343 - - *608 + - *607 - 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. @@ -90889,9 +93524,9 @@ paths: application/json: schema: type: array - items: *474 + items: *473 examples: - default: *545 + default: *544 headers: Link: *67 '404': *6 @@ -90912,9 +93547,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: + - *341 - *342 - - *343 - - *608 + - *607 requestBody: required: true content: @@ -90944,16 +93579,16 @@ paths: description: Reaction exists content: application/json: - schema: *474 + schema: *473 examples: - default: *475 + default: *474 '201': description: Reaction created content: application/json: - schema: *474 + schema: *473 examples: - default: *475 + default: *474 '422': *15 x-github: githubCloudOnly: false @@ -90975,10 +93610,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: + - *341 - *342 - - *343 - - *608 - - *546 + - *607 + - *545 responses: '204': description: Response @@ -91002,9 +93637,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: + - *341 - *342 - - *343 - - *409 + - *408 - *17 - *19 responses: @@ -91020,8 +93655,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *303 - - &609 + - *302 + - &608 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -91040,69 +93675,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. + - allOf: + - *303 + - *608 - allOf: - *304 - - *609 + - *608 - allOf: - *305 - - *609 + - *608 - allOf: - - *306 - *609 + - *608 - allOf: - - *610 - - *609 + - *306 + - *608 - allOf: - *307 - - *609 + - *608 - allOf: - *308 - - *609 + - *608 - allOf: - *309 - - *609 + - *608 - allOf: - *310 - - *609 + - *608 - allOf: - *311 - - *609 + - *608 - allOf: - *312 - - *609 + - *608 - allOf: - *313 - - *609 + - *608 - allOf: - *314 - - *609 + - *608 - allOf: - *315 - - *609 + - *608 - allOf: - *316 - - *609 + - *608 - allOf: - *317 - - *609 + - *608 - allOf: - *318 - - *609 + - *608 - allOf: - *319 - - *609 + - *608 - allOf: - *320 - - *609 + - *608 - allOf: - *321 - - *609 + - *608 - allOf: - *322 - - *609 - - allOf: - - *323 - - *609 + - *608 examples: default: value: @@ -91141,8 +93776,8 @@ paths: category: repos subcategory: rules parameters: + - *341 - *342 - - *343 - *17 - *19 - name: includes_parents @@ -91153,7 +93788,7 @@ paths: schema: type: boolean default: true - - *611 + - *610 responses: '200': description: Response @@ -91161,7 +93796,7 @@ paths: application/json: schema: type: array - items: *324 + items: *323 examples: default: value: @@ -91208,8 +93843,8 @@ paths: category: repos subcategory: rules parameters: + - *341 - *342 - - *343 requestBody: description: Request body required: true @@ -91229,16 +93864,16 @@ paths: - tag - push default: branch - enforcement: *300 + enforcement: *299 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *301 - conditions: *298 + items: *300 + conditions: *297 rules: type: array description: An array of rules within the ruleset. - items: *612 + items: *611 required: - name - enforcement @@ -91269,9 +93904,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *323 examples: - default: &622 + default: &621 value: id: 42 name: super cool ruleset @@ -91319,12 +93954,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: + - *341 - *342 - - *343 + - *612 - *613 - *614 - *615 - - *616 - *17 - *19 responses: @@ -91332,9 +93967,9 @@ paths: description: Response content: application/json: - schema: *617 + schema: *616 examples: - default: *618 + default: *617 '404': *6 '500': *55 x-github: @@ -91355,17 +93990,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: + - *341 - *342 - - *343 - - *619 + - *618 responses: '200': description: Response content: application/json: - schema: *620 + schema: *619 examples: - default: *621 + default: *620 '404': *6 '500': *55 x-github: @@ -91393,8 +94028,8 @@ paths: category: repos subcategory: rules parameters: + - *341 - *342 - - *343 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91414,9 +94049,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *323 examples: - default: *622 + default: *621 '404': *6 '500': *55 put: @@ -91434,8 +94069,8 @@ paths: category: repos subcategory: rules parameters: + - *341 - *342 - - *343 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91460,16 +94095,16 @@ paths: - branch - tag - push - enforcement: *300 + enforcement: *299 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *301 - conditions: *298 + items: *300 + conditions: *297 rules: description: An array of rules within the ruleset. type: array - items: *612 + items: *611 examples: default: value: @@ -91497,9 +94132,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *323 examples: - default: *622 + default: *621 '404': *6 '422': *15 '500': *55 @@ -91518,8 +94153,8 @@ paths: category: repos subcategory: rules parameters: + - *341 - *342 - - *343 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91542,8 +94177,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: + - *341 - *342 - - *343 - *17 - *19 - name: ruleset_id @@ -91559,9 +94194,9 @@ paths: application/json: schema: type: array - items: *327 + items: *326 examples: - default: *623 + default: *622 '404': *6 '500': *55 x-github: @@ -91580,8 +94215,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: + - *341 - *342 - - *343 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91599,7 +94234,7 @@ paths: description: Response content: application/json: - schema: *624 + schema: *623 examples: default: value: @@ -91654,22 +94289,22 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: + - *341 - *342 - - *343 + - *624 - *625 - *626 - *627 - *628 - - *629 - *61 - *19 - *17 + - *629 - *630 - *631 - *632 - *633 - *634 - - *635 responses: '200': description: Response @@ -91677,11 +94312,11 @@ paths: application/json: schema: type: array - items: &639 + items: &638 type: object properties: - number: *179 - created_at: *180 + number: *178 + created_at: *179 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -91689,15 +94324,15 @@ paths: format: date-time readOnly: true nullable: true - url: *182 - html_url: *183 + url: *181 + html_url: *182 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *636 - resolution: *637 + state: *635 + resolution: *636 resolved_at: type: string format: date-time @@ -91793,7 +94428,7 @@ paths: pull request. ' - oneOf: *638 + oneOf: *637 nullable: true has_more_locations: type: boolean @@ -91942,16 +94577,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: + - *341 - *342 - - *343 - - *440 - - *635 + - *439 + - *634 responses: '200': description: Response content: application/json: - schema: *639 + schema: *638 examples: default: value: @@ -92005,9 +94640,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: + - *341 - *342 - - *343 - - *440 + - *439 requestBody: required: true content: @@ -92015,8 +94650,8 @@ paths: schema: type: object properties: - state: *636 - resolution: *637 + state: *635 + resolution: *636 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -92052,7 +94687,7 @@ paths: description: Response content: application/json: - schema: *639 + schema: *638 examples: default: value: @@ -92147,9 +94782,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: + - *341 - *342 - - *343 - - *440 + - *439 - *19 - *17 responses: @@ -92160,7 +94795,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &797 + items: &796 type: object properties: type: @@ -92186,6 +94821,7 @@ paths: example: commit details: oneOf: + - *639 - *640 - *641 - *642 @@ -92198,7 +94834,6 @@ paths: - *649 - *650 - *651 - - *652 examples: default: value: @@ -92284,8 +94919,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -92293,14 +94928,14 @@ paths: schema: type: object properties: - reason: &654 + reason: &653 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *653 + placeholder_id: *652 required: - reason - placeholder_id @@ -92317,7 +94952,7 @@ paths: schema: type: object properties: - reason: *654 + reason: *653 expire_at: type: string format: date-time @@ -92363,8 +94998,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: + - *341 - *342 - - *343 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -92379,7 +95014,7 @@ paths: properties: incremental_scans: type: array - items: &655 + items: &654 description: Information on a single scan performed by secret scanning on the repository type: object @@ -92405,15 +95040,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *655 + items: *654 backfill_scans: type: array - items: *655 + items: *654 custom_pattern_backfill_scans: type: array items: allOf: - - *655 + - *654 - type: object properties: pattern_name: @@ -92483,8 +95118,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: + - *341 - *342 - - *343 - *61 - name: sort description: The property to sort the results by. @@ -92528,9 +95163,9 @@ paths: application/json: schema: type: array - items: *656 + items: *655 examples: - default: *657 + default: *656 '400': *14 '404': *6 x-github: @@ -92553,8 +95188,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -92627,7 +95262,7 @@ paths: login: type: string description: The username of the user credited. - type: *330 + type: *329 required: - login - type @@ -92714,9 +95349,9 @@ paths: description: Response content: application/json: - schema: *656 + schema: *655 examples: - default: &659 + default: &658 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -92949,8 +95584,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -93054,7 +95689,7 @@ paths: description: Response content: application/json: - schema: *656 + schema: *655 examples: default: value: @@ -93201,17 +95836,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: + - *341 - *342 - - *343 - - *658 + - *657 responses: '200': description: Response content: application/json: - schema: *656 + schema: *655 examples: - default: *659 + default: *658 '403': *29 '404': *6 x-github: @@ -93235,9 +95870,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: + - *341 - *342 - - *343 - - *658 + - *657 requestBody: required: true content: @@ -93310,7 +95945,7 @@ paths: login: type: string description: The username of the user credited. - type: *330 + type: *329 required: - login - type @@ -93396,10 +96031,10 @@ paths: description: Response content: application/json: - schema: *656 + schema: *655 examples: - default: *659 - add_credit: *659 + default: *658 + add_credit: *658 '403': *29 '404': *6 '422': @@ -93437,9 +96072,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: + - *341 - *342 - - *343 - - *658 + - *657 responses: '202': *39 '400': *14 @@ -93466,17 +96101,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: + - *341 - *342 - - *343 - - *658 + - *657 responses: '202': description: Response content: application/json: - schema: *345 + schema: *344 examples: - default: *347 + default: *346 '400': *14 '422': *15 '403': *29 @@ -93502,8 +96137,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -93602,8 +96237,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: + - *341 - *342 - - *343 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -93612,7 +96247,7 @@ paths: application/json: schema: type: array - items: &660 + items: &659 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -93625,7 +96260,7 @@ paths: - 1124 - -435 '202': *39 - '204': *192 + '204': *191 '422': description: Repository contains more than 10,000 commits x-github: @@ -93645,8 +96280,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -93695,7 +96330,7 @@ paths: total: 89 week: 1336280400 '202': *39 - '204': *192 + '204': *191 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93722,8 +96357,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -93797,7 +96432,7 @@ paths: d: 77 c: 10 '202': *39 - '204': *192 + '204': *191 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93819,8 +96454,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: + - *341 - *342 - - *343 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -93974,8 +96609,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: + - *341 - *342 - - *343 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -93985,7 +96620,7 @@ paths: application/json: schema: type: array - items: *660 + items: *659 examples: default: value: @@ -93998,7 +96633,7 @@ paths: - - 0 - 2 - 21 - '204': *192 + '204': *191 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94018,8 +96653,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: + - *341 - *342 - - *343 - name: sha in: path required: true @@ -94073,7 +96708,7 @@ paths: description: Response content: application/json: - schema: *661 + schema: *660 examples: default: value: @@ -94127,8 +96762,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -94160,14 +96795,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: + - *341 - *342 - - *343 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &662 + schema: &661 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -94235,8 +96870,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: + - *341 - *342 - - *343 requestBody: required: false content: @@ -94262,7 +96897,7 @@ paths: description: Response content: application/json: - schema: *662 + schema: *661 examples: default: value: @@ -94289,8 +96924,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -94310,8 +96945,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -94390,8 +97025,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: + - *341 - *342 - - *343 - name: ref in: path required: true @@ -94427,8 +97062,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: + - *341 - *342 - - *343 - *17 - *19 responses: @@ -94438,9 +97073,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *259 + default: *258 headers: Link: *67 '404': *6 @@ -94460,8 +97095,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: + - *341 - *342 - - *343 - *19 - *17 responses: @@ -94469,7 +97104,7 @@ paths: description: Response content: application/json: - schema: &663 + schema: &662 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -94481,7 +97116,7 @@ paths: required: - names examples: - default: &664 + default: &663 value: names: - octocat @@ -94504,8 +97139,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -94536,9 +97171,9 @@ paths: description: Response content: application/json: - schema: *663 + schema: *662 examples: - default: *664 + default: *663 '404': *6 '422': *7 x-github: @@ -94559,9 +97194,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: + - *341 - *342 - - *343 - - &665 + - &664 name: per description: The time frame to display results for. in: query @@ -94590,7 +97225,7 @@ paths: example: 128 clones: type: array - items: &666 + items: &665 title: Traffic type: object properties: @@ -94677,8 +97312,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -94768,8 +97403,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: + - *341 - *342 - - *343 responses: '200': description: Response @@ -94829,9 +97464,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: + - *341 - *342 - - *343 - - *665 + - *664 responses: '200': description: Response @@ -94850,7 +97485,7 @@ paths: example: 3782 views: type: array - items: *666 + items: *665 required: - uniques - count @@ -94927,8 +97562,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: + - *341 - *342 - - *343 requestBody: required: true content: @@ -94964,7 +97599,7 @@ paths: description: Response content: application/json: - schema: *161 + schema: *160 examples: default: value: @@ -95202,8 +97837,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: + - *341 - *342 - - *343 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -95226,8 +97861,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -95249,8 +97884,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -95276,8 +97911,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: + - *341 - *342 - - *343 - name: ref in: path required: true @@ -95369,9 +98004,9 @@ paths: description: Response content: application/json: - schema: *345 + schema: *344 examples: - default: *347 + default: *346 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -95412,7 +98047,7 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: default: value: @@ -95518,8 +98153,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *150 - - *551 + - *149 + - *550 requestBody: required: true content: @@ -95583,9 +98218,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *554 + items: *553 examples: - default: *667 + default: *666 '400': *14 '403': *29 '404': *6 @@ -95621,8 +98256,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *150 - - *551 + - *149 + - *550 requestBody: required: true content: @@ -95687,9 +98322,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *554 + items: *553 examples: - default: *667 + default: *666 '400': *14 '403': *29 '404': *6 @@ -95720,9 +98355,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: - - *150 - - *551 - - *241 + - *149 + - *550 + - *240 responses: '204': description: Issue field value deleted successfully @@ -95843,7 +98478,7 @@ paths: html_url: type: string format: uri - repository: *161 + repository: *160 score: type: number file_size: @@ -95861,7 +98496,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &668 + text_matches: &667 title: Search Result Text Matches type: array items: @@ -96023,7 +98658,7 @@ paths: enum: - author-date - committer-date - - &669 + - &668 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 @@ -96094,7 +98729,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *407 + properties: *406 nullable: true comment_count: type: integer @@ -96114,7 +98749,7 @@ paths: url: type: string format: uri - verification: *528 + verification: *527 required: - author - committer @@ -96133,7 +98768,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *407 + properties: *406 nullable: true parents: type: array @@ -96146,12 +98781,12 @@ paths: type: string sha: type: string - repository: *161 + repository: *160 score: type: number node_id: type: string - text_matches: *668 + text_matches: *667 required: - sha - node_id @@ -96343,7 +98978,7 @@ paths: - interactions - created - updated - - *669 + - *668 - *17 - *19 - name: advanced_search @@ -96457,11 +99092,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: type: string state_reason: @@ -96471,8 +99106,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *279 - required: *280 + properties: *278 + required: *279 nullable: true comments: type: integer @@ -96486,7 +99121,7 @@ paths: type: string format: date-time nullable: true - text_matches: *668 + text_matches: *667 pull_request: type: object properties: @@ -96530,7 +99165,7 @@ paths: timeline_url: type: string format: uri - type: *242 + type: *241 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -96757,7 +99392,7 @@ paths: enum: - created - updated - - *669 + - *668 - *17 - *19 responses: @@ -96801,7 +99436,7 @@ paths: nullable: true score: type: number - text_matches: *668 + text_matches: *667 required: - id - node_id @@ -96886,7 +99521,7 @@ paths: - forks - help-wanted-issues - updated - - *669 + - *668 - *17 - *19 responses: @@ -97134,7 +99769,7 @@ paths: - admin - pull - push - text_matches: *668 + text_matches: *667 temp_clone_token: type: string allow_merge_commit: @@ -97434,7 +100069,7 @@ paths: type: string format: uri nullable: true - text_matches: *668 + text_matches: *667 related: type: array nullable: true @@ -97625,7 +100260,7 @@ paths: - followers - repositories - joined - - *669 + - *668 - *17 - *19 responses: @@ -97729,7 +100364,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *668 + text_matches: *667 blog: type: string nullable: true @@ -97808,7 +100443,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &672 + - &671 name: team_id description: The unique identifier of the team. in: path @@ -97820,9 +100455,9 @@ paths: description: Response content: application/json: - schema: *338 + schema: *337 examples: - default: *339 + default: *338 '404': *6 x-github: githubCloudOnly: false @@ -97849,7 +100484,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *672 + - *671 requestBody: required: true content: @@ -97912,16 +100547,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *338 + schema: *337 examples: - default: *339 + default: *338 '201': description: Response content: application/json: - schema: *338 + schema: *337 examples: - default: *339 + default: *338 '404': *6 '422': *15 '403': *29 @@ -97949,7 +100584,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *672 + - *671 responses: '204': description: Response @@ -97978,7 +100613,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *672 + - *671 - *17 - *19 responses: @@ -97988,9 +100623,9 @@ paths: application/json: schema: type: array - items: *236 + items: *235 examples: - default: *237 + default: *236 headers: Link: *67 x-github: @@ -98016,7 +100651,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *672 + - *671 - name: role description: Filters members returned by their role in the team. in: query @@ -98067,7 +100702,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *672 + - *671 - *71 responses: '204': @@ -98104,7 +100739,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *672 + - *671 - *71 responses: '204': @@ -98144,7 +100779,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *672 + - *671 - *71 responses: '204': @@ -98181,16 +100816,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *672 + - *671 - *71 responses: '200': description: Response content: application/json: - schema: *341 + schema: *340 examples: - response-if-user-is-a-team-maintainer: *673 + response-if-user-is-a-team-maintainer: *672 '404': *6 x-github: githubCloudOnly: false @@ -98223,7 +100858,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *672 + - *671 - *71 requestBody: required: false @@ -98249,9 +100884,9 @@ paths: description: Response content: application/json: - schema: *341 + schema: *340 examples: - response-if-users-membership-with-team-is-now-pending: *674 + response-if-users-membership-with-team-is-now-pending: *673 '403': description: Forbidden if team synchronization is set up '422': @@ -98285,7 +100920,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *672 + - *671 - *71 responses: '204': @@ -98313,7 +100948,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *672 + - *671 - *17 - *19 responses: @@ -98323,9 +100958,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *273 + default: *272 headers: Link: *67 '404': *6 @@ -98355,15 +100990,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *672 + - *671 + - *341 - *342 - - *343 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *675 + schema: *674 examples: alternative-response-with-extra-repository-information: value: @@ -98514,9 +101149,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *672 + - *671 + - *341 - *342 - - *343 requestBody: required: false content: @@ -98566,9 +101201,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *672 + - *671 + - *341 - *342 - - *343 responses: '204': description: Response @@ -98593,7 +101228,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *672 + - *671 - *17 - *19 responses: @@ -98603,9 +101238,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - response-if-child-teams-exist: *676 + response-if-child-teams-exist: *675 headers: Link: *67 '404': *6 @@ -98638,7 +101273,7 @@ paths: application/json: schema: oneOf: - - &677 + - &676 title: Private User description: Private User type: object @@ -98841,7 +101476,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - &703 + - &702 title: Public User description: Public User type: object @@ -99153,7 +101788,7 @@ paths: description: Response content: application/json: - schema: *677 + schema: *676 examples: default: value: @@ -99356,9 +101991,9 @@ paths: type: integer codespaces: type: array - items: *247 + items: *246 examples: - default: *248 + default: *247 '304': *37 '500': *55 '401': *25 @@ -99497,17 +102132,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '401': *25 '403': *29 '404': *6 @@ -99551,7 +102186,7 @@ paths: type: integer secrets: type: array - items: &678 + items: &677 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -99591,7 +102226,7 @@ paths: - visibility - selected_repositories_url examples: - default: *466 + default: *465 headers: Link: *67 x-github: @@ -99661,13 +102296,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *169 + - *168 responses: '200': description: Response content: application/json: - schema: *678 + schema: *677 examples: default: value: @@ -99697,7 +102332,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *169 + - *168 requestBody: required: true content: @@ -99742,7 +102377,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -99770,7 +102405,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *169 + - *168 responses: '204': description: Response @@ -99795,7 +102430,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *169 + - *168 responses: '200': description: Response @@ -99811,9 +102446,9 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 examples: - default: *199 + default: *198 '401': *25 '403': *29 '404': *6 @@ -99838,7 +102473,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *169 + - *168 requestBody: required: true content: @@ -99892,7 +102527,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *169 + - *168 - name: repository_id in: path required: true @@ -99925,7 +102560,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *169 + - *168 - name: repository_id in: path required: true @@ -99957,15 +102592,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *249 + - *248 responses: '200': description: Response content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '304': *37 '500': *55 '401': *25 @@ -99991,7 +102626,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *249 + - *248 requestBody: required: false content: @@ -100021,9 +102656,9 @@ paths: description: Response content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '401': *25 '403': *29 '404': *6 @@ -100045,7 +102680,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *249 + - *248 responses: '202': *39 '304': *37 @@ -100074,13 +102709,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *249 + - *248 responses: '202': description: Response content: application/json: - schema: &679 + schema: &678 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -100121,7 +102756,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &680 + default: &679 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -100153,7 +102788,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *249 + - *248 - name: export_id in: path required: true @@ -100166,9 +102801,9 @@ paths: description: Response content: application/json: - schema: *679 + schema: *678 examples: - default: *680 + default: *679 '404': *6 x-github: githubCloudOnly: false @@ -100189,7 +102824,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *249 + - *248 responses: '200': description: Response @@ -100205,9 +102840,9 @@ paths: type: integer machines: type: array - items: *681 + items: *680 examples: - default: *682 + default: *681 '304': *37 '500': *55 '401': *25 @@ -100236,7 +102871,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *249 + - *248 requestBody: required: true content: @@ -100286,13 +102921,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *345 + repository: *344 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *464 - required: *465 + properties: *463 + required: *464 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -101066,15 +103701,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *249 + - *248 responses: '200': description: Response content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '304': *37 '500': *55 '400': *14 @@ -101106,15 +103741,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *249 + - *248 responses: '200': description: Response content: application/json: - schema: *247 + schema: *246 examples: - default: *463 + default: *462 '500': *55 '401': *25 '403': *29 @@ -101144,9 +103779,9 @@ paths: application/json: schema: type: array - items: *260 + items: *259 examples: - default: &693 + default: &692 value: - id: 197 name: hello_docker @@ -101247,7 +103882,7 @@ paths: application/json: schema: type: array - items: &683 + items: &682 title: Email description: Email type: object @@ -101312,9 +103947,9 @@ paths: application/json: schema: type: array - items: *683 + items: *682 examples: - default: &695 + default: &694 value: - email: octocat@github.com verified: true @@ -101389,7 +104024,7 @@ paths: application/json: schema: type: array - items: *683 + items: *682 examples: default: value: @@ -101645,7 +104280,7 @@ paths: application/json: schema: type: array - items: &684 + items: &683 title: GPG Key description: A unique encryption key type: object @@ -101776,7 +104411,7 @@ paths: - subkeys - revoked examples: - default: &712 + default: &711 value: - id: 3 name: Octocat's GPG Key @@ -101861,9 +104496,9 @@ paths: description: Response content: application/json: - schema: *684 + schema: *683 examples: - default: &685 + default: &684 value: id: 3 name: Octocat's GPG Key @@ -101920,7 +104555,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &686 + - &685 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -101932,9 +104567,9 @@ paths: description: Response content: application/json: - schema: *684 + schema: *683 examples: - default: *685 + default: *684 '404': *6 '304': *37 '403': *29 @@ -101957,7 +104592,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *686 + - *685 responses: '204': description: Response @@ -102150,7 +104785,7 @@ paths: allOf: - *79 examples: - default: *153 + default: *152 headers: Link: *67 '404': *6 @@ -102176,7 +104811,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *150 + - *149 responses: '204': description: Response @@ -102202,7 +104837,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *150 + - *149 responses: '204': description: Response @@ -102236,12 +104871,12 @@ paths: application/json: schema: anyOf: - - *234 + - *233 - type: object properties: {} additionalProperties: false examples: - default: *235 + default: *234 '204': description: Response when there are no restrictions x-github: @@ -102265,7 +104900,7 @@ paths: required: true content: application/json: - schema: *539 + schema: *538 examples: default: value: @@ -102276,7 +104911,7 @@ paths: description: Response content: application/json: - schema: *234 + schema: *233 examples: default: value: @@ -102357,7 +104992,7 @@ paths: - closed - all default: open - - *245 + - *244 - name: sort description: What to sort results by. in: query @@ -102382,7 +105017,7 @@ paths: type: array items: *85 examples: - default: *246 + default: *245 headers: Link: *67 '404': *6 @@ -102415,7 +105050,7 @@ paths: application/json: schema: type: array - items: &687 + items: &686 title: Key description: Key type: object @@ -102516,9 +105151,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *686 examples: - default: &688 + default: &687 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -102551,15 +105186,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *573 + - *572 responses: '200': description: Response content: application/json: - schema: *687 + schema: *686 examples: - default: *688 + default: *687 '404': *6 '304': *37 '403': *29 @@ -102582,7 +105217,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *573 + - *572 responses: '204': description: Response @@ -102615,7 +105250,7 @@ paths: application/json: schema: type: array - items: &689 + items: &688 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -102683,7 +105318,7 @@ paths: - account - plan examples: - default: &690 + default: &689 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -102745,9 +105380,9 @@ paths: application/json: schema: type: array - items: *689 + items: *688 examples: - default: *690 + default: *689 headers: Link: *67 '304': *37 @@ -102787,7 +105422,7 @@ paths: application/json: schema: type: array - items: *251 + items: *250 examples: default: value: @@ -102901,7 +105536,7 @@ paths: description: Response content: application/json: - schema: *251 + schema: *250 examples: default: value: @@ -102988,7 +105623,7 @@ paths: description: Response content: application/json: - schema: *251 + schema: *250 examples: default: value: @@ -103060,7 +105695,7 @@ paths: application/json: schema: type: array - items: *253 + items: *252 examples: default: value: @@ -103313,7 +105948,7 @@ paths: description: Response content: application/json: - schema: *253 + schema: *252 examples: default: value: @@ -103493,7 +106128,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *254 + - *253 - name: exclude in: query required: false @@ -103506,7 +106141,7 @@ paths: description: Response content: application/json: - schema: *253 + schema: *252 examples: default: value: @@ -103700,7 +106335,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *254 + - *253 responses: '302': description: Response @@ -103726,7 +106361,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *254 + - *253 responses: '204': description: Response @@ -103755,8 +106390,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *254 - - *691 + - *253 + - *690 responses: '204': description: Response @@ -103780,7 +106415,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *254 + - *253 - *17 - *19 responses: @@ -103869,7 +106504,7 @@ paths: - docker - nuget - container - - *692 + - *691 - *19 - *17 responses: @@ -103879,10 +106514,10 @@ paths: application/json: schema: type: array - items: *260 + items: *259 examples: - default: *693 - '400': *694 + default: *692 + '400': *693 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103902,16 +106537,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: + - *261 - *262 - - *263 responses: '200': description: Response content: application/json: - schema: *260 + schema: *259 examples: - default: &713 + default: &712 value: id: 40201 name: octo-name @@ -104024,8 +106659,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: + - *261 - *262 - - *263 responses: '204': description: Response @@ -104055,8 +106690,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: + - *261 - *262 - - *263 - name: token description: package token schema: @@ -104088,8 +106723,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: + - *261 - *262 - - *263 - *19 - *17 - name: state @@ -104109,7 +106744,7 @@ paths: application/json: schema: type: array - items: *264 + items: *263 examples: default: value: @@ -104158,15 +106793,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: + - *261 - *262 - - *263 - - *265 + - *264 responses: '200': description: Response content: application/json: - schema: *264 + schema: *263 examples: default: value: @@ -104202,9 +106837,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: + - *261 - *262 - - *263 - - *265 + - *264 responses: '204': description: Response @@ -104234,9 +106869,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: + - *261 - *262 - - *263 - - *265 + - *264 responses: '204': description: Response @@ -104273,9 +106908,9 @@ paths: application/json: schema: type: array - items: *683 + items: *682 examples: - default: *695 + default: *694 headers: Link: *67 '304': *37 @@ -104388,7 +107023,7 @@ paths: type: array items: *79 examples: - default: &702 + default: &701 summary: Default response value: - id: 1296269 @@ -104692,9 +107327,9 @@ paths: description: Response content: application/json: - schema: *345 + schema: *344 examples: - default: *347 + default: *346 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -104733,9 +107368,9 @@ paths: application/json: schema: type: array - items: *541 + items: *540 examples: - default: *696 + default: *695 headers: Link: *67 '304': *37 @@ -104758,7 +107393,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *238 + - *237 responses: '204': description: Response @@ -104782,7 +107417,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *238 + - *237 responses: '204': description: Response @@ -104815,7 +107450,7 @@ paths: application/json: schema: type: array - items: &697 + items: &696 title: Social account description: Social media account type: object @@ -104830,7 +107465,7 @@ paths: - provider - url examples: - default: &698 + default: &697 value: - provider: twitter url: https://twitter.com/github @@ -104892,9 +107527,9 @@ paths: application/json: schema: type: array - items: *697 + items: *696 examples: - default: *698 + default: *697 '422': *15 '304': *37 '404': *6 @@ -104981,7 +107616,7 @@ paths: application/json: schema: type: array - items: &699 + items: &698 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -105001,7 +107636,7 @@ paths: - title - created_at examples: - default: &731 + default: &730 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -105065,9 +107700,9 @@ paths: description: Response content: application/json: - schema: *699 + schema: *698 examples: - default: &700 + default: &699 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -105097,7 +107732,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: - - &701 + - &700 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -105109,9 +107744,9 @@ paths: description: Response content: application/json: - schema: *699 + schema: *698 examples: - default: *700 + default: *699 '404': *6 '304': *37 '403': *29 @@ -105134,7 +107769,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: - - *701 + - *700 responses: '204': description: Response @@ -105163,7 +107798,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &732 + - &731 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 @@ -105188,11 +107823,11 @@ paths: type: array items: *79 examples: - default-response: *702 + default-response: *701 application/vnd.github.v3.star+json: schema: type: array - items: &733 + items: &732 title: Starred Repository description: Starred Repository type: object @@ -105348,8 +107983,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: + - *341 - *342 - - *343 responses: '204': description: Response if this repository is starred by you @@ -105377,8 +108012,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -105402,8 +108037,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: + - *341 - *342 - - *343 responses: '204': description: Response @@ -105436,9 +108071,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *273 + default: *272 headers: Link: *67 '304': *37 @@ -105475,7 +108110,7 @@ paths: application/json: schema: type: array - items: *338 + items: *337 examples: default: value: @@ -105561,10 +108196,10 @@ paths: application/json: schema: oneOf: - - *677 - - *703 + - *676 + - *702 examples: - default-response: &707 + default-response: &706 summary: Default response value: login: octocat @@ -105599,7 +108234,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &708 + response-with-git-hub-plan-information: &707 summary: Response with GitHub plan information value: login: octocat @@ -105656,14 +108291,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &705 + - &704 name: user_id description: The unique identifier of the user. in: path required: true schema: type: string - - *278 + - *277 requestBody: required: true description: Details of the draft item to create in the project. @@ -105697,9 +108332,9 @@ paths: description: Response content: application/json: - schema: *284 + schema: *283 examples: - draft_issue: *285 + draft_issue: *284 '304': *37 '403': *29 '401': *25 @@ -105722,7 +108357,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *704 + - *703 - *17 responses: '200': @@ -105757,8 +108392,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *705 - - *278 + - *704 + - *277 requestBody: required: true content: @@ -105829,17 +108464,17 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *706 + schema: *705 examples: table_view: summary: Response for creating a table view - value: *289 + value: *288 board_view: summary: Response for creating a board view with filter - value: *289 + value: *288 roadmap_view: summary: Response for creating a roadmap view - value: *289 + value: *288 '304': *37 '403': *29 '401': *25 @@ -105881,11 +108516,11 @@ paths: application/json: schema: oneOf: - - *677 - - *703 + - *676 + - *702 examples: - default-response: *707 - response-with-git-hub-plan-information: *708 + default-response: *706 + response-with-git-hub-plan-information: *707 '404': *6 x-github: githubCloudOnly: false @@ -105935,8 +108570,8 @@ paths: required: - subject_digests examples: - default: *709 - withPredicateType: *710 + default: *708 + withPredicateType: *709 responses: '200': description: Response @@ -105975,7 +108610,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *711 + default: *710 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106164,12 +108799,12 @@ paths: initiator: type: string examples: - default: *403 + default: *402 '201': description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -106203,9 +108838,9 @@ paths: application/json: schema: type: array - items: *260 + items: *259 examples: - default: *693 + default: *692 '403': *29 '401': *25 x-github: @@ -106589,9 +109224,9 @@ paths: application/json: schema: type: array - items: *684 + items: *683 examples: - default: *712 + default: *711 headers: Link: *67 x-github: @@ -106695,7 +109330,7 @@ paths: application/json: schema: *22 examples: - default: *538 + default: *537 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106819,7 +109454,7 @@ paths: - docker - nuget - container - - *692 + - *691 - *71 - *19 - *17 @@ -106830,12 +109465,12 @@ paths: application/json: schema: type: array - items: *260 + items: *259 examples: - default: *693 + default: *692 '403': *29 '401': *25 - '400': *694 + '400': *693 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106855,17 +109490,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: + - *261 - *262 - - *263 - *71 responses: '200': description: Response content: application/json: - schema: *260 + schema: *259 examples: - default: *713 + default: *712 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106886,8 +109521,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: + - *261 - *262 - - *263 - *71 responses: '204': @@ -106920,8 +109555,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: + - *261 - *262 - - *263 - *71 - name: token description: package token @@ -106954,8 +109589,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: + - *261 - *262 - - *263 - *71 responses: '200': @@ -106964,7 +109599,7 @@ paths: application/json: schema: type: array - items: *264 + items: *263 examples: default: value: @@ -107022,16 +109657,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: + - *261 - *262 - - *263 - - *265 + - *264 - *71 responses: '200': description: Response content: application/json: - schema: *264 + schema: *263 examples: default: value: @@ -107066,10 +109701,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: + - *261 - *262 - - *263 - *71 - - *265 + - *264 responses: '204': description: Response @@ -107101,10 +109736,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: + - *261 - *262 - - *263 - *71 - - *265 + - *264 responses: '204': description: Response @@ -107145,9 +109780,9 @@ paths: application/json: schema: type: array - items: *276 + items: *275 examples: - default: *277 + default: *276 headers: Link: *67 '304': *37 @@ -107169,16 +109804,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *278 + - *277 - *71 responses: '200': description: Response content: application/json: - schema: *276 + schema: *275 examples: - default: *277 + default: *276 headers: Link: *67 '304': *37 @@ -107200,7 +109835,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *278 + - *277 - *71 - *17 - *47 @@ -107212,9 +109847,9 @@ paths: application/json: schema: type: array - items: *282 + items: *281 examples: - default: *714 + default: *713 headers: Link: *67 '304': *37 @@ -107236,7 +109871,7 @@ paths: url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project parameters: - *71 - - *278 + - *277 requestBody: required: true content: @@ -107274,7 +109909,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *715 + items: *714 required: - name - data_type @@ -107290,7 +109925,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *716 + iteration_configuration: *715 required: - name - data_type @@ -107312,20 +109947,20 @@ paths: value: name: Due date data_type: date - single_select_field: *717 - iteration_field: *718 + single_select_field: *716 + iteration_field: *717 responses: '201': description: Response content: application/json: - schema: *282 + schema: *281 examples: - text_field: *719 - number_field: *720 - date_field: *721 - single_select_field: *722 - iteration_field: *723 + text_field: *718 + number_field: *719 + date_field: *720 + single_select_field: *721 + iteration_field: *722 '304': *37 '403': *29 '401': *25 @@ -107346,17 +109981,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *278 - - *724 + - *277 + - *723 - *71 responses: '200': description: Response content: application/json: - schema: *282 + schema: *281 examples: - default: *725 + default: *724 headers: Link: *67 '304': *37 @@ -107379,7 +110014,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *278 + - *277 - *71 - *47 - *48 @@ -107412,9 +110047,9 @@ paths: application/json: schema: type: array - items: *286 + items: *285 examples: - default: *287 + default: *286 headers: Link: *67 '304': *37 @@ -107436,7 +110071,7 @@ paths: url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - *71 - - *278 + - *277 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -107506,22 +110141,22 @@ paths: description: Response content: application/json: - schema: *284 + schema: *283 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *285 + value: *284 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *285 + value: *284 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *285 + value: *284 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *285 + value: *284 '304': *37 '403': *29 '401': *25 @@ -107541,9 +110176,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *278 + - *277 - *71 - - *288 + - *287 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -107563,9 +110198,9 @@ paths: description: Response content: application/json: - schema: *286 + schema: *285 examples: - default: *287 + default: *286 headers: Link: *67 '304': *37 @@ -107586,9 +110221,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *278 + - *277 - *71 - - *288 + - *287 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -107658,13 +110293,13 @@ paths: description: Response content: application/json: - schema: *286 + schema: *285 examples: - text_field: *287 - number_field: *287 - date_field: *287 - single_select_field: *287 - iteration_field: *287 + text_field: *286 + number_field: *286 + date_field: *286 + single_select_field: *286 + iteration_field: *286 '401': *25 '403': *29 '404': *6 @@ -107684,9 +110319,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *278 + - *277 - *71 - - *288 + - *287 responses: '204': description: Response @@ -107708,9 +110343,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-project-view parameters: - - *278 + - *277 - *71 - - *726 + - *725 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -107736,9 +110371,9 @@ paths: application/json: schema: type: array - items: *286 + items: *285 examples: - default: *287 + default: *286 headers: Link: *67 '304': *37 @@ -107957,9 +110592,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *273 + default: *272 headers: Link: *67 x-github: @@ -107985,7 +110620,7 @@ paths: - *123 - *125 - *124 - - *727 + - *726 - *126 responses: '200': @@ -108116,7 +110751,7 @@ paths: parameters: - *71 - *123 - - *728 + - *727 - *124 responses: '200': @@ -108215,9 +110850,9 @@ paths: - *123 - *125 - *124 - - *729 + - *728 - *126 - - *730 + - *729 responses: '200': description: Response when getting a billing usage summary @@ -108351,9 +110986,9 @@ paths: application/json: schema: type: array - items: *697 + items: *696 examples: - default: *698 + default: *697 headers: Link: *67 x-github: @@ -108383,9 +111018,9 @@ paths: application/json: schema: type: array - items: *699 + items: *698 examples: - default: *731 + default: *730 headers: Link: *67 x-github: @@ -108410,7 +111045,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *71 - - *732 + - *731 - *61 - *17 - *19 @@ -108422,11 +111057,11 @@ paths: schema: anyOf: - type: array - items: *733 + items: *732 - type: array items: *79 examples: - default-response: *702 + default-response: *701 headers: Link: *67 x-github: @@ -108455,9 +111090,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *273 + default: *272 headers: Link: *67 x-github: @@ -108585,7 +111220,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &734 + enterprise: &733 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -108643,7 +111278,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &735 + installation: &734 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -108662,7 +111297,7 @@ x-webhooks: required: - id - node_id - organization: &736 + organization: &735 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -108722,13 +111357,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &737 + repository: &736 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &769 + properties: &768 id: description: Unique identifier of the repository example: 42 @@ -109412,7 +112047,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &770 + required: &769 - archive_url - assignees_url - blobs_url @@ -109563,10 +112198,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -109642,11 +112277,11 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - rule: &738 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + rule: &737 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) @@ -109869,11 +112504,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - rule: *738 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + rule: *737 sender: *4 required: - action @@ -110056,11 +112691,11 @@ x-webhooks: - everyone required: - from - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - rule: *738 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + rule: *737 sender: *4 required: - action @@ -110144,7 +112779,7 @@ x-webhooks: type: string enum: - completed - check_run: &740 + check_run: &739 title: CheckRun description: A check performed on the code of a given code change type: object @@ -110198,7 +112833,7 @@ x-webhooks: pull_requests: type: array items: *90 - repository: *161 + repository: *160 status: example: completed type: string @@ -110235,7 +112870,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *739 + deployment: *738 details_url: example: https://example.com type: string @@ -110320,10 +112955,10 @@ x-webhooks: - output - app - pull_requests - installation: *735 - enterprise: *734 - organization: *736 - repository: *737 + installation: *734 + enterprise: *733 + organization: *735 + repository: *736 sender: *4 required: - check_run @@ -110714,11 +113349,11 @@ x-webhooks: type: string enum: - created - check_run: *740 - installation: *735 - enterprise: *734 - organization: *736 - repository: *737 + check_run: *739 + installation: *734 + enterprise: *733 + organization: *735 + repository: *736 sender: *4 required: - check_run @@ -111112,11 +113747,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *740 - installation: *735 - enterprise: *734 - organization: *736 - repository: *737 + check_run: *739 + installation: *734 + enterprise: *733 + organization: *735 + repository: *736 requested_action: description: The action requested by the user. type: object @@ -111519,11 +114154,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *740 - installation: *735 - enterprise: *734 - organization: *736 - repository: *737 + check_run: *739 + installation: *734 + enterprise: *733 + organization: *735 + repository: *736 sender: *4 required: - check_run @@ -112493,10 +115128,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -113185,10 +115820,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -113871,10 +116506,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -114040,7 +116675,7 @@ x-webhooks: required: - login - id - dismissed_comment: *435 + dismissed_comment: *434 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -114185,20 +116820,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &741 + commit_oid: &740 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: *734 - installation: *735 - organization: *736 - ref: &742 + enterprise: *733 + installation: *734 + organization: *735 + ref: &741 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: *737 + repository: *736 sender: *4 required: - action @@ -114363,7 +116998,7 @@ x-webhooks: required: - login - id - dismissed_comment: *435 + dismissed_comment: *434 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -114593,12 +117228,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *741 - enterprise: *734 - installation: *735 - organization: *736 - ref: *742 - repository: *737 + commit_oid: *740 + enterprise: *733 + installation: *734 + organization: *735 + ref: *741 + repository: *736 sender: *4 required: - action @@ -114693,7 +117328,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *435 + dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -114864,12 +117499,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *741 - enterprise: *734 - installation: *735 - organization: *736 - ref: *742 - repository: *737 + commit_oid: *740 + enterprise: *733 + installation: *734 + organization: *735 + ref: *741 + repository: *736 sender: *4 required: - action @@ -115035,7 +117670,7 @@ x-webhooks: required: - login - id - dismissed_comment: *435 + dismissed_comment: *434 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -115201,12 +117836,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *741 - enterprise: *734 - installation: *735 - organization: *736 - ref: *742 - repository: *737 + commit_oid: *740 + enterprise: *733 + installation: *734 + organization: *735 + ref: *741 + repository: *736 sender: *4 required: - action @@ -115305,7 +117940,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *435 + dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -115480,16 +118115,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *737 + repository: *736 sender: *4 required: - action @@ -115586,7 +118221,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *435 + dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -115726,12 +118361,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *741 - enterprise: *734 - installation: *735 - organization: *736 - ref: *742 - repository: *737 + commit_oid: *740 + enterprise: *733 + installation: *734 + organization: *735 + ref: *741 + repository: *736 sender: *4 required: - action @@ -115897,7 +118532,7 @@ x-webhooks: required: - login - id - dismissed_comment: *435 + dismissed_comment: *434 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -116042,10 +118677,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -116300,10 +118935,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -116383,18 +119018,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *736 - pusher_type: &743 + organization: *735 + pusher_type: &742 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &744 + ref: &743 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -116404,7 +119039,7 @@ x-webhooks: enum: - tag - branch - repository: *737 + repository: *736 sender: *4 required: - ref @@ -116486,10 +119121,10 @@ x-webhooks: type: string enum: - created - definition: *290 - enterprise: *734 - installation: *735 - organization: *736 + definition: *289 + enterprise: *733 + installation: *734 + organization: *735 sender: *4 required: - action @@ -116574,9 +119209,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 sender: *4 required: - action @@ -116653,10 +119288,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *290 - enterprise: *734 - installation: *735 - organization: *736 + definition: *289 + enterprise: *733 + installation: *734 + organization: *735 sender: *4 required: - action @@ -116733,10 +119368,10 @@ x-webhooks: type: string enum: - updated - definition: *290 - enterprise: *734 - installation: *735 - organization: *736 + definition: *289 + enterprise: *733 + installation: *734 + organization: *735 sender: *4 required: - action @@ -116813,19 +119448,19 @@ x-webhooks: type: string enum: - updated - enterprise: *734 - installation: *735 - repository: *737 - organization: *736 + enterprise: *733 + installation: *734 + repository: *736 + organization: *735 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *294 + items: *293 old_property_values: type: array description: The old custom property values for the repository. - items: *294 + items: *293 required: - action - repository @@ -116901,18 +119536,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *734 - installation: *735 - organization: *736 - pusher_type: *743 - ref: *744 + enterprise: *733 + installation: *734 + organization: *735 + pusher_type: *742 + ref: *743 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *737 + repository: *736 sender: *4 required: - ref @@ -116992,11 +119627,11 @@ x-webhooks: type: string enum: - assignees_changed - alert: *497 - installation: *735 - organization: *736 - enterprise: *734 - repository: *737 + alert: *496 + installation: *734 + organization: *735 + enterprise: *733 + repository: *736 sender: *4 required: - action @@ -117076,11 +119711,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *497 - installation: *735 - organization: *736 - enterprise: *734 - repository: *737 + alert: *496 + installation: *734 + organization: *735 + enterprise: *733 + repository: *736 sender: *4 required: - action @@ -117161,11 +119796,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *497 - installation: *735 - organization: *736 - enterprise: *734 - repository: *737 + alert: *496 + installation: *734 + organization: *735 + enterprise: *733 + repository: *736 sender: *4 required: - action @@ -117246,11 +119881,11 @@ x-webhooks: type: string enum: - created - alert: *497 - installation: *735 - organization: *736 - enterprise: *734 - repository: *737 + alert: *496 + installation: *734 + organization: *735 + enterprise: *733 + repository: *736 sender: *4 required: - action @@ -117329,11 +119964,11 @@ x-webhooks: type: string enum: - dismissed - alert: *497 - installation: *735 - organization: *736 - enterprise: *734 - repository: *737 + alert: *496 + installation: *734 + organization: *735 + enterprise: *733 + repository: *736 sender: *4 required: - action @@ -117412,11 +120047,11 @@ x-webhooks: type: string enum: - fixed - alert: *497 - installation: *735 - organization: *736 - enterprise: *734 - repository: *737 + alert: *496 + installation: *734 + organization: *735 + enterprise: *733 + repository: *736 sender: *4 required: - action @@ -117496,11 +120131,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *497 - installation: *735 - organization: *736 - enterprise: *734 - repository: *737 + alert: *496 + installation: *734 + organization: *735 + enterprise: *733 + repository: *736 sender: *4 required: - action @@ -117579,11 +120214,11 @@ x-webhooks: type: string enum: - reopened - alert: *497 - installation: *735 - organization: *736 - enterprise: *734 - repository: *737 + alert: *496 + installation: *734 + organization: *735 + enterprise: *733 + repository: *736 sender: *4 required: - action @@ -117660,9 +120295,9 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - key: &745 + enterprise: *733 + installation: *734 + key: &744 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -117698,8 +120333,8 @@ x-webhooks: - verified - created_at - read_only - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -117776,11 +120411,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - key: *745 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + key: *744 + organization: *735 + repository: *736 sender: *4 required: - action @@ -118336,12 +120971,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - workflow: &751 + workflow: &750 title: Workflow type: object nullable: true @@ -119082,15 +121717,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *746 - required: *747 + properties: *745 + required: *746 nullable: true pull_requests: type: array - items: *592 - repository: *737 - organization: *736 - installation: *735 + items: *591 + repository: *736 + organization: *735 + installation: *734 sender: *4 responses: '200': @@ -119161,7 +121796,7 @@ x-webhooks: type: string enum: - approved - approver: &748 + approver: &747 type: object properties: avatar_url: @@ -119204,11 +121839,11 @@ x-webhooks: type: string comment: type: string - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - reviewers: &749 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + reviewers: &748 type: array items: type: object @@ -119287,7 +121922,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &750 + workflow_job_run: &749 type: object properties: conclusion: @@ -120018,18 +122653,18 @@ x-webhooks: type: string enum: - rejected - approver: *748 + approver: *747 comment: type: string - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - reviewers: *749 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + reviewers: *748 sender: *4 since: type: string - workflow_job_run: *750 + workflow_job_run: *749 workflow_job_runs: type: array items: @@ -120733,13 +123368,13 @@ x-webhooks: type: string enum: - requested - enterprise: *734 + enterprise: *733 environment: type: string - installation: *735 - organization: *736 - repository: *737 - requestor: &756 + installation: *734 + organization: *735 + repository: *736 + requestor: &755 title: User type: object nullable: true @@ -122628,12 +125263,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - workflow: *751 + workflow: *750 workflow_run: title: Deployment Workflow Run type: object @@ -123313,7 +125948,7 @@ x-webhooks: type: string enum: - answered - answer: &754 + answer: &753 type: object properties: author_association: @@ -123470,11 +126105,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -123601,11 +126236,11 @@ x-webhooks: - from required: - category - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -123688,11 +126323,11 @@ x-webhooks: type: string enum: - closed - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -123774,7 +126409,7 @@ x-webhooks: type: string enum: - created - comment: &753 + comment: &752 type: object properties: author_association: @@ -123931,11 +126566,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124018,12 +126653,12 @@ x-webhooks: type: string enum: - deleted - comment: *753 - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + comment: *752 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124118,12 +126753,12 @@ x-webhooks: - from required: - body - comment: *753 - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + comment: *752 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124207,11 +126842,11 @@ x-webhooks: type: string enum: - created - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124293,11 +126928,11 @@ x-webhooks: type: string enum: - deleted - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124397,11 +127032,11 @@ x-webhooks: type: string required: - from - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124483,10 +127118,10 @@ x-webhooks: type: string enum: - labeled - discussion: *752 - enterprise: *734 - installation: *735 - label: &755 + discussion: *751 + enterprise: *733 + installation: *734 + label: &754 title: Label type: object properties: @@ -124518,8 +127153,8 @@ x-webhooks: - color - default - description - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124602,11 +127237,11 @@ x-webhooks: type: string enum: - locked - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124688,11 +127323,11 @@ x-webhooks: type: string enum: - pinned - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124774,11 +127409,11 @@ x-webhooks: type: string enum: - reopened - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124863,16 +127498,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *752 - new_repository: *737 + new_discussion: *751 + new_repository: *736 required: - new_discussion - new_repository - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -124955,10 +127590,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *752 - old_answer: *754 - organization: *736 - repository: *737 + discussion: *751 + old_answer: *753 + organization: *735 + repository: *736 sender: *4 required: - action @@ -125040,12 +127675,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *752 - enterprise: *734 - installation: *735 - label: *755 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + label: *754 + organization: *735 + repository: *736 sender: *4 required: - action @@ -125128,11 +127763,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -125214,11 +127849,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *752 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + discussion: *751 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -125291,7 +127926,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *734 + enterprise: *733 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -125951,9 +128586,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - forkee @@ -126099,9 +128734,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 pages: description: The pages that were updated. type: array @@ -126138,7 +128773,7 @@ x-webhooks: - action - sha - html_url - repository: *737 + repository: *736 sender: *4 required: - pages @@ -126214,10 +128849,10 @@ x-webhooks: type: string enum: - created - enterprise: *734 + enterprise: *733 installation: *22 - organization: *736 - repositories: &757 + organization: *735 + repositories: &756 description: An array of repository objects that the installation can access. type: array @@ -126243,8 +128878,8 @@ x-webhooks: - name - full_name - private - repository: *737 - requester: *756 + repository: *736 + requester: *755 sender: *4 required: - action @@ -126319,11 +128954,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 + enterprise: *733 installation: *22 - organization: *736 - repositories: *757 - repository: *737 + organization: *735 + repositories: *756 + repository: *736 requester: nullable: true sender: *4 @@ -126399,11 +129034,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *734 + enterprise: *733 installation: *22 - organization: *736 - repositories: *757 - repository: *737 + organization: *735 + repositories: *756 + repository: *736 requester: nullable: true sender: *4 @@ -126479,10 +129114,10 @@ x-webhooks: type: string enum: - added - enterprise: *734 + enterprise: *733 installation: *22 - organization: *736 - repositories_added: &758 + organization: *735 + repositories_added: &757 description: An array of repository objects, which were added to the installation. type: array @@ -126528,15 +129163,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *737 - repository_selection: &759 + repository: *736 + repository_selection: &758 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *756 + requester: *755 sender: *4 required: - action @@ -126615,10 +129250,10 @@ x-webhooks: type: string enum: - removed - enterprise: *734 + enterprise: *733 installation: *22 - organization: *736 - repositories_added: *758 + organization: *735 + repositories_added: *757 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -126645,9 +129280,9 @@ x-webhooks: - name - full_name - private - repository: *737 - repository_selection: *759 - requester: *756 + repository: *736 + repository_selection: *758 + requester: *755 sender: *4 required: - action @@ -126726,11 +129361,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *734 + enterprise: *733 installation: *22 - organization: *736 - repositories: *757 - repository: *737 + organization: *735 + repositories: *756 + repository: *736 requester: nullable: true sender: *4 @@ -126908,10 +129543,10 @@ x-webhooks: type: string required: - from - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 target_type: type: string @@ -126990,11 +129625,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *734 + enterprise: *733 installation: *22 - organization: *736 - repositories: *757 - repository: *737 + organization: *735 + repositories: *756 + repository: *736 requester: nullable: true sender: *4 @@ -127168,8 +129803,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *569 - required: *570 + properties: *568 + required: *569 nullable: true user: title: User @@ -127254,8 +129889,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128044,8 +130679,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128061,7 +130696,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -128394,8 +131029,8 @@ x-webhooks: - state - locked - assignee - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -128475,7 +131110,7 @@ x-webhooks: type: string enum: - deleted - comment: &760 + comment: &759 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -128632,8 +131267,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *569 - required: *570 + properties: *568 + required: *569 nullable: true required: - url @@ -128648,8 +131283,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -129434,8 +132069,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 state: description: State of the issue; either 'open' or 'closed' type: string @@ -129451,7 +132086,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -129786,8 +132421,8 @@ x-webhooks: - state - locked - assignee - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -129867,7 +132502,7 @@ x-webhooks: type: string enum: - edited - changes: &789 + changes: &788 description: The changes to the comment. type: object properties: @@ -129879,9 +132514,9 @@ x-webhooks: type: string required: - from - comment: *760 - enterprise: *734 - installation: *735 + comment: *759 + enterprise: *733 + installation: *734 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -130669,8 +133304,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130686,7 +133321,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -131019,8 +133654,8 @@ x-webhooks: - state - locked - assignee - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -131101,9 +133736,9 @@ x-webhooks: type: string enum: - pinned - comment: *760 - enterprise: *734 - installation: *735 + comment: *759 + enterprise: *733 + installation: *734 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -131893,8 +134528,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131910,7 +134545,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -132245,8 +134880,8 @@ x-webhooks: - state - locked - assignee - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -132326,9 +134961,9 @@ x-webhooks: type: string enum: - unpinned - comment: *760 - enterprise: *734 - installation: *735 + comment: *759 + enterprise: *733 + installation: *734 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -133118,8 +135753,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133135,7 +135770,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -133470,8 +136105,8 @@ x-webhooks: - state - locked - assignee - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -133560,9 +136195,9 @@ x-webhooks: type: number blocking_issue: *85 blocking_issue_repo: *79 - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -133651,9 +136286,9 @@ x-webhooks: type: number blocking_issue: *85 blocking_issue_repo: *79 - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -133741,9 +136376,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *85 - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -133832,9 +136467,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *85 - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -133914,10 +136549,10 @@ x-webhooks: type: string enum: - assigned - assignee: *756 - enterprise: *734 - installation: *735 - issue: &763 + assignee: *755 + enterprise: *733 + installation: *734 + issue: &762 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -134709,11 +137344,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134729,7 +137364,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -134830,8 +137465,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -134911,8 +137546,8 @@ x-webhooks: type: string enum: - closed - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -135709,11 +138344,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135729,7 +138364,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -135965,8 +138600,8 @@ x-webhooks: required: - state - closed_at - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -136045,8 +138680,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136834,11 +139469,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136854,7 +139489,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -136954,8 +139589,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -137034,8 +139669,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137845,11 +140480,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137865,7 +140500,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -137944,7 +140579,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &761 + milestone: &760 title: Milestone description: A collection of related issues and pull requests. type: object @@ -138082,8 +140717,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -138182,8 +140817,8 @@ x-webhooks: type: string required: - from - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -138975,11 +141610,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138992,7 +141627,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *242 + type: *241 title: description: Title of the issue type: string @@ -139096,9 +141731,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *755 - organization: *736 - repository: *737 + label: *754 + organization: *735 + repository: *736 sender: *4 required: - action @@ -139178,8 +141813,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139970,11 +142605,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139987,7 +142622,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *242 + type: *241 title: description: Title of the issue type: string @@ -140091,9 +142726,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *755 - organization: *736 - repository: *737 + label: *754 + organization: *735 + repository: *736 sender: *4 required: - action @@ -140173,8 +142808,8 @@ x-webhooks: type: string enum: - locked - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -140989,11 +143624,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141006,7 +143641,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *242 + type: *241 title: description: Title of the issue type: string @@ -141087,8 +143722,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -141167,8 +143802,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141977,11 +144612,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141997,7 +144632,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -142075,9 +144710,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *761 - organization: *736 - repository: *737 + milestone: *760 + organization: *735 + repository: *736 sender: *4 required: - action @@ -142940,11 +145575,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143045,7 +145680,7 @@ x-webhooks: required: - login - id - type: *242 + type: *241 required: - id - number @@ -143525,8 +146160,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144310,11 +146945,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144330,7 +146965,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -144438,8 +147073,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -144519,9 +147154,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *734 - installation: *735 - issue: &762 + enterprise: *733 + installation: *734 + issue: &761 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -145307,11 +147942,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145327,7 +147962,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -145427,8 +148062,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -145507,8 +148142,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -146321,11 +148956,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146419,9 +149054,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *242 - organization: *736 - repository: *737 + type: *241 + organization: *735 + repository: *736 sender: *4 required: - action @@ -147290,11 +149925,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147310,7 +149945,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -147889,11 +150524,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *734 - installation: *735 - issue: *762 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + issue: *761 + organization: *735 + repository: *736 sender: *4 required: - action @@ -147973,12 +150608,12 @@ x-webhooks: type: string enum: - typed - enterprise: *734 - installation: *735 - issue: *763 - type: *242 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + issue: *762 + type: *241 + organization: *735 + repository: *736 sender: *4 required: - action @@ -148059,7 +150694,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &792 + assignee: &791 title: User type: object nullable: true @@ -148129,11 +150764,11 @@ x-webhooks: required: - login - id - enterprise: *734 - installation: *735 - issue: *763 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + issue: *762 + organization: *735 + repository: *736 sender: *4 required: - action @@ -148212,12 +150847,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *734 - installation: *735 - issue: *763 - label: *755 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + issue: *762 + label: *754 + organization: *735 + repository: *736 sender: *4 required: - action @@ -148297,8 +150932,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -149111,11 +151746,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *670 - issue_dependencies_summary: *671 + sub_issues_summary: *669 + issue_dependencies_summary: *670 issue_field_values: type: array - items: *554 + items: *553 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149131,7 +151766,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *242 + type: *241 updated_at: type: string format: date-time @@ -149209,8 +151844,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -149290,11 +151925,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *734 - installation: *735 - issue: *762 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + issue: *761 + organization: *735 + repository: *736 sender: *4 required: - action @@ -149373,12 +152008,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *734 - installation: *735 - issue: *763 - type: *242 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + issue: *762 + type: *241 + organization: *735 + repository: *736 sender: *4 required: - action @@ -149458,11 +152093,11 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - label: *755 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + label: *754 + organization: *735 + repository: *736 sender: *4 required: - action @@ -149540,11 +152175,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - label: *755 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + label: *754 + organization: *735 + repository: *736 sender: *4 required: - action @@ -149654,11 +152289,11 @@ x-webhooks: type: string required: - from - enterprise: *734 - installation: *735 - label: *755 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + label: *754 + organization: *735 + repository: *736 sender: *4 required: - action @@ -149740,9 +152375,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *734 - installation: *735 - marketplace_purchase: &764 + enterprise: *733 + installation: *734 + marketplace_purchase: &763 title: Marketplace Purchase type: object required: @@ -149825,8 +152460,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *736 - previous_marketplace_purchase: &765 + organization: *735 + previous_marketplace_purchase: &764 title: Marketplace Purchase type: object properties: @@ -149906,7 +152541,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *737 + repository: *736 sender: *4 required: - action @@ -149986,10 +152621,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *734 - installation: *735 - marketplace_purchase: *764 - organization: *736 + enterprise: *733 + installation: *734 + marketplace_purchase: *763 + organization: *735 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -150072,7 +152707,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *737 + repository: *736 sender: *4 required: - action @@ -150154,10 +152789,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *734 - installation: *735 - marketplace_purchase: *764 - organization: *736 + enterprise: *733 + installation: *734 + marketplace_purchase: *763 + organization: *735 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -150239,7 +152874,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *737 + repository: *736 sender: *4 required: - action @@ -150320,8 +152955,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 marketplace_purchase: title: Marketplace Purchase type: object @@ -150403,9 +153038,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *736 - previous_marketplace_purchase: *765 - repository: *737 + organization: *735 + previous_marketplace_purchase: *764 + repository: *736 sender: *4 required: - action @@ -150485,12 +153120,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *734 - installation: *735 - marketplace_purchase: *764 - organization: *736 - previous_marketplace_purchase: *765 - repository: *737 + enterprise: *733 + installation: *734 + marketplace_purchase: *763 + organization: *735 + previous_marketplace_purchase: *764 + repository: *736 sender: *4 required: - action @@ -150592,11 +153227,11 @@ x-webhooks: type: string required: - to - enterprise: *734 - installation: *735 - member: *756 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + member: *755 + organization: *735 + repository: *736 sender: *4 required: - action @@ -150696,11 +153331,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *734 - installation: *735 - member: *756 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + member: *755 + organization: *735 + repository: *736 sender: *4 required: - action @@ -150779,11 +153414,11 @@ x-webhooks: type: string enum: - removed - enterprise: *734 - installation: *735 - member: *756 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + member: *755 + organization: *735 + repository: *736 sender: *4 required: - action @@ -150861,11 +153496,11 @@ x-webhooks: type: string enum: - added - enterprise: *734 - installation: *735 - member: *756 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + member: *755 + organization: *735 + repository: *736 scope: description: The scope of the membership. Currently, can only be `team`. @@ -150941,7 +153576,7 @@ x-webhooks: required: - login - id - team: &766 + team: &765 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -151164,11 +153799,11 @@ x-webhooks: type: string enum: - removed - enterprise: *734 - installation: *735 - member: *756 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + member: *755 + organization: *735 + repository: *736 scope: description: The scope of the membership. Currently, can only be `team`. @@ -151245,7 +153880,7 @@ x-webhooks: required: - login - id - team: *766 + team: *765 required: - action - scope @@ -151327,8 +153962,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *735 - merge_group: &768 + installation: *734 + merge_group: &767 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -151347,15 +153982,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *767 + head_commit: *766 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -151441,10 +154076,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *735 - merge_group: *768 - organization: *736 - repository: *737 + installation: *734 + merge_group: *767 + organization: *735 + repository: *736 sender: *4 required: - action @@ -151517,7 +154152,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 + enterprise: *733 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -151626,16 +154261,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *735 - organization: *736 + installation: *734 + organization: *735 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *769 - required: *770 + properties: *768 + required: *769 nullable: true sender: *4 required: @@ -151716,11 +154351,11 @@ x-webhooks: type: string enum: - closed - enterprise: *734 - installation: *735 - milestone: *761 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + milestone: *760 + organization: *735 + repository: *736 sender: *4 required: - action @@ -151799,9 +154434,9 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - milestone: &771 + enterprise: *733 + installation: *734 + milestone: &770 title: Milestone description: A collection of related issues and pull requests. type: object @@ -151938,8 +154573,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -152018,11 +154653,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - milestone: *761 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + milestone: *760 + organization: *735 + repository: *736 sender: *4 required: - action @@ -152132,11 +154767,11 @@ x-webhooks: type: string required: - from - enterprise: *734 - installation: *735 - milestone: *761 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + milestone: *760 + organization: *735 + repository: *736 sender: *4 required: - action @@ -152216,11 +154851,11 @@ x-webhooks: type: string enum: - opened - enterprise: *734 - installation: *735 - milestone: *771 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + milestone: *770 + organization: *735 + repository: *736 sender: *4 required: - action @@ -152299,11 +154934,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *756 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + blocked_user: *755 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -152382,11 +155017,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *756 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + blocked_user: *755 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -152465,9 +155100,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - membership: &772 + enterprise: *733 + installation: *734 + membership: &771 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -152574,8 +155209,8 @@ x-webhooks: - role - organization_url - user - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 required: - action @@ -152653,11 +155288,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *734 - installation: *735 - membership: *772 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + membership: *771 + organization: *735 + repository: *736 sender: *4 required: - action @@ -152736,8 +155371,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -152853,10 +155488,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 - user: *756 + user: *755 required: - action - invitation @@ -152934,11 +155569,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *734 - installation: *735 - membership: *772 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + membership: *771 + organization: *735 + repository: *736 sender: *4 required: - action @@ -153025,11 +155660,11 @@ x-webhooks: properties: from: type: string - enterprise: *734 - installation: *735 - membership: *772 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + membership: *771 + organization: *735 + repository: *736 sender: *4 required: - action @@ -153106,9 +155741,9 @@ x-webhooks: type: string enum: - published - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 package: description: Information about the package. type: object @@ -153607,7 +156242,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &773 + items: &772 title: Ruby Gems metadata type: object properties: @@ -153702,7 +156337,7 @@ x-webhooks: - owner - package_version - registry - repository: *737 + repository: *736 sender: *4 required: - action @@ -153778,9 +156413,9 @@ x-webhooks: type: string enum: - updated - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 package: description: Information about the package. type: object @@ -154133,7 +156768,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *773 + items: *772 source_url: type: string format: uri @@ -154203,7 +156838,7 @@ x-webhooks: - owner - package_version - registry - repository: *737 + repository: *736 sender: *4 required: - action @@ -154379,12 +157014,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *734 + enterprise: *733 id: type: integer - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - id @@ -154461,7 +157096,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &774 + personal_access_token_request: &773 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -154607,10 +157242,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *734 - organization: *736 + enterprise: *733 + organization: *735 sender: *4 - installation: *735 + installation: *734 required: - action - personal_access_token_request @@ -154687,11 +157322,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *774 - enterprise: *734 - organization: *736 + personal_access_token_request: *773 + enterprise: *733 + organization: *735 sender: *4 - installation: *735 + installation: *734 required: - action - personal_access_token_request @@ -154767,11 +157402,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *774 - enterprise: *734 - organization: *736 + personal_access_token_request: *773 + enterprise: *733 + organization: *735 sender: *4 - installation: *735 + installation: *734 required: - action - personal_access_token_request @@ -154846,11 +157481,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *774 - organization: *736 - enterprise: *734 + personal_access_token_request: *773 + organization: *735 + enterprise: *733 sender: *4 - installation: *735 + installation: *734 required: - action - personal_access_token_request @@ -154955,7 +157590,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *775 + last_response: *774 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -154987,8 +157622,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 zen: description: Random string of GitHub zen. @@ -155233,10 +157868,10 @@ x-webhooks: - from required: - note - enterprise: *734 - installation: *735 - organization: *736 - project_card: &776 + enterprise: *733 + installation: *734 + organization: *735 + project_card: &775 title: Project Card type: object properties: @@ -155355,7 +157990,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *737 + repository: *736 sender: *4 required: - action @@ -155436,11 +158071,11 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 - project_card: *776 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + project_card: *775 + repository: *736 sender: *4 required: - action @@ -155520,9 +158155,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 project_card: title: Project Card type: object @@ -155650,8 +158285,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *769 - required: *770 + properties: *768 + required: *769 nullable: true sender: *4 required: @@ -155745,11 +158380,11 @@ x-webhooks: - from required: - note - enterprise: *734 - installation: *735 - organization: *736 - project_card: *776 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + project_card: *775 + repository: *736 sender: *4 required: - action @@ -155843,9 +158478,9 @@ x-webhooks: - from required: - column_id - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 project_card: allOf: - title: Project Card @@ -156035,7 +158670,7 @@ x-webhooks: type: string required: - after_id - repository: *737 + repository: *736 sender: *4 required: - action @@ -156115,10 +158750,10 @@ x-webhooks: type: string enum: - closed - enterprise: *734 - installation: *735 - organization: *736 - project: &778 + enterprise: *733 + installation: *734 + organization: *735 + project: &777 title: Project type: object properties: @@ -156242,7 +158877,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *737 + repository: *736 sender: *4 required: - action @@ -156322,10 +158957,10 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 - project_column: &777 + enterprise: *733 + installation: *734 + organization: *735 + project_column: &776 title: Project Column type: object properties: @@ -156364,7 +158999,7 @@ x-webhooks: - name - created_at - updated_at - repository: *737 + repository: *736 sender: *4 required: - action @@ -156443,18 +159078,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - organization: *736 - project_column: *777 + enterprise: *733 + installation: *734 + organization: *735 + project_column: *776 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *769 - required: *770 + properties: *768 + required: *769 nullable: true sender: *4 required: @@ -156544,11 +159179,11 @@ x-webhooks: type: string required: - from - enterprise: *734 - installation: *735 - organization: *736 - project_column: *777 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + project_column: *776 + repository: *736 sender: *4 required: - action @@ -156628,11 +159263,11 @@ x-webhooks: type: string enum: - moved - enterprise: *734 - installation: *735 - organization: *736 - project_column: *777 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + project_column: *776 + repository: *736 sender: *4 required: - action @@ -156712,11 +159347,11 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 - project: *778 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + project: *777 + repository: *736 sender: *4 required: - action @@ -156796,18 +159431,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - organization: *736 - project: *778 + enterprise: *733 + installation: *734 + organization: *735 + project: *777 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *769 - required: *770 + properties: *768 + required: *769 nullable: true sender: *4 required: @@ -156909,11 +159544,11 @@ x-webhooks: type: string required: - from - enterprise: *734 - installation: *735 - organization: *736 - project: *778 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + project: *777 + repository: *736 sender: *4 required: - action @@ -156992,11 +159627,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *734 - installation: *735 - organization: *736 - project: *778 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + project: *777 + repository: *736 sender: *4 required: - action @@ -157077,9 +159712,9 @@ x-webhooks: type: string enum: - closed - installation: *735 - organization: *736 - projects_v2: *276 + installation: *734 + organization: *735 + projects_v2: *275 sender: *4 required: - action @@ -157160,9 +159795,9 @@ x-webhooks: type: string enum: - created - installation: *735 - organization: *736 - projects_v2: *276 + installation: *734 + organization: *735 + projects_v2: *275 sender: *4 required: - action @@ -157243,9 +159878,9 @@ x-webhooks: type: string enum: - deleted - installation: *735 - organization: *736 - projects_v2: *276 + installation: *734 + organization: *735 + projects_v2: *275 sender: *4 required: - action @@ -157362,9 +159997,9 @@ x-webhooks: type: string to: type: string - installation: *735 - organization: *736 - projects_v2: *276 + installation: *734 + organization: *735 + projects_v2: *275 sender: *4 required: - action @@ -157447,7 +160082,7 @@ x-webhooks: type: string enum: - archived - changes: &782 + changes: &781 type: object properties: archived_at: @@ -157461,9 +160096,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *735 - organization: *736 - projects_v2_item: &779 + installation: *734 + organization: *735 + projects_v2_item: &778 title: Projects v2 Item description: An item belonging to a project type: object @@ -157481,7 +160116,7 @@ x-webhooks: type: string description: The node ID of the content represented by this item. - content_type: *283 + content_type: *282 creator: *4 created_at: type: string @@ -157598,9 +160233,9 @@ x-webhooks: nullable: true to: type: string - installation: *735 - organization: *736 - projects_v2_item: *779 + installation: *734 + organization: *735 + projects_v2_item: *778 sender: *4 required: - action @@ -157682,9 +160317,9 @@ x-webhooks: type: string enum: - created - installation: *735 - organization: *736 - projects_v2_item: *779 + installation: *734 + organization: *735 + projects_v2_item: *778 sender: *4 required: - action @@ -157765,9 +160400,9 @@ x-webhooks: type: string enum: - deleted - installation: *735 - organization: *736 - projects_v2_item: *779 + installation: *734 + organization: *735 + projects_v2_item: *778 sender: *4 required: - action @@ -157873,7 +160508,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &780 + - &779 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -157895,7 +160530,7 @@ x-webhooks: required: - id - name - - &781 + - &780 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -157929,8 +160564,8 @@ x-webhooks: oneOf: - type: string - type: integer + - *779 - *780 - - *781 required: - field_value - type: object @@ -157946,9 +160581,9 @@ x-webhooks: nullable: true required: - body - installation: *735 - organization: *736 - projects_v2_item: *779 + installation: *734 + organization: *735 + projects_v2_item: *778 sender: *4 required: - action @@ -158043,9 +160678,9 @@ x-webhooks: to: type: string nullable: true - installation: *735 - organization: *736 - projects_v2_item: *779 + installation: *734 + organization: *735 + projects_v2_item: *778 sender: *4 required: - action @@ -158128,10 +160763,10 @@ x-webhooks: type: string enum: - restored - changes: *782 - installation: *735 - organization: *736 - projects_v2_item: *779 + changes: *781 + installation: *734 + organization: *735 + projects_v2_item: *778 sender: *4 required: - action @@ -158213,9 +160848,9 @@ x-webhooks: type: string enum: - reopened - installation: *735 - organization: *736 - projects_v2: *276 + installation: *734 + organization: *735 + projects_v2: *275 sender: *4 required: - action @@ -158296,14 +160931,14 @@ x-webhooks: type: string enum: - created - installation: *735 - organization: *736 - projects_v2_status_update: &785 + installation: *734 + organization: *735 + projects_v2_status_update: &784 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *783 - required: *784 + properties: *782 + required: *783 sender: *4 required: - action @@ -158384,9 +161019,9 @@ x-webhooks: type: string enum: - deleted - installation: *735 - organization: *736 - projects_v2_status_update: *785 + installation: *734 + organization: *735 + projects_v2_status_update: *784 sender: *4 required: - action @@ -158522,9 +161157,9 @@ x-webhooks: type: string format: date nullable: true - installation: *735 - organization: *736 - projects_v2_status_update: *785 + installation: *734 + organization: *735 + projects_v2_status_update: *784 sender: *4 required: - action @@ -158595,10 +161230,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - repository @@ -158675,13 +161310,13 @@ x-webhooks: type: string enum: - assigned - assignee: *756 - enterprise: *734 - installation: *735 - number: &786 + assignee: *755 + enterprise: *733 + installation: *734 + number: &785 description: The pull request number. type: integer - organization: *736 + organization: *735 pull_request: title: Pull Request type: object @@ -160968,7 +163603,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 sender: *4 required: - action @@ -161050,11 +163685,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 number: type: integer - organization: *736 + organization: *735 pull_request: title: Pull Request type: object @@ -163336,7 +165971,7 @@ x-webhooks: - draft reason: type: string - repository: *737 + repository: *736 sender: *4 required: - action @@ -163418,11 +166053,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 number: type: integer - organization: *736 + organization: *735 pull_request: title: Pull Request type: object @@ -165704,7 +168339,7 @@ x-webhooks: - draft reason: type: string - repository: *737 + repository: *736 sender: *4 required: - action @@ -165786,13 +168421,13 @@ x-webhooks: type: string enum: - closed - enterprise: *734 - installation: *735 - number: *786 - organization: *736 - pull_request: &787 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 + pull_request: &786 allOf: - - *592 + - *591 - type: object properties: allow_auto_merge: @@ -165854,7 +168489,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *737 + repository: *736 sender: *4 required: - action @@ -165935,12 +168570,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *734 - installation: *735 - number: *786 - organization: *736 - pull_request: *787 - repository: *737 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 + pull_request: *786 + repository: *736 sender: *4 required: - action @@ -166020,11 +168655,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *734 - milestone: *576 - number: *786 - organization: *736 - pull_request: &788 + enterprise: *733 + milestone: *575 + number: *785 + organization: *735 + pull_request: &787 title: Pull Request type: object properties: @@ -168305,7 +170940,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 sender: *4 required: - action @@ -168384,11 +171019,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 number: type: integer - organization: *736 + organization: *735 pull_request: title: Pull Request type: object @@ -170688,7 +173323,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *737 + repository: *736 sender: *4 required: - action @@ -170812,12 +173447,12 @@ x-webhooks: type: string required: - from - enterprise: *734 - installation: *735 - number: *786 - organization: *736 - pull_request: *787 - repository: *737 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 + pull_request: *786 + repository: *736 sender: *4 required: - action @@ -170897,11 +173532,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 number: type: integer - organization: *736 + organization: *735 pull_request: title: Pull Request type: object @@ -173186,7 +175821,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 sender: *4 required: - action @@ -173266,11 +175901,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *734 - installation: *735 - label: *755 - number: *786 - organization: *736 + enterprise: *733 + installation: *734 + label: *754 + number: *785 + organization: *735 pull_request: title: Pull Request type: object @@ -175556,7 +178191,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 sender: *4 required: - action @@ -175637,10 +178272,10 @@ x-webhooks: type: string enum: - locked - enterprise: *734 - installation: *735 - number: *786 - organization: *736 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 pull_request: title: Pull Request type: object @@ -177924,7 +180559,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 sender: *4 required: - action @@ -178004,12 +180639,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *734 - milestone: *576 - number: *786 - organization: *736 - pull_request: *788 - repository: *737 + enterprise: *733 + milestone: *575 + number: *785 + organization: *735 + pull_request: *787 + repository: *736 sender: *4 required: - action @@ -178088,12 +180723,12 @@ x-webhooks: type: string enum: - opened - enterprise: *734 - installation: *735 - number: *786 - organization: *736 - pull_request: *787 - repository: *737 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 + pull_request: *786 + repository: *736 sender: *4 required: - action @@ -178174,12 +180809,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *734 - installation: *735 - number: *786 - organization: *736 - pull_request: *787 - repository: *737 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 + pull_request: *786 + repository: *736 sender: *4 required: - action @@ -178259,12 +180894,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *734 - installation: *735 - number: *786 - organization: *736 - pull_request: *787 - repository: *737 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 + pull_request: *786 + repository: *736 sender: *4 required: - action @@ -178630,9 +181265,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 pull_request: type: object properties: @@ -180806,7 +183441,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *737 + repository: *736 sender: *4 required: - action @@ -180886,7 +183521,7 @@ x-webhooks: type: string enum: - deleted - comment: &790 + comment: &789 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -181171,9 +183806,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 pull_request: type: object properties: @@ -183335,7 +185970,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *737 + repository: *736 sender: *4 required: - action @@ -183415,11 +186050,11 @@ x-webhooks: type: string enum: - edited - changes: *789 - comment: *790 - enterprise: *734 - installation: *735 - organization: *736 + changes: *788 + comment: *789 + enterprise: *733 + installation: *734 + organization: *735 pull_request: type: object properties: @@ -185584,7 +188219,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *737 + repository: *736 sender: *4 required: - action @@ -185665,9 +188300,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 pull_request: title: Simple Pull Request type: object @@ -187844,7 +190479,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *737 + repository: *736 review: description: The review that was affected. type: object @@ -188091,9 +190726,9 @@ x-webhooks: type: string required: - from - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 pull_request: title: Simple Pull Request type: object @@ -190143,8 +192778,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *737 - review: &791 + repository: *736 + review: &790 description: The review that was affected. type: object properties: @@ -190377,12 +193012,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 number: description: The pull request number. type: integer - organization: *736 + organization: *735 pull_request: title: Pull Request type: object @@ -192669,7 +195304,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 requested_reviewer: title: User type: object @@ -192753,12 +195388,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 number: description: The pull request number. type: integer - organization: *736 + organization: *735 pull_request: title: Pull Request type: object @@ -195052,7 +197687,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 requested_team: title: Team description: Groups of organization members that gives permissions @@ -195244,12 +197879,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 number: description: The pull request number. type: integer - organization: *736 + organization: *735 pull_request: title: Pull Request type: object @@ -197538,7 +200173,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 requested_reviewer: title: User type: object @@ -197623,12 +200258,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *734 - installation: *735 + enterprise: *733 + installation: *734 number: description: The pull request number. type: integer - organization: *736 + organization: *735 pull_request: title: Pull Request type: object @@ -199908,7 +202543,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 requested_team: title: Team description: Groups of organization members that gives permissions @@ -200089,9 +202724,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 pull_request: title: Simple Pull Request type: object @@ -202270,8 +204905,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *737 - review: *791 + repository: *736 + review: *790 sender: *4 required: - action @@ -202351,9 +204986,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 pull_request: title: Simple Pull Request type: object @@ -204441,7 +207076,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *737 + repository: *736 sender: *4 thread: type: object @@ -204828,9 +207463,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 pull_request: title: Simple Pull Request type: object @@ -206904,7 +209539,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *737 + repository: *736 sender: *4 thread: type: object @@ -207294,10 +209929,10 @@ x-webhooks: type: string before: type: string - enterprise: *734 - installation: *735 - number: *786 - organization: *736 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 pull_request: title: Pull Request type: object @@ -209572,7 +212207,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 sender: *4 required: - action @@ -209654,11 +212289,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *792 - enterprise: *734 - installation: *735 - number: *786 - organization: *736 + assignee: *791 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 pull_request: title: Pull Request type: object @@ -211945,7 +214580,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 sender: *4 required: - action @@ -212024,11 +214659,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *734 - installation: *735 - label: *755 - number: *786 - organization: *736 + enterprise: *733 + installation: *734 + label: *754 + number: *785 + organization: *735 pull_request: title: Pull Request type: object @@ -214305,7 +216940,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 sender: *4 required: - action @@ -214386,10 +217021,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *734 - installation: *735 - number: *786 - organization: *736 + enterprise: *733 + installation: *734 + number: *785 + organization: *735 pull_request: title: Pull Request type: object @@ -216658,7 +219293,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *737 + repository: *736 sender: *4 required: - action @@ -216858,7 +219493,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *734 + enterprise: *733 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -216950,8 +219585,8 @@ x-webhooks: - url - author - committer - installation: *735 - organization: *736 + installation: *734 + organization: *735 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -217537,9 +220172,9 @@ x-webhooks: type: string enum: - published - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 registry_package: type: object properties: @@ -217985,7 +220620,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *773 + items: *772 summary: type: string tag_name: @@ -218039,7 +220674,7 @@ x-webhooks: - owner - package_version - registry - repository: *737 + repository: *736 sender: *4 required: - action @@ -218117,9 +220752,9 @@ x-webhooks: type: string enum: - updated - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 registry_package: type: object properties: @@ -218427,7 +221062,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *773 + items: *772 summary: type: string tag_name: @@ -218476,7 +221111,7 @@ x-webhooks: - owner - package_version - registry - repository: *737 + repository: *736 sender: *4 required: - action @@ -218553,10 +221188,10 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 - release: &793 + enterprise: *733 + installation: *734 + organization: *735 + release: &792 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -218874,7 +221509,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *737 + repository: *736 sender: *4 required: - action @@ -218951,11 +221586,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - organization: *736 - release: *793 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + release: *792 + repository: *736 sender: *4 required: - action @@ -219072,11 +221707,11 @@ x-webhooks: type: boolean required: - to - enterprise: *734 - installation: *735 - organization: *736 - release: *793 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + release: *792 + repository: *736 sender: *4 required: - action @@ -219154,9 +221789,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -219478,7 +222113,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *737 + repository: *736 sender: *4 required: - action @@ -219554,10 +222189,10 @@ x-webhooks: type: string enum: - published - enterprise: *734 - installation: *735 - organization: *736 - release: &794 + enterprise: *733 + installation: *734 + organization: *735 + release: &793 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -219876,7 +222511,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *737 + repository: *736 sender: *4 required: - action @@ -219952,11 +222587,11 @@ x-webhooks: type: string enum: - released - enterprise: *734 - installation: *735 - organization: *736 - release: *793 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + release: *792 + repository: *736 sender: *4 required: - action @@ -220032,11 +222667,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *734 - installation: *735 - organization: *736 - release: *794 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + release: *793 + repository: *736 sender: *4 required: - action @@ -220112,11 +222747,11 @@ x-webhooks: type: string enum: - published - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - repository_advisory: *656 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + repository_advisory: *655 sender: *4 required: - action @@ -220192,11 +222827,11 @@ x-webhooks: type: string enum: - reported - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - repository_advisory: *656 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + repository_advisory: *655 sender: *4 required: - action @@ -220272,10 +222907,10 @@ x-webhooks: type: string enum: - archived - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -220352,10 +222987,10 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -220433,10 +223068,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -220520,10 +223155,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -220635,10 +223270,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -220710,10 +223345,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 status: type: string @@ -220794,10 +223429,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -220874,10 +223509,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -220971,10 +223606,10 @@ x-webhooks: - name required: - repository - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -221054,11 +223689,11 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - repository_ruleset: *324 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + repository_ruleset: *323 sender: *4 required: - action @@ -221136,11 +223771,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - repository_ruleset: *324 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + repository_ruleset: *323 sender: *4 required: - action @@ -221218,11 +223853,11 @@ x-webhooks: type: string enum: - edited - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - repository_ruleset: *324 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + repository_ruleset: *323 changes: type: object properties: @@ -221241,16 +223876,16 @@ x-webhooks: properties: added: type: array - items: *298 + items: *297 deleted: type: array - items: *298 + items: *297 updated: type: array items: type: object properties: - condition: *298 + condition: *297 changes: type: object properties: @@ -221283,16 +223918,16 @@ x-webhooks: properties: added: type: array - items: *612 + items: *611 deleted: type: array - items: *612 + items: *611 updated: type: array items: type: object properties: - rule: *612 + rule: *611 changes: type: object properties: @@ -221526,10 +224161,10 @@ x-webhooks: - from required: - owner - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -221607,10 +224242,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -221688,7 +224323,7 @@ x-webhooks: type: string enum: - create - alert: &795 + alert: &794 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -221810,10 +224445,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -222019,10 +224654,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -222100,11 +224735,11 @@ x-webhooks: type: string enum: - reopen - alert: *795 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + alert: *794 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -222303,10 +224938,10 @@ x-webhooks: enum: - fixed - open - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -222384,11 +225019,11 @@ x-webhooks: type: string enum: - assigned - alert: &796 + alert: &795 type: object properties: - number: *179 - created_at: *180 + number: *178 + created_at: *179 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -222396,8 +225031,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *182 - html_url: *183 + url: *181 + html_url: *182 locations_url: type: string format: uri @@ -222503,10 +225138,10 @@ x-webhooks: required: *21 nullable: true assignee: *4 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -222584,11 +225219,11 @@ x-webhooks: type: string enum: - created - alert: *796 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + alert: *795 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -222669,11 +225304,11 @@ x-webhooks: type: string enum: - created - alert: *796 - installation: *735 - location: *797 - organization: *736 - repository: *737 + alert: *795 + installation: *734 + location: *796 + organization: *735 + repository: *736 sender: *4 required: - location @@ -222911,11 +225546,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *796 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + alert: *795 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -222993,11 +225628,11 @@ x-webhooks: type: string enum: - reopened - alert: *796 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + alert: *795 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -223075,11 +225710,11 @@ x-webhooks: type: string enum: - resolved - alert: *796 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + alert: *795 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -223157,12 +225792,12 @@ x-webhooks: type: string enum: - unassigned - alert: *796 + alert: *795 assignee: *4 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -223240,11 +225875,11 @@ x-webhooks: type: string enum: - validated - alert: *796 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + alert: *795 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -223370,10 +226005,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *737 - enterprise: *734 - installation: *735 - organization: *736 + repository: *736 + enterprise: *733 + installation: *734 + organization: *735 sender: *4 required: - action @@ -223451,11 +226086,11 @@ x-webhooks: type: string enum: - published - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - security_advisory: &798 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + security_advisory: &797 description: The details of the security advisory, including summary, description, and severity. type: object @@ -223626,11 +226261,11 @@ x-webhooks: type: string enum: - updated - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 - security_advisory: *798 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 + security_advisory: *797 sender: *4 required: - action @@ -223703,10 +226338,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -223878,11 +226513,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *297 - enterprise: *734 - installation: *735 - organization: *736 - repository: *345 + security_and_analysis: *296 + enterprise: *733 + installation: *734 + organization: *735 + repository: *344 sender: *4 required: - changes @@ -223960,12 +226595,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - sponsorship: &799 + sponsorship: &798 type: object properties: created_at: @@ -224266,12 +226901,12 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - sponsorship: *799 + sponsorship: *798 required: - action - sponsorship @@ -224359,12 +226994,12 @@ x-webhooks: type: string required: - from - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - sponsorship: *799 + sponsorship: *798 required: - action - changes @@ -224441,17 +227076,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &800 + effective_date: &799 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: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - sponsorship: *799 + sponsorship: *798 required: - action - sponsorship @@ -224525,7 +227160,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &801 + changes: &800 type: object properties: tier: @@ -224569,13 +227204,13 @@ x-webhooks: - from required: - tier - effective_date: *800 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + effective_date: *799 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - sponsorship: *799 + sponsorship: *798 required: - action - changes @@ -224652,13 +227287,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *801 - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + changes: *800 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - sponsorship: *799 + sponsorship: *798 required: - action - changes @@ -224732,10 +227367,10 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -224818,10 +227453,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -225241,15 +227876,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *734 + enterprise: *733 id: description: The unique identifier of the status. type: integer - installation: *735 + installation: *734 name: type: string - organization: *736 - repository: *737 + organization: *735 + repository: *736 sender: *4 sha: description: The Commit SHA. @@ -225364,9 +227999,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *85 - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -225456,9 +228091,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *85 - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -225548,9 +228183,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *85 - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -225640,9 +228275,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *85 - installation: *735 - organization: *736 - repository: *737 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -225719,12 +228354,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - team: &802 + team: &801 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -225947,9 +228582,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 repository: title: Repository description: A git repository @@ -226407,7 +229042,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *802 + team: *801 required: - action - team @@ -226483,9 +229118,9 @@ x-webhooks: type: string enum: - created - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 repository: title: Repository description: A git repository @@ -226943,7 +229578,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *802 + team: *801 required: - action - team @@ -227020,9 +229655,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 repository: title: Repository description: A git repository @@ -227480,7 +230115,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *802 + team: *801 required: - action - team @@ -227624,9 +230259,9 @@ x-webhooks: - from required: - permissions - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 repository: title: Repository description: A git repository @@ -228084,7 +230719,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *802 + team: *801 required: - action - changes @@ -228162,9 +230797,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *734 - installation: *735 - organization: *736 + enterprise: *733 + installation: *734 + organization: *735 repository: title: Repository description: A git repository @@ -228622,7 +231257,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *802 + team: *801 required: - action - team @@ -228698,10 +231333,10 @@ x-webhooks: type: string enum: - started - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 required: - action @@ -228774,16 +231409,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *734 + enterprise: *733 inputs: type: object nullable: true additionalProperties: true - installation: *735 - organization: *736 + installation: *734 + organization: *735 ref: type: string - repository: *737 + repository: *736 sender: *4 workflow: type: string @@ -228865,10 +231500,10 @@ x-webhooks: type: string enum: - completed - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 workflow_job: allOf: @@ -229105,7 +231740,7 @@ x-webhooks: type: string required: - conclusion - deployment: *503 + deployment: *502 required: - action - repository @@ -229184,10 +231819,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 workflow_job: allOf: @@ -229447,7 +232082,7 @@ x-webhooks: required: - status - steps - deployment: *503 + deployment: *502 required: - action - repository @@ -229526,10 +232161,10 @@ x-webhooks: type: string enum: - queued - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 workflow_job: type: object @@ -229664,7 +232299,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *503 + deployment: *502 required: - action - repository @@ -229743,10 +232378,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 workflow_job: type: object @@ -229882,7 +232517,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *503 + deployment: *502 required: - action - repository @@ -229962,12 +232597,12 @@ x-webhooks: type: string enum: - completed - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - workflow: *751 + workflow: *750 workflow_run: title: Workflow Run type: object @@ -230966,12 +233601,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - workflow: *751 + workflow: *750 workflow_run: title: Workflow Run type: object @@ -231955,12 +234590,12 @@ x-webhooks: type: string enum: - requested - enterprise: *734 - installation: *735 - organization: *736 - repository: *737 + enterprise: *733 + installation: *734 + organization: *735 + repository: *736 sender: *4 - workflow: *751 + workflow: *750 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 460624832c..9f50e3921f 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.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": [ @@ -1331,12 +1335,10 @@ "name": "Uncontrolled Resource Consumption" } ], - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "credits": [ { "user": { @@ -2130,6 +2132,3291 @@ } } }, + "/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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + }, + "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", @@ -22950,7 +26237,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -24234,12 +27522,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -79636,10 +82922,7 @@ "type": "string" } } - }, - "required": [ - "include_claim_keys" - ] + } }, "examples": { "default": { @@ -94505,6 +97788,19 @@ "type": "string" } } + }, + "examples": { + "insufficient_repo_permissions": { + "value": { + "message": { + "cause": "artifact metadata write permission required on one or more repositories", + "repositories": [ + 123, + 345 + ] + } + } + } } } } @@ -115903,7 +119199,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -117187,12 +120484,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -156993,7 +160288,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" ], @@ -157720,7 +161015,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" ], @@ -212656,6 +215951,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -212737,6 +216038,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -212752,6 +216059,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -212767,6 +216080,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -212827,6 +216146,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -212842,6 +216167,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -212857,6 +216188,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -212872,6 +216209,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -212887,6 +216230,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ @@ -217858,6 +221207,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": [ @@ -218156,6 +221518,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." } } }, @@ -333719,7 +337094,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -334583,12 +337959,10 @@ "score": 8.7 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-200", @@ -335086,7 +338460,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -335959,12 +339334,10 @@ "score": 8.5 } }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, "cwes": [ { "cwe_id": "CWE-532", @@ -336290,7 +339663,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -538602,6 +541976,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -538683,6 +542063,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -538698,6 +542084,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -538713,6 +542105,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -538773,6 +542171,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -538788,6 +542192,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -538803,6 +542213,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -538818,6 +542234,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -538833,6 +542255,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ @@ -539740,6 +543168,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -539821,6 +543255,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -539836,6 +543276,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -539851,6 +543297,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -539911,6 +543363,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -539926,6 +543384,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -539941,6 +543405,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -539956,6 +543426,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -539971,6 +543447,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ @@ -540854,6 +544336,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -540935,6 +544423,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -540950,6 +544444,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -540965,6 +544465,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -541025,6 +544531,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -541040,6 +544552,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -541055,6 +544573,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -541070,6 +544594,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -541085,6 +544615,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ @@ -541471,6 +545007,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -541552,6 +545094,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -541567,6 +545115,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -541582,6 +545136,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -541642,6 +545202,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -541657,6 +545223,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -541672,6 +545244,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -541687,6 +545265,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -541702,6 +545286,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ @@ -792568,7 +796158,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -795093,7 +798684,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -797618,7 +801210,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -800143,7 +803736,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -802668,7 +806262,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -805193,7 +808788,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -807718,7 +811314,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -810243,7 +813840,8 @@ "enum": [ "unknown", "direct", - "transitive" + "transitive", + "inconclusive" ] } } @@ -1349586,6 +1353184,12 @@ "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.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" } }, "required": [ @@ -1349667,6 +1353271,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -1349682,6 +1353292,12 @@ "format": "uri", "description": "The API URL to get the issue where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1" } }, "required": [ @@ -1349697,6 +1353313,12 @@ "format": "uri", "description": "The API URL to get the issue comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" } }, "required": [ @@ -1349757,6 +1353379,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -1349772,6 +1353400,12 @@ "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846" } }, "required": [ @@ -1349787,6 +1353421,12 @@ "format": "uri", "description": "The API URL to get the pull request comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" } }, "required": [ @@ -1349802,6 +1353442,12 @@ "format": "uri", "description": "The API URL to get the pull request review where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" } }, "required": [ @@ -1349817,6 +1353463,12 @@ "format": "uri", "description": "The API URL to get the pull request review comment where the secret was detected.", "example": "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.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" } }, "required": [ diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 757377b646..8ab30411ae 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.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: @@ -879,7 +881,7 @@ paths: - subscriptions_url - type - url - type: &332 + type: &331 type: string description: The type of credit the user is receiving. enum: @@ -995,7 +997,7 @@ paths: - cwe_id: CWE-400 name: Uncontrolled Resource Consumption epss: - - percentage: 0.00045 + percentage: 0.00045 percentile: 0.16001e0 credits: - user: @@ -1072,7 +1074,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &661 + - &660 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1162,6 +1164,2534 @@ 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null + if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + 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 @@ -1628,7 +4158,7 @@ paths: schema: type: integer default: 30 - - &217 + - &216 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 @@ -1637,7 +4167,7 @@ paths: required: false schema: type: string - - &218 + - &217 name: status description: Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries @@ -1657,7 +4187,7 @@ paths: application/json: schema: type: array - items: &219 + items: &218 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1737,7 +4267,7 @@ paths: - installation_id - repository_id examples: - default: &220 + default: &219 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1865,7 +4395,7 @@ paths: description: Response content: application/json: - schema: &221 + schema: &220 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1979,7 +4509,7 @@ paths: - request - response examples: - default: &222 + default: &221 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2964,7 +5494,7 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: &296 + properties: &295 id: description: Unique identifier of the repository example: 42 @@ -3415,7 +5945,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &297 + required: &296 - archive_url - assignees_url - blobs_url @@ -3489,7 +6019,7 @@ paths: - watchers_count - created_at - updated_at - x-github-breaking-changes: &298 + x-github-breaking-changes: &297 - changeset: remove_use_squash_pr_title_as_default patch: properties: @@ -8138,7 +10668,7 @@ paths: description: Response content: application/json: - schema: &190 + schema: &189 type: array description: A list of default code security configurations items: @@ -8154,7 +10684,7 @@ paths: default configuration: *49 examples: - default: &191 + default: &190 value: - default_for_new_repos: public configuration: @@ -8494,7 +11024,7 @@ paths: - *40 - *51 responses: - '204': &192 + '204': &191 description: A header with no content is returned. '400': *14 '403': *29 @@ -8621,7 +11151,7 @@ paths: default: value: default_for_new_repos: all - configuration: &189 + configuration: &188 value: id: 1325 target_type: organization @@ -8706,7 +11236,7 @@ paths: application/json: schema: type: array - items: &193 + items: &192 type: object description: Repositories associated with a code security configuration and attachment status @@ -9007,7 +11537,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &194 + repository: &193 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -9307,7 +11837,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &200 + - &199 name: state in: query description: |- @@ -9316,7 +11846,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &201 + - &200 name: severity in: query description: |- @@ -9325,7 +11855,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &202 + - &201 name: ecosystem in: query description: |- @@ -9334,14 +11864,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &203 + - &202 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 - - &204 + - &203 name: epss_percentage in: query description: |- @@ -9353,7 +11883,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 - - &495 + - &494 name: has in: query description: |- @@ -9367,7 +11897,7 @@ paths: type: string enum: - patch - - &205 + - &204 name: assignee in: query description: |- @@ -9376,7 +11906,7 @@ paths: Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. schema: type: string - - &206 + - &205 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -9386,7 +11916,7 @@ paths: enum: - development - runtime - - &207 + - &206 name: sort in: query description: |- @@ -9412,11 +11942,11 @@ paths: application/json: schema: type: array - items: &208 + items: &207 type: object description: A Dependabot alert. properties: - number: &179 + number: &178 type: integer description: The security alert number. readOnly: true @@ -9478,7 +12008,8 @@ paths: - unknown - direct - transitive - security_advisory: &496 + - inconclusive + security_advisory: &495 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9700,29 +12231,29 @@ paths: - withdrawn_at version: '2026-03-10' security_vulnerability: *65 - url: &182 + url: &181 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &183 + html_url: &182 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &180 + created_at: &179 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: &181 + updated_at: &180 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: &185 + dismissed_at: &184 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -9752,21 +12283,21 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: &184 + fixed_at: &183 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - auto_dismissed_at: &497 + auto_dismissed_at: &496 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissal_request: &498 + dismissal_request: &497 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -9828,7 +12359,7 @@ paths: - repository additionalProperties: false examples: - default: &209 + default: &208 value: - number: 2 state: dismissed @@ -9877,7 +12408,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 @@ -10643,7 +13174,7 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: &196 + properties: &195 login: type: string example: github @@ -10684,7 +13215,7 @@ paths: type: string example: A great organization nullable: true - required: &197 + required: &196 - login - url - id @@ -11164,7 +13695,7 @@ paths: properties: action: type: string - discussion: &755 + discussion: &754 title: Discussion description: A Discussion in a repository. type: object @@ -11531,7 +14062,7 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &549 + properties: &548 id: type: integer format: int64 @@ -11644,7 +14175,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &280 + properties: &279 url: type: string format: uri @@ -11714,7 +14245,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &281 + required: &280 - closed_issues - creator - description @@ -11793,7 +14324,7 @@ paths: timeline_url: type: string format: uri - type: &243 + type: &242 title: Issue Type description: The type of issue. type: object @@ -11907,7 +14438,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &673 + sub_issues_summary: &672 title: Sub-issues Summary type: object properties: @@ -11994,7 +14525,7 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: &572 + properties: &571 pinned_at: type: string format: date-time @@ -12006,7 +14537,7 @@ paths: properties: *20 required: *21 nullable: true - required: &573 + required: &572 - pinned_at - pinned_by nullable: true @@ -12020,7 +14551,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &674 + issue_dependencies_summary: &673 title: Issue Dependencies Summary type: object properties: @@ -12039,7 +14570,7 @@ paths: - total_blocking issue_field_values: type: array - items: &557 + items: &556 title: Issue Field Value description: A value assigned to an issue field type: object @@ -12100,7 +14631,7 @@ paths: - node_id - data_type - value - required: &550 + required: &549 - assignee - closed_at - comments @@ -12121,7 +14652,7 @@ paths: - user - created_at - updated_at - x-github-breaking-changes: &551 + x-github-breaking-changes: &550 - changeset: deprecate_beta_media_type patch: properties: @@ -12181,7 +14712,7 @@ paths: action: type: string issue: *85 - comment: &545 + comment: &544 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -12845,7 +15376,7 @@ paths: type: string release: allOf: - - &606 + - &605 title: Release description: A release. type: object @@ -12916,7 +15447,7 @@ paths: author: *4 assets: type: array - items: &607 + items: &606 title: Release Asset description: Data related to a release. type: object @@ -13536,7 +16067,7 @@ paths: url: type: string format: uri - user: &680 + user: &679 title: Public User description: Public User type: object @@ -15416,7 +17947,7 @@ paths: - closed - all default: open - - &246 + - &245 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -15467,7 +17998,7 @@ paths: type: array items: *85 examples: - default: &247 + default: &246 value: - id: 1 node_id: MDU6SXNzdWUx @@ -16852,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: - - &344 + - &343 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &345 + - &344 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -16921,7 +19452,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &348 + '301': &347 description: Moved permanently content: application/json: @@ -16943,7 +19474,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &582 + - &581 name: all description: If `true`, show notifications marked as read. in: query @@ -16951,7 +19482,7 @@ paths: schema: type: boolean default: false - - &583 + - &582 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -16961,7 +19492,7 @@ paths: type: boolean default: false - *92 - - &584 + - &583 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: @@ -16993,11 +19524,11 @@ paths: properties: id: type: string - repository: &161 + repository: &160 title: Minimal Repository description: Minimal Repository type: object - properties: &211 + properties: &210 id: type: integer format: int64 @@ -17283,7 +19814,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &299 + security_and_analysis: &298 nullable: true type: object properties: @@ -17396,7 +19927,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &212 + required: &211 - archive_url - assignees_url - blobs_url @@ -17443,7 +19974,7 @@ paths: - teams_url - trees_url - url - x-github-breaking-changes: &213 + x-github-breaking-changes: &212 - changeset: remove_has_downloads patch: properties: @@ -17490,7 +20021,7 @@ paths: - url - subscription_url examples: - default: &585 + default: &584 value: - id: '1' repository: @@ -19037,7 +21568,7 @@ paths: required: false schema: type: string - - &730 + - &729 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -19183,7 +21714,7 @@ paths: parameters: - *75 - *123 - - &731 + - &730 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 @@ -19295,7 +21826,7 @@ paths: - *123 - *125 - *124 - - &732 + - &731 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -19303,7 +21834,7 @@ paths: schema: type: string - *126 - - &733 + - &732 name: sku description: The SKU to query for usage. in: query @@ -20233,7 +22764,7 @@ paths: type: integer repository_cache_usages: type: array - items: &355 + items: &354 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -20456,7 +22987,7 @@ paths: - public_ip_enabled - platform examples: - default: &160 + default: &159 value: total_count: 2 runners: @@ -21430,7 +23961,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &143 + schema: title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -21444,7 +23975,7 @@ paths: required: - include_claim_keys examples: - default: &144 + default: &143 value: include_claim_keys: - repo @@ -21471,15 +24002,25 @@ paths: required: true content: application/json: - schema: *143 + 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: *144 + default: *143 responses: '201': description: Empty response content: application/json: - schema: &170 + schema: &169 title: Empty Object description: An object without any properties. type: object @@ -21518,7 +24059,7 @@ paths: schema: type: object properties: - enabled_repositories: &145 + enabled_repositories: &144 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -21531,7 +24072,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: &146 + allowed_actions: &145 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -21539,12 +24080,12 @@ paths: - all - local_only - selected - selected_actions_url: &361 + selected_actions_url: &360 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: &147 + sha_pinning_required: &146 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -21586,9 +24127,9 @@ paths: schema: type: object properties: - enabled_repositories: *145 - allowed_actions: *146 - sha_pinning_required: *147 + enabled_repositories: *144 + allowed_actions: *145 + sha_pinning_required: *146 required: - enabled_repositories examples: @@ -21622,7 +24163,7 @@ paths: description: Response content: application/json: - schema: &365 + schema: &364 type: object properties: days: @@ -21664,7 +24205,7 @@ paths: required: true content: application/json: - schema: &366 + schema: &365 type: object properties: days: @@ -21707,7 +24248,7 @@ paths: description: Response content: application/json: - schema: &148 + schema: &147 type: object properties: approval_policy: @@ -21721,7 +24262,7 @@ paths: required: - approval_policy examples: - default: &367 + default: &366 value: approval_policy: first_time_contributors '404': *6 @@ -21752,7 +24293,7 @@ paths: required: true content: application/json: - schema: *148 + schema: *147 examples: default: summary: Set approval policy to first time contributors @@ -21780,7 +24321,7 @@ paths: description: Response content: application/json: - schema: &368 + schema: &367 type: object required: - run_workflows_from_fork_pull_requests @@ -21806,7 +24347,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &149 + default: &148 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -21834,7 +24375,7 @@ paths: required: true content: application/json: - schema: &369 + schema: &368 type: object required: - run_workflows_from_fork_pull_requests @@ -21857,7 +24398,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *149 + default: *148 responses: '204': description: Empty response for successful settings update @@ -21907,7 +24448,7 @@ paths: type: array items: *79 examples: - default: &153 + default: &152 value: total_count: 1 repositories: @@ -22092,7 +24633,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *75 - - &150 + - &149 name: repository_id description: The unique identifier of the repository. in: path @@ -22121,7 +24662,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *75 - - *150 + - *149 responses: '204': description: Response @@ -22150,7 +24691,7 @@ paths: description: Response content: application/json: - schema: &151 + schema: &150 type: object properties: github_owned_allowed: @@ -22172,7 +24713,7 @@ paths: items: type: string examples: - default: &152 + default: &151 value: github_owned_allowed: true verified_allowed: false @@ -22205,9 +24746,9 @@ paths: required: false content: application/json: - schema: *151 + schema: *150 examples: - selected_actions: *152 + selected_actions: *151 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22339,7 +24880,7 @@ paths: type: array items: *79 examples: - default: *153 + default: *152 '403': *29 '404': *6 x-github: @@ -22408,7 +24949,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: - *75 - - *150 + - *149 responses: '204': description: No content @@ -22435,7 +24976,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: - *75 - - *150 + - *149 responses: '204': description: No content @@ -22469,17 +25010,17 @@ paths: description: Response content: application/json: - schema: &370 + schema: &369 type: object properties: - default_workflow_permissions: &154 + default_workflow_permissions: &153 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &155 + can_approve_pull_request_reviews: &154 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -22487,7 +25028,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &156 + default: &155 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -22520,13 +25061,13 @@ paths: required: false content: application/json: - schema: &371 + schema: &370 type: object properties: - default_workflow_permissions: *154 - can_approve_pull_request_reviews: *155 + default_workflow_permissions: *153 + can_approve_pull_request_reviews: *154 examples: - default: *156 + default: *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22571,7 +25112,7 @@ paths: type: number runner_groups: type: array - items: &157 + items: &156 type: object properties: id: @@ -22759,9 +25300,9 @@ paths: description: Response content: application/json: - schema: *157 + schema: *156 examples: - default: &159 + default: &158 value: id: 2 name: octo-runner-group @@ -22797,7 +25338,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - *75 - - &158 + - &157 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -22809,7 +25350,7 @@ paths: description: Response content: application/json: - schema: *157 + schema: *156 examples: default: value: @@ -22846,7 +25387,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - *75 - - *158 + - *157 requestBody: required: true content: @@ -22900,9 +25441,9 @@ paths: description: Response content: application/json: - schema: *157 + schema: *156 examples: - default: *159 + default: *158 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22922,7 +25463,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - *75 - - *158 + - *157 responses: '204': description: Response @@ -22946,7 +25487,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - *75 - - *158 + - *157 - *17 - *19 responses: @@ -22966,7 +25507,7 @@ paths: type: array items: *131 examples: - default: *160 + default: *159 headers: Link: *67 x-github: @@ -22989,7 +25530,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: - *75 - - *158 + - *157 - *19 - *17 responses: @@ -23007,9 +25548,9 @@ paths: type: number repositories: type: array - items: *161 + items: *160 examples: - default: &199 + default: &198 value: total_count: 1 repositories: @@ -23262,7 +25803,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: - *75 - - *158 + - *157 requestBody: required: true content: @@ -23307,8 +25848,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: - *75 - - *158 - - *150 + - *157 + - *149 responses: '204': description: Response @@ -23331,8 +25872,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: - *75 - - *158 - - *150 + - *157 + - *149 responses: '204': description: Response @@ -23356,7 +25897,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - *75 - - *158 + - *157 - *17 - *19 responses: @@ -23374,7 +25915,7 @@ paths: type: number runners: type: array - items: &163 + items: &162 title: Self hosted runners description: A self hosted runner type: object @@ -23403,7 +25944,7 @@ paths: type: boolean labels: type: array - items: &166 + items: &165 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -23433,7 +25974,7 @@ paths: - busy - labels examples: - default: &164 + default: &163 value: total_count: 2 runners: @@ -23493,7 +26034,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - *75 - - *158 + - *157 requestBody: required: true content: @@ -23538,8 +26079,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: - *75 - - *158 - - &162 + - *157 + - &161 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -23568,8 +26109,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: - *75 - - *158 - - *162 + - *157 + - *161 responses: '204': description: Response @@ -23617,9 +26158,9 @@ paths: type: integer runners: type: array - items: *163 + items: *162 examples: - default: *164 + default: *163 headers: Link: *67 x-github: @@ -23651,7 +26192,7 @@ paths: application/json: schema: type: array - items: &372 + items: &371 title: Runner Application description: Runner Application type: object @@ -23676,7 +26217,7 @@ paths: - download_url - filename examples: - default: &373 + default: &372 value: - os: osx architecture: x64 @@ -23762,7 +26303,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &374 + '201': &373 description: Response content: application/json: @@ -23772,7 +26313,7 @@ paths: - runner - encoded_jit_config properties: - runner: *163 + runner: *162 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -23835,7 +26376,7 @@ paths: description: Response content: application/json: - schema: &165 + schema: &164 title: Authentication Token description: Authentication Token type: object @@ -23873,7 +26414,7 @@ paths: - token - expires_at examples: - default: &375 + default: &374 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -23910,9 +26451,9 @@ paths: description: Response content: application/json: - schema: *165 + schema: *164 examples: - default: &376 + default: &375 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -23938,15 +26479,15 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - *75 - - *162 + - *161 responses: '200': description: Response content: application/json: - schema: *163 + schema: *162 examples: - default: &377 + default: &376 value: id: 23 name: MBP @@ -23988,7 +26529,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - *75 - - *162 + - *161 responses: '204': description: Response @@ -24015,9 +26556,9 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - *75 - - *162 + - *161 responses: - '200': &167 + '200': &166 description: Response content: application/json: @@ -24031,7 +26572,7 @@ paths: type: integer labels: type: array - items: *166 + items: *165 examples: default: value: @@ -24071,7 +26612,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - *75 - - *162 + - *161 requestBody: required: true content: @@ -24095,7 +26636,7 @@ paths: - gpu - accelerated responses: - '200': *167 + '200': *166 '404': *6 '422': *7 x-github: @@ -24120,7 +26661,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - *75 - - *162 + - *161 requestBody: required: true content: @@ -24145,7 +26686,7 @@ paths: - gpu - accelerated responses: - '200': *167 + '200': *166 '404': *6 '422': *7 x-github: @@ -24170,9 +26711,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: - *75 - - *162 + - *161 responses: - '200': &378 + '200': &377 description: Response content: application/json: @@ -24186,7 +26727,7 @@ paths: type: integer labels: type: array - items: *166 + items: *165 examples: default: value: @@ -24228,8 +26769,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: - *75 - - *162 - - &379 + - *161 + - &378 name: name description: The name of a self-hosted runner's custom label. in: path @@ -24237,7 +26778,7 @@ paths: schema: type: string responses: - '200': *167 + '200': *166 '404': *6 '422': *7 x-github: @@ -24280,7 +26821,7 @@ paths: type: integer secrets: type: array - items: &168 + items: &167 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -24359,7 +26900,7 @@ paths: description: Response content: application/json: - schema: &391 + schema: &390 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -24388,7 +26929,7 @@ paths: - key_id - key examples: - default: &392 + default: &391 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -24414,7 +26955,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - *75 - - &169 + - &168 name: secret_name description: The name of the secret. in: path @@ -24426,7 +26967,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *167 examples: default: value: @@ -24457,7 +26998,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -24514,7 +27055,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -24541,7 +27082,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - *75 - - *169 + - *168 responses: '204': description: Response @@ -24568,7 +27109,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - *75 - - *169 + - *168 - *19 - *17 responses: @@ -24586,9 +27127,9 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 examples: - default: &173 + default: &172 value: total_count: 1 repositories: @@ -24681,7 +27222,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -24734,7 +27275,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - *75 - - *169 + - *168 - name: repository_id in: path required: true @@ -24768,7 +27309,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - *75 - - *169 + - *168 - name: repository_id in: path required: true @@ -24801,7 +27342,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *75 - - &360 + - &359 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)." @@ -24825,7 +27366,7 @@ paths: type: integer variables: type: array - items: &171 + items: &170 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -24958,7 +27499,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -24984,7 +27525,7 @@ paths: url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - *75 - - &172 + - &171 name: name description: The name of the variable. in: path @@ -24996,7 +27537,7 @@ paths: description: Response content: application/json: - schema: *171 + schema: *170 examples: default: value: @@ -25027,7 +27568,7 @@ paths: url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - *75 - - *172 + - *171 requestBody: required: true content: @@ -25090,7 +27631,7 @@ paths: url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - *75 - - *172 + - *171 responses: '204': description: Response @@ -25117,7 +27658,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - *75 - - *172 + - *171 - *19 - *17 responses: @@ -25135,9 +27676,9 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 examples: - default: *173 + default: *172 '409': description: Response when the visibility of the variable is not set to `selected` @@ -25164,7 +27705,7 @@ paths: url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - *75 - - *172 + - *171 requestBody: required: true content: @@ -25214,7 +27755,7 @@ paths: url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - *75 - - *172 + - *171 - name: repository_id in: path required: true @@ -25249,7 +27790,7 @@ paths: url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - *75 - - *172 + - *171 - name: repository_id in: path required: true @@ -25406,7 +27947,7 @@ paths: type: integer deployment_records: type: array - items: &174 + items: &173 title: Artifact Deployment Record description: Artifact Metadata Deployment Record type: object @@ -25450,7 +27991,7 @@ paths: with the deployment record. nullable: true examples: - default: &175 + default: &174 value: total_count: 1 deployment_records: @@ -25623,10 +28164,23 @@ paths: type: integer deployment_records: type: array - items: *174 + items: *173 examples: - default: *175 - '403': *29 + default: *174 + '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 @@ -25826,9 +28380,9 @@ paths: type: integer deployment_records: type: array - items: *174 + items: *173 examples: - default: *175 + default: *174 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25957,12 +28511,12 @@ paths: required: - subject_digests examples: - default: &712 + default: &711 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &713 + withPredicateType: &712 value: subject_digests: - sha256:abc123 @@ -26020,7 +28574,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &714 + default: &713 value: attestations_subject_digests: - sha256:abc: @@ -26385,7 +28939,7 @@ paths: initiator: type: string examples: - default: &405 + default: &404 value: attestations: - bundle: @@ -26618,7 +29172,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &176 + schema: &175 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -26644,7 +29198,7 @@ paths: application/json: schema: type: array - items: &177 + items: &176 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -26675,7 +29229,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &198 + items: &197 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -26750,7 +29304,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &258 + properties: &257 id: description: Unique identifier of the team type: integer @@ -26822,7 +29376,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &259 + required: &258 - id - node_id - url @@ -26865,7 +29419,7 @@ paths: type: string format: date-time nullable: true - state: *176 + state: *175 contact_link: description: The contact link of the campaign. type: string @@ -27085,9 +29639,9 @@ paths: description: Response content: application/json: - schema: *177 + schema: *176 examples: - default: &178 + default: &177 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -27170,9 +29724,9 @@ paths: description: Response content: application/json: - schema: *177 + schema: *176 examples: - default: *178 + default: *177 '404': *6 '422': description: Unprocessable Entity @@ -27249,7 +29803,7 @@ paths: type: string format: uri nullable: true - state: *176 + state: *175 examples: default: value: @@ -27259,9 +29813,9 @@ paths: description: Response content: application/json: - schema: *177 + schema: *176 examples: - default: *178 + default: *177 '400': description: Bad Request content: @@ -27328,17 +29882,17 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *75 - - &430 + - &429 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: &186 + schema: &185 type: string description: The name of the tool used to generate the code scanning analysis. - - &431 + - &430 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 @@ -27346,7 +29900,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &187 + schema: &186 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, @@ -27361,7 +29915,7 @@ paths: be returned. in: query required: false - schema: &433 + schema: &432 type: string description: State of a code scanning alert. enum: @@ -27384,7 +29938,7 @@ paths: be returned. in: query required: false - schema: &434 + schema: &433 type: string description: Severity of a code scanning alert. enum: @@ -27413,18 +29967,18 @@ paths: items: type: object properties: - number: *179 - created_at: *180 - updated_at: *181 - url: *182 - html_url: *183 - instances_url: &435 + number: *178 + created_at: *179 + updated_at: *180 + url: *181 + html_url: *182 + instances_url: &434 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &188 + state: &187 type: string description: State of a code scanning alert. nullable: true @@ -27432,7 +29986,7 @@ paths: - open - dismissed - fixed - fixed_at: *184 + fixed_at: *183 dismissed_by: title: Simple User description: A GitHub user. @@ -27440,8 +29994,8 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *185 - dismissed_reason: &436 + dismissed_at: *184 + dismissed_reason: &435 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -27450,13 +30004,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &437 + dismissed_comment: &436 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &438 + rule: &437 type: object properties: id: @@ -27509,42 +30063,42 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &439 + tool: &438 type: object properties: - name: *186 + name: *185 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *187 - most_recent_instance: &440 + guid: *186 + most_recent_instance: &439 type: object properties: - ref: &432 + ref: &431 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &450 + analysis_key: &449 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: &451 + environment: &450 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: &452 + category: &451 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: *188 + state: *187 commit_sha: type: string message: @@ -27558,7 +30112,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: &453 + location: &452 type: object description: Describe a region within a file for the alert. properties: @@ -27579,7 +30133,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: &454 + items: &453 type: string description: A classification of the file. For example to identify it as generated. @@ -28216,7 +30770,7 @@ paths: application/json: schema: *49 examples: - default: *189 + default: *188 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28244,9 +30798,9 @@ paths: description: Response content: application/json: - schema: *190 + schema: *189 examples: - default: *191 + default: *190 '304': *37 '403': *29 '404': *6 @@ -28298,7 +30852,7 @@ paths: - 32 - 91 responses: - '204': *192 + '204': *191 '400': *14 '403': *29 '404': *6 @@ -28333,7 +30887,7 @@ paths: application/json: schema: *49 examples: - default: *189 + default: *188 '304': *37 '403': *29 '404': *6 @@ -28633,7 +31187,7 @@ paths: - *75 - *51 responses: - '204': *192 + '204': *191 '400': *14 '403': *29 '404': *6 @@ -28771,7 +31325,7 @@ paths: default: value: default_for_new_repos: all - configuration: *189 + configuration: *188 '403': *29 '404': *6 x-github: @@ -28824,13 +31378,13 @@ paths: application/json: schema: type: array - items: *193 + items: *192 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *194 + repository: *193 '403': *29 '404': *6 x-github: @@ -28870,7 +31424,7 @@ paths: type: integer codespaces: type: array - items: &248 + items: &247 type: object title: Codespace description: A codespace. @@ -28895,12 +31449,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *161 + repository: *160 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &466 + properties: &465 name: type: string description: The name of the machine. @@ -28942,7 +31496,7 @@ paths: - ready - in_progress nullable: true - required: &467 + required: &466 - name - display_name - operating_system @@ -29147,7 +31701,7 @@ paths: - pulls_url - recent_folders examples: - default: &249 + default: &248 value: total_count: 3 codespaces: @@ -29771,7 +32325,7 @@ paths: type: integer secrets: type: array - items: &195 + items: &194 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -29810,7 +32364,7 @@ paths: - updated_at - visibility examples: - default: &468 + default: &467 value: total_count: 2 secrets: @@ -29848,7 +32402,7 @@ paths: description: Response content: application/json: - schema: &469 + schema: &468 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -29877,7 +32431,7 @@ paths: - key_id - key examples: - default: &470 + default: &469 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -29901,15 +32455,15 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - *75 - - *169 + - *168 responses: '200': description: Response content: application/json: - schema: *195 + schema: *194 examples: - default: &472 + default: &471 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -29937,7 +32491,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -29992,7 +32546,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -30019,7 +32573,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - *75 - - *169 + - *168 responses: '204': description: Response @@ -30045,7 +32599,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - *75 - - *169 + - *168 - *19 - *17 responses: @@ -30063,9 +32617,9 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 examples: - default: *173 + default: *172 '404': *6 x-github: githubCloudOnly: false @@ -30088,7 +32642,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -30139,7 +32693,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - *75 - - *169 + - *168 - name: repository_id in: path required: true @@ -30173,7 +32727,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - *75 - - *169 + - *168 - name: repository_id in: path required: true @@ -30376,7 +32930,7 @@ paths: currently being billed. seats: type: array - items: &251 + items: &250 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -30393,14 +32947,14 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *196 - required: *197 + properties: *195 + required: *196 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *198 + - *197 - *68 nullable: true pending_cancellation_date: @@ -31007,12 +33561,12 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 required: - total_count - repositories examples: - default: *199 + default: *198 '500': *55 '401': *25 '403': *29 @@ -31098,7 +33652,7 @@ paths: url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization parameters: - *75 - - *150 + - *149 responses: '204': description: No Content @@ -31132,7 +33686,7 @@ paths: url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization parameters: - *75 - - *150 + - *149 responses: '204': description: No Content @@ -31347,7 +33901,7 @@ paths: application/json: schema: type: array - items: &337 + items: &336 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -31654,7 +34208,7 @@ paths: - date additionalProperties: true examples: - default: &338 + default: &337 value: - date: '2024-06-24' total_active_users: 24 @@ -31756,7 +34310,7 @@ paths: '500': *55 '403': *29 '404': *6 - '422': &339 + '422': &338 description: Copilot Usage Metrics API setting is disabled at the organization or enterprise level. content: @@ -31797,7 +34351,7 @@ paths: schema: *57 examples: default: *58 - '204': *192 + '204': *191 '500': *55 '403': *29 '404': *6 @@ -31873,7 +34427,7 @@ paths: schema: *57 examples: default: *58 - '204': *192 + '204': *191 '500': *55 '403': *29 '404': *6 @@ -31936,11 +34490,11 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *75 + - *199 - *200 - *201 - *202 - *203 - - *204 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -31970,7 +34524,7 @@ paths: enum: - patch - deployment - - *205 + - *204 - name: runtime_risk in: query description: |- @@ -31979,8 +34533,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string + - *205 - *206 - - *207 - *61 - *47 - *48 @@ -31992,9 +34546,9 @@ paths: application/json: schema: type: array - items: *208 + items: *207 examples: - default: *209 + default: *208 '304': *37 '400': *14 '403': *29 @@ -32038,7 +34592,7 @@ paths: type: integer secrets: type: array - items: &210 + items: &209 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -32115,7 +34669,7 @@ paths: description: Response content: application/json: - schema: &501 + schema: &500 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -32132,7 +34686,7 @@ paths: - key_id - key examples: - default: &502 + default: &501 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -32156,13 +34710,13 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - *75 - - *169 + - *168 responses: '200': description: Response content: application/json: - schema: *210 + schema: *209 examples: default: value: @@ -32191,7 +34745,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -32248,7 +34802,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -32281,7 +34835,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - *75 - - *169 + - *168 responses: '204': description: Response @@ -32306,7 +34860,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - *75 - - *169 + - *168 - *19 - *17 responses: @@ -32324,9 +34878,9 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 examples: - default: *173 + default: *172 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32348,7 +34902,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -32399,7 +34953,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - *75 - - *169 + - *168 - name: repository_id in: path required: true @@ -32431,7 +34985,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - *75 - - *169 + - *168 - name: repository_id in: path required: true @@ -32469,7 +35023,7 @@ paths: application/json: schema: type: array - items: &261 + items: &260 title: Package description: A software package type: object @@ -32519,9 +35073,9 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *211 - required: *212 - x-github-breaking-changes: *213 + properties: *210 + required: *211 + x-github-breaking-changes: *212 nullable: true created_at: type: string @@ -32540,7 +35094,7 @@ paths: - created_at - updated_at examples: - default: &262 + default: &261 value: - id: 197 name: hello_docker @@ -32710,7 +35264,7 @@ paths: application/json: schema: type: array - items: &237 + items: &236 title: Organization Invitation description: Organization Invitation type: object @@ -32757,7 +35311,7 @@ paths: - invitation_teams_url - node_id examples: - default: &238 + default: &237 value: - id: 1 login: monalisa @@ -32824,7 +35378,7 @@ paths: application/json: schema: type: array - items: &214 + items: &213 title: Org Hook description: Org Hook type: object @@ -32995,9 +35549,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *213 examples: - default: &215 + default: &214 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -33045,7 +35599,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - *75 - - &216 + - &215 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. @@ -33058,9 +35612,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *213 examples: - default: *215 + default: *214 '404': *6 x-github: githubCloudOnly: false @@ -33088,7 +35642,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - *75 - - *216 + - *215 requestBody: required: false content: @@ -33133,7 +35687,7 @@ paths: description: Response content: application/json: - schema: *214 + schema: *213 examples: default: value: @@ -33175,7 +35729,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - *75 - - *216 + - *215 responses: '204': description: Response @@ -33203,7 +35757,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *75 - - *216 + - *215 responses: '200': description: Response @@ -33234,7 +35788,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *75 - - *216 + - *215 requestBody: required: false content: @@ -33285,10 +35839,10 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *75 - - *216 + - *215 - *17 + - *216 - *217 - - *218 responses: '200': description: Response @@ -33296,9 +35850,9 @@ paths: application/json: schema: type: array - items: *219 + items: *218 examples: - default: *220 + default: *219 '400': *14 '422': *15 x-github: @@ -33324,16 +35878,16 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *75 - - *216 + - *215 - *16 responses: '200': description: Response content: application/json: - schema: *221 + schema: *220 examples: - default: *222 + default: *221 '400': *14 '422': *15 x-github: @@ -33359,7 +35913,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *75 - - *216 + - *215 - *16 responses: '202': *39 @@ -33389,7 +35943,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - *75 - - *216 + - *215 responses: '204': description: Response @@ -33412,7 +35966,7 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - *75 - - &227 + - &226 name: actor_type in: path description: The type of the actor @@ -33425,14 +35979,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &228 + - &227 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &223 + - &222 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`.' @@ -33440,7 +35994,7 @@ paths: required: true schema: type: string - - &224 + - &223 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) @@ -33534,12 +36088,12 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - *75 + - *222 - *223 - - *224 - *19 - *17 - *61 - - &233 + - &232 name: sort description: The property to sort the results by. in: query @@ -33617,14 +36171,14 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - *75 + - *222 - *223 - - *224 responses: '200': description: Response content: application/json: - schema: &225 + schema: &224 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -33640,7 +36194,7 @@ paths: type: integer format: int64 examples: - default: &226 + default: &225 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -33661,23 +36215,23 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - *75 - - &229 + - &228 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string + - *222 - *223 - - *224 responses: '200': description: Response content: application/json: - schema: *225 + schema: *224 examples: - default: *226 + default: *225 x-github: enabledForGitHubApps: true category: orgs @@ -33696,18 +36250,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *75 + - *222 - *223 - - *224 + - *226 - *227 - - *228 responses: '200': description: Response content: application/json: - schema: *225 + schema: *224 examples: - default: *226 + default: *225 x-github: enabledForGitHubApps: true category: orgs @@ -33725,9 +36279,9 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - *75 + - *222 - *223 - - *224 - - &230 + - &229 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -33740,7 +36294,7 @@ paths: description: Response content: application/json: - schema: &231 + schema: &230 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -33756,7 +36310,7 @@ paths: type: integer format: int64 examples: - default: &232 + default: &231 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -33793,18 +36347,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - *75 - - *229 + - *228 + - *222 - *223 - - *224 - - *230 + - *229 responses: '200': description: Response content: application/json: - schema: *231 + schema: *230 examples: - default: *232 + default: *231 x-github: enabledForGitHubApps: true category: orgs @@ -33822,19 +36376,19 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - *75 + - *226 - *227 - - *228 + - *222 - *223 - - *224 - - *230 + - *229 responses: '200': description: Response content: application/json: - schema: *231 + schema: *230 examples: - default: *232 + default: *231 x-github: enabledForGitHubApps: true category: orgs @@ -33852,13 +36406,13 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - *75 - - *229 + - *228 + - *222 - *223 - - *224 - *19 - *17 - *61 - - *233 + - *232 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -33939,7 +36493,7 @@ paths: application/json: schema: *22 examples: - default: &540 + default: &539 value: id: 1 account: @@ -34105,12 +36659,12 @@ paths: application/json: schema: anyOf: - - &235 + - &234 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &234 + limit: &233 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -34135,7 +36689,7 @@ paths: properties: {} additionalProperties: false examples: - default: &236 + default: &235 value: limit: collaborators_only origin: organization @@ -34164,13 +36718,13 @@ paths: required: true content: application/json: - schema: &541 + schema: &540 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *234 + limit: *233 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -34194,9 +36748,9 @@ paths: description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '422': *15 x-github: githubCloudOnly: false @@ -34272,9 +36826,9 @@ paths: application/json: schema: type: array - items: *237 + items: *236 examples: - default: *238 + default: *237 headers: Link: *67 '404': *6 @@ -34351,7 +36905,7 @@ paths: description: Response content: application/json: - schema: *237 + schema: *236 examples: default: value: @@ -34406,7 +36960,7 @@ paths: url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - *75 - - &239 + - &238 name: invitation_id description: The unique identifier of the invitation. in: path @@ -34437,7 +36991,7 @@ paths: url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - *75 - - *239 + - *238 - *17 - *19 responses: @@ -34447,9 +37001,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: &260 + default: &259 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -34492,7 +37046,7 @@ paths: application/json: schema: type: array - items: &240 + items: &239 title: Issue Field description: A custom attribute defined at the organization level for attaching structured data to issues. @@ -34725,9 +37279,9 @@ paths: description: Response content: application/json: - schema: *240 + schema: *239 examples: - default: &241 + default: &240 value: id: 512 node_id: IF_kwDNAd3NAZr @@ -34783,7 +37337,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-fields#update-issue-field-for-an-organization parameters: - *75 - - &242 + - &241 name: issue_field_id description: The unique identifier of the issue field. in: path @@ -34882,9 +37436,9 @@ paths: description: Response content: application/json: - schema: *240 + schema: *239 examples: - default: *241 + default: *240 '404': *6 '422': *7 x-github: @@ -34909,9 +37463,9 @@ paths: url: https://docs.github.com/rest/orgs/issue-fields#delete-issue-field-for-an-organization parameters: - *75 - - *242 + - *241 responses: - '204': *192 + '204': *191 '404': *6 '422': *7 x-github: @@ -34939,7 +37493,7 @@ paths: application/json: schema: type: array - items: *243 + items: *242 examples: default: value: @@ -35024,9 +37578,9 @@ paths: description: Response content: application/json: - schema: *243 + schema: *242 examples: - default: &244 + default: &243 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -35059,7 +37613,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *75 - - &245 + - &244 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -35112,9 +37666,9 @@ paths: description: Response content: application/json: - schema: *243 + schema: *242 examples: - default: *244 + default: *243 '404': *6 '422': *7 x-github: @@ -35139,7 +37693,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *75 - - *245 + - *244 responses: '204': description: Response @@ -35202,7 +37756,7 @@ paths: - closed - all default: open - - *246 + - *245 - name: type description: Can be the name of an issue type. in: query @@ -35233,7 +37787,7 @@ paths: type: array items: *85 examples: - default: *247 + default: *246 headers: Link: *67 '404': *6 @@ -35398,9 +37952,9 @@ paths: type: integer codespaces: type: array - items: *248 + items: *247 examples: - default: *249 + default: *248 '304': *37 '500': *55 '401': *25 @@ -35427,7 +37981,7 @@ paths: parameters: - *75 - *71 - - &250 + - &249 name: codespace_name in: path required: true @@ -35462,15 +38016,15 @@ paths: parameters: - *75 - *71 - - *250 + - *249 responses: '200': description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: &465 + default: &464 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -35650,7 +38204,7 @@ paths: description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *251 + schema: *250 examples: default: value: @@ -35726,7 +38280,7 @@ paths: description: Response content: application/json: - schema: &252 + schema: &251 title: Org Membership description: Org Membership type: object @@ -35793,7 +38347,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &253 + response-if-user-has-an-active-admin-membership-with-organization: &252 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -35894,9 +38448,9 @@ paths: description: Response content: application/json: - schema: *252 + schema: *251 examples: - response-if-user-already-had-membership-with-organization: *253 + response-if-user-already-had-membership-with-organization: *252 '422': *15 '403': *29 x-github: @@ -35973,7 +38527,7 @@ paths: application/json: schema: type: array - items: &254 + items: &253 title: Migration description: A migration. type: object @@ -36313,7 +38867,7 @@ paths: description: Response content: application/json: - schema: *254 + schema: *253 examples: default: value: @@ -36492,7 +39046,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - *75 - - &255 + - &254 name: migration_id description: The unique identifier of the migration. in: path @@ -36519,7 +39073,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *254 + schema: *253 examples: default: value: @@ -36689,7 +39243,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - *75 - - *255 + - *254 responses: '302': description: Response @@ -36711,7 +39265,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *75 - - *255 + - *254 responses: '204': description: Response @@ -36735,8 +39289,8 @@ paths: url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - *75 - - *255 - - &695 + - *254 + - &694 name: repo_name description: repo_name parameter in: path @@ -36764,7 +39318,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *75 - - *255 + - *254 - *17 - *19 responses: @@ -36774,9 +39328,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: &267 + default: &266 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -36923,7 +39477,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: @@ -36949,7 +39503,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &257 + items: &256 title: Organization Role description: Organization roles type: object @@ -37124,7 +39678,7 @@ paths: parameters: - *75 - *77 - - &256 + - &255 name: role_id description: The unique identifier of the role. in: path @@ -37161,7 +39715,7 @@ paths: parameters: - *75 - *77 - - *256 + - *255 responses: '204': description: Response @@ -37214,7 +39768,7 @@ paths: parameters: - *75 - *71 - - *256 + - *255 responses: '204': description: Response @@ -37246,7 +39800,7 @@ paths: parameters: - *75 - *71 - - *256 + - *255 responses: '204': description: Response @@ -37264,7 +39818,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: @@ -37275,13 +39829,13 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - *75 - - *256 + - *255 responses: '200': description: Response content: application/json: - schema: *257 + schema: *256 examples: default: value: @@ -37332,7 +39886,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - *75 - - *256 + - *255 - *17 - *19 responses: @@ -37410,8 +39964,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *258 - required: *259 + properties: *257 + required: *258 nullable: true type: description: The ownership type of the team @@ -37443,7 +39997,7 @@ paths: - type - parent examples: - default: *260 + default: *259 headers: Link: *67 '404': @@ -37473,7 +40027,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - *75 - - *256 + - *255 - *17 - *19 responses: @@ -37501,13 +40055,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &333 + items: &332 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *258 - required: *259 + properties: *257 + required: *258 name: nullable: true type: string @@ -37795,7 +40349,7 @@ paths: - nuget - container - *75 - - &696 + - &695 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -37831,12 +40385,12 @@ paths: application/json: schema: type: array - items: *261 + items: *260 examples: - default: *262 + default: *261 '403': *29 '401': *25 - '400': &698 + '400': &697 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -37858,7 +40412,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &263 + - &262 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 @@ -37876,7 +40430,7 @@ paths: - docker - nuget - container - - &264 + - &263 name: package_name description: The name of the package. in: path @@ -37889,7 +40443,7 @@ paths: description: Response content: application/json: - schema: *261 + schema: *260 examples: default: value: @@ -37941,8 +40495,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: + - *262 - *263 - - *264 - *75 responses: '204': @@ -37975,8 +40529,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: + - *262 - *263 - - *264 - *75 - name: token description: package token @@ -38009,8 +40563,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: + - *262 - *263 - - *264 - *75 - *19 - *17 @@ -38031,7 +40585,7 @@ paths: application/json: schema: type: array - items: &265 + items: &264 title: Package Version description: A version of a software package type: object @@ -38156,10 +40710,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: + - *262 - *263 - - *264 - *75 - - &266 + - &265 name: package_version_id description: Unique identifier of the package version. in: path @@ -38171,7 +40725,7 @@ paths: description: Response content: application/json: - schema: *265 + schema: *264 examples: default: value: @@ -38207,10 +40761,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: + - *262 - *263 - - *264 - *75 - - *266 + - *265 responses: '204': description: Response @@ -38242,10 +40796,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: + - *262 - *263 - - *264 - *75 - - *266 + - *265 responses: '204': description: Response @@ -38275,7 +40829,7 @@ paths: - *75 - *17 - *19 - - &268 + - &267 name: sort description: The property by which to sort the results. in: query @@ -38286,7 +40840,7 @@ paths: - created_at default: created_at - *61 - - &269 + - &268 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -38297,7 +40851,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &270 + - &269 name: repository description: The name of the repository to use to filter the results. in: query @@ -38305,7 +40859,7 @@ paths: schema: type: string example: Hello-World - - &271 + - &270 name: permission description: The permission to use to filter the results. in: query @@ -38313,7 +40867,7 @@ paths: schema: type: string example: issues_read - - &272 + - &271 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) @@ -38323,7 +40877,7 @@ paths: schema: type: string format: date-time - - &273 + - &272 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) @@ -38333,7 +40887,7 @@ paths: schema: type: string format: date-time - - &274 + - &273 name: token_id description: The ID of the token in: query @@ -38603,7 +41157,7 @@ paths: '422': *15 '404': *6 '403': *29 - '204': *192 + '204': *191 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38644,9 +41198,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *267 + default: *266 headers: Link: *67 x-github: @@ -38672,14 +41226,14 @@ paths: - *75 - *17 - *19 - - *268 + - *267 - *61 + - *268 - *269 - *270 - *271 - *272 - *273 - - *274 responses: '500': *55 '422': *15 @@ -38918,7 +41472,7 @@ paths: responses: '500': *55 '404': *6 - '204': *192 + '204': *191 '403': *29 '422': *15 x-github: @@ -38959,9 +41513,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *267 + default: *266 headers: Link: *67 x-github: @@ -39003,7 +41557,7 @@ paths: type: integer configurations: type: array - items: &275 + items: &274 title: Organization private registry description: Private registry configuration for an organization type: object @@ -39431,7 +41985,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &276 + org-private-registry-with-selected-visibility: &275 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -39521,15 +42075,15 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - *75 - - *169 + - *168 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *275 + schema: *274 examples: - default: *276 + default: *275 '404': *6 x-github: githubCloudOnly: false @@ -39552,7 +42106,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - *75 - - *169 + - *168 requestBody: required: true content: @@ -39716,7 +42270,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - *75 - - *169 + - *168 responses: '204': description: Response @@ -39756,7 +42310,7 @@ paths: application/json: schema: type: array - items: &277 + items: &276 title: Projects v2 Project description: A projects v2 project type: object @@ -39826,7 +42380,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &787 + properties: &786 id: type: number description: The unique identifier of the status update. @@ -39874,7 +42428,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &788 + required: &787 - id - node_id - created_at @@ -39899,7 +42453,7 @@ paths: - deleted_at - deleted_by examples: - default: &278 + default: &277 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -40002,7 +42556,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &279 + - &278 name: project_number description: The project's number. in: path @@ -40015,9 +42569,9 @@ paths: description: Response content: application/json: - schema: *277 + schema: *276 examples: - default: *278 + default: *277 headers: Link: *67 '304': *37 @@ -40040,7 +42594,7 @@ paths: url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - *75 - - *279 + - *278 requestBody: required: true description: Details of the draft item to create in the project. @@ -40074,7 +42628,7 @@ paths: description: Response content: application/json: - schema: &285 + schema: &284 title: Projects v2 Item description: An item belonging to a project type: object @@ -40088,7 +42642,7 @@ paths: content: oneOf: - *85 - - &482 + - &481 title: Pull Request Simple description: Pull Request Simple type: object @@ -40194,8 +42748,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *280 - required: *281 + properties: *279 + required: *280 nullable: true active_lock_reason: type: string @@ -40238,7 +42792,7 @@ paths: items: *4 requested_teams: type: array - items: *198 + items: *197 head: type: object properties: @@ -40288,7 +42842,7 @@ paths: _links: type: object properties: - comments: &282 + comments: &281 title: Link description: Hypermedia Link type: object @@ -40297,13 +42851,13 @@ paths: type: string required: - href - commits: *282 - statuses: *282 - html: *282 - issue: *282 - review_comments: *282 - review_comment: *282 - self: *282 + commits: *281 + statuses: *281 + html: *281 + issue: *281 + review_comments: *281 + review_comment: *281 + self: *281 required: - comments - commits @@ -40314,7 +42868,7 @@ paths: - review_comment - self author_association: *82 - auto_merge: &592 + auto_merge: &591 title: Auto merge description: The status of auto merging a pull request. type: object @@ -40488,7 +43042,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &284 + content_type: &283 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -40528,7 +43082,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &286 + draft_issue: &285 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -40602,7 +43156,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *279 + - *278 - *75 - *17 - *47 @@ -40614,7 +43168,7 @@ paths: application/json: schema: type: array - items: &283 + items: &282 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -40764,7 +43318,7 @@ paths: - updated_at - project_url examples: - default: &717 + default: &716 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -40894,7 +43448,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project parameters: - - *279 + - *278 - *75 requestBody: required: true @@ -40941,7 +43495,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &718 + items: &717 type: object properties: name: @@ -40978,7 +43532,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &719 + iteration_configuration: &718 type: object description: The configuration for iteration fields. properties: @@ -41028,7 +43582,7 @@ paths: value: name: Due date data_type: date - single_select_field: &720 + single_select_field: &719 summary: Create a single select field value: name: Priority @@ -41055,7 +43609,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &721 + iteration_field: &720 summary: Create an iteration field value: name: Sprint @@ -41079,9 +43633,9 @@ paths: description: Response for adding a field to an organization-owned project. content: application/json: - schema: *283 + schema: *282 examples: - text_field: &722 + text_field: &721 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -41090,7 +43644,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: &723 + number_field: &722 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -41099,7 +43653,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: &724 + date_field: &723 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -41108,7 +43662,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: &725 + single_select_field: &724 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -41142,7 +43696,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &726 + iteration_field: &725 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -41187,8 +43741,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *279 - - &727 + - *278 + - &726 name: field_id description: The unique identifier of the field. in: path @@ -41201,9 +43755,9 @@ paths: description: Response content: application/json: - schema: *283 + schema: *282 examples: - default: &728 + default: &727 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -41259,7 +43813,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *279 + - *278 - *75 - 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) @@ -41292,7 +43846,7 @@ paths: application/json: schema: type: array - items: &287 + items: &286 title: Projects v2 Item description: An item belonging to a project type: object @@ -41308,7 +43862,7 @@ paths: format: uri example: https://api.github.com/users/monalisa/2/projectsV2/3 description: The API URL of the project that contains this item. - content_type: *284 + content_type: *283 content: type: object additionalProperties: true @@ -41351,7 +43905,7 @@ paths: - updated_at - archived_at examples: - default: &288 + default: &287 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -42049,7 +44603,7 @@ paths: url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - *75 - - *279 + - *278 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -42119,22 +44673,22 @@ paths: description: Response content: application/json: - schema: *285 + schema: *284 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *286 + value: *285 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *286 + value: *285 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *286 + value: *285 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *286 + value: *285 '304': *37 '403': *29 '401': *25 @@ -42154,9 +44708,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *279 + - *278 - *75 - - &289 + - &288 name: item_id description: The unique identifier of the project item. in: path @@ -42182,9 +44736,9 @@ paths: description: Response content: application/json: - schema: *287 + schema: *286 examples: - default: *288 + default: *287 headers: Link: *67 '304': *37 @@ -42205,9 +44759,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *279 + - *278 - *75 - - *289 + - *288 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -42277,13 +44831,13 @@ paths: description: Response content: application/json: - schema: *287 + schema: *286 examples: - text_field: *288 - number_field: *288 - date_field: *288 - single_select_field: *288 - iteration_field: *288 + text_field: *287 + number_field: *287 + date_field: *287 + single_select_field: *287 + iteration_field: *287 '401': *25 '403': *29 '404': *6 @@ -42303,9 +44857,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *279 + - *278 - *75 - - *289 + - *288 responses: '204': description: Response @@ -42329,7 +44883,7 @@ paths: url: https://docs.github.com/rest/projects/views#create-a-view-for-an-organization-owned-project parameters: - *75 - - *279 + - *278 requestBody: required: true content: @@ -42400,7 +44954,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &709 + schema: &708 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -42498,7 +45052,7 @@ paths: examples: table_view: summary: Response for creating a table view - value: &290 + value: &289 value: id: 1 number: 1 @@ -42544,10 +45098,10 @@ paths: - 456 board_view: summary: Response for creating a board view with filter - value: *290 + value: *289 roadmap_view: summary: Response for creating a roadmap view - value: *290 + value: *289 '304': *37 '403': *29 '401': *25 @@ -42575,9 +45129,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-project-view parameters: - - *279 + - *278 - *75 - - &729 + - &728 name: view_number description: The number that identifies the project view. in: path @@ -42609,9 +45163,9 @@ paths: application/json: schema: type: array - items: *287 + items: *286 examples: - default: *288 + default: *287 headers: Link: *67 '304': *37 @@ -42644,7 +45198,7 @@ paths: application/json: schema: type: array - items: &291 + items: &290 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -42712,7 +45266,7 @@ paths: - property_name - value_type examples: - default: &292 + default: &291 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -42772,7 +45326,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *291 + items: *290 minItems: 1 maxItems: 100 required: @@ -42802,9 +45356,9 @@ paths: application/json: schema: type: array - items: *291 + items: *290 examples: - default: *292 + default: *291 '403': *29 '404': *6 x-github: @@ -42826,7 +45380,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - *75 - - &293 + - &292 name: custom_property_name description: The custom property name in: path @@ -42838,9 +45392,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *290 examples: - default: &294 + default: &293 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -42875,7 +45429,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - *75 - - *293 + - *292 requestBody: required: true content: @@ -42946,9 +45500,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *290 examples: - default: *294 + default: *293 '403': *29 '404': *6 x-github: @@ -42972,9 +45526,9 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - *75 - - *293 + - *292 responses: - '204': *192 + '204': *191 '403': *29 '404': *6 x-github: @@ -43033,7 +45587,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &295 + items: &294 title: Custom Property Value description: Custom property name and associated value type: object @@ -43120,7 +45674,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *295 + items: *294 required: - repository_names - properties @@ -43310,9 +45864,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *267 + default: *266 headers: Link: *67 x-github: @@ -43514,7 +46068,7 @@ paths: description: Response content: application/json: - schema: &347 + schema: &346 title: Full Repository description: Full Repository type: object @@ -43802,9 +46356,9 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *296 - required: *297 - x-github-breaking-changes: *298 + properties: *295 + required: *296 + x-github-breaking-changes: *297 nullable: true temp_clone_token: type: string @@ -43919,7 +46473,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &487 + properties: &486 url: type: string format: uri @@ -43935,12 +46489,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &488 + required: &487 - url - key - name - html_url - security_and_analysis: *299 + security_and_analysis: *298 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -44035,7 +46589,7 @@ paths: has_downloads: version: '2026-03-10' examples: - default: &349 + default: &348 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -44562,7 +47116,7 @@ paths: - *75 - *17 - *19 - - &614 + - &613 name: targets description: | A comma-separated list of rule targets to filter by. @@ -44580,7 +47134,7 @@ paths: application/json: schema: type: array - items: &326 + items: &325 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -44615,7 +47169,7 @@ paths: source: type: string description: The name of the source - enforcement: &302 + enforcement: &301 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -44628,7 +47182,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &303 + items: &302 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -44698,7 +47252,7 @@ paths: conditions: nullable: true anyOf: - - &300 + - &299 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -44722,7 +47276,7 @@ paths: match. items: type: string - - &304 + - &303 title: Organization ruleset conditions type: object description: |- @@ -44736,7 +47290,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *300 + - *299 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -44770,7 +47324,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *300 + - *299 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -44792,7 +47346,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *300 + - *299 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -44805,7 +47359,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &301 + items: &300 title: Repository ruleset property targeting definition type: object @@ -44838,17 +47392,17 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *301 + items: *300 required: - repository_property rules: type: array - items: &615 + items: &614 title: Repository Rule type: object description: A repository rule. oneOf: - - &305 + - &304 title: creation description: Only allow users with bypass permission to create matching refs. @@ -44860,7 +47414,7 @@ paths: type: string enum: - creation - - &306 + - &305 title: update description: Only allow users with bypass permission to update matching refs. @@ -44881,7 +47435,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &307 + - &306 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -44893,7 +47447,7 @@ paths: type: string enum: - deletion - - &308 + - &307 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -44905,7 +47459,7 @@ paths: type: string enum: - required_linear_history - - &613 + - &612 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -44983,7 +47537,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &309 + - &308 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -45007,7 +47561,7 @@ paths: type: string required: - required_deployment_environments - - &310 + - &309 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -45019,7 +47573,7 @@ paths: type: string enum: - required_signatures - - &311 + - &310 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -45125,7 +47679,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &312 + - &311 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -45173,7 +47727,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &313 + - &312 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -45185,7 +47739,7 @@ paths: type: string enum: - non_fast_forward - - &314 + - &313 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -45222,7 +47776,7 @@ paths: required: - operator - pattern - - &315 + - &314 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -45259,7 +47813,7 @@ paths: required: - operator - pattern - - &316 + - &315 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -45296,7 +47850,7 @@ paths: required: - operator - pattern - - &317 + - &316 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -45333,7 +47887,7 @@ paths: required: - operator - pattern - - &318 + - &317 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -45370,7 +47924,7 @@ paths: required: - operator - pattern - - &319 + - &318 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -45395,7 +47949,7 @@ paths: type: string required: - restricted_file_paths - - &320 + - &319 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -45419,7 +47973,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &321 + - &320 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -45442,7 +47996,7 @@ paths: type: string required: - restricted_file_extensions - - &322 + - &321 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -45467,7 +48021,7 @@ paths: maximum: 100 required: - max_file_size - - &323 + - &322 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -45517,7 +48071,7 @@ paths: - repository_id required: - workflows - - &324 + - &323 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -45578,7 +48132,7 @@ paths: - tool required: - code_scanning_tools - - &325 + - &324 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -45677,20 +48231,21 @@ paths: - push - repository default: branch - enforcement: *302 + enforcement: *301 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *303 - conditions: *304 + items: *302 + conditions: *303 rules: type: array description: An array of rules within the ruleset. - items: &328 + items: &327 title: Repository Rule type: object description: A repository rule. oneOf: + - *304 - *305 - *306 - *307 @@ -45711,7 +48266,6 @@ paths: - *322 - *323 - *324 - - *325 required: - name - enforcement @@ -45749,9 +48303,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *325 examples: - default: &327 + default: &326 value: id: 21 name: super cool ruleset @@ -45807,7 +48361,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *75 - - &616 + - &615 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 @@ -45822,7 +48376,7 @@ paths: in: query schema: type: string - - &617 + - &616 name: time_period description: |- The time period to filter by. @@ -45838,14 +48392,14 @@ paths: - week - month default: day - - &618 + - &617 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 - - &619 + - &618 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -45865,7 +48419,7 @@ paths: description: Response content: application/json: - schema: &620 + schema: &619 title: Rule Suites description: Response type: array @@ -45920,7 +48474,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &621 + default: &620 value: - id: 21 actor_id: 12 @@ -45964,7 +48518,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *75 - - &622 + - &621 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -45980,7 +48534,7 @@ paths: description: Response content: application/json: - schema: &623 + schema: &622 title: Rule Suite description: Response type: object @@ -46079,7 +48633,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &624 + default: &623 value: id: 21 actor_id: 12 @@ -46152,9 +48706,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *325 examples: - default: *327 + default: *326 '404': *6 '500': *55 put: @@ -46198,16 +48752,16 @@ paths: - tag - push - repository - enforcement: *302 + enforcement: *301 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *303 - conditions: *304 + items: *302 + conditions: *303 rules: description: An array of rules within the ruleset. type: array - items: *328 + items: *327 examples: default: value: @@ -46242,9 +48796,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *325 examples: - default: *327 + default: *326 '404': *6 '422': *15 '500': *55 @@ -46302,7 +48856,7 @@ paths: application/json: schema: type: array - items: &329 + items: &328 title: Ruleset version type: object description: The historical version of a ruleset @@ -46326,7 +48880,7 @@ paths: type: string format: date-time examples: - default: &626 + default: &625 value: - version_id: 3 actor: @@ -46379,9 +48933,9 @@ paths: description: Response content: application/json: - schema: &627 + schema: &626 allOf: - - *329 + - *328 - type: object required: - state @@ -46451,7 +49005,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *75 - - &628 + - &627 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -46462,7 +49016,7 @@ paths: enum: - open - resolved - - &629 + - &628 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -46472,7 +49026,7 @@ paths: required: false schema: type: string - - &630 + - &629 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -46481,7 +49035,7 @@ paths: required: false schema: type: string - - &631 + - &630 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -46500,7 +49054,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &632 + - &631 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. @@ -46515,7 +49069,7 @@ paths: - *61 - *19 - *17 - - &633 + - &632 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 @@ -46525,7 +49079,7 @@ paths: required: false schema: type: string - - &634 + - &633 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 @@ -46535,7 +49089,7 @@ paths: required: false schema: type: string - - &635 + - &634 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -46544,7 +49098,7 @@ paths: required: false schema: type: string - - &636 + - &635 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -46553,7 +49107,7 @@ paths: schema: type: boolean default: false - - &637 + - &636 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -46562,7 +49116,7 @@ paths: schema: type: boolean default: false - - &638 + - &637 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -46581,8 +49135,8 @@ paths: items: type: object properties: - number: *179 - created_at: *180 + number: *178 + created_at: *179 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -46590,21 +49144,21 @@ paths: format: date-time readOnly: true nullable: true - url: *182 - html_url: *183 + url: *181 + html_url: *182 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &639 + state: &638 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: &640 + resolution: &639 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -46711,8 +49265,8 @@ paths: pull request. ' - oneOf: &641 - - &643 + oneOf: &640 + - &642 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -46754,6 +49308,12 @@ 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. + example: https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1 required: - path - start_line @@ -46764,7 +49324,7 @@ paths: - blob_url - commit_sha - commit_url - - &644 + - &643 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. @@ -46819,7 +49379,7 @@ paths: - page_url - commit_sha - commit_url - - &645 + - &644 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -46831,9 +49391,15 @@ paths: description: The API URL to get the issue where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &646 + - &645 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -46845,9 +49411,15 @@ paths: description: The API URL to get the issue where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &647 + - &646 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -46859,9 +49431,15 @@ paths: description: The API URL to get the issue comment where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &648 + - &647 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -46875,7 +49453,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &649 + - &648 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -46889,7 +49467,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &650 + - &649 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -46903,7 +49481,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &651 + - &650 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. @@ -46915,9 +49493,15 @@ paths: description: The API URL to get the pull request where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &652 + - &651 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. @@ -46929,9 +49513,15 @@ paths: description: The API URL to get the pull request where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &653 + - &652 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. @@ -46943,9 +49533,15 @@ paths: description: The API URL to get the pull request comment where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &654 + - &653 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. @@ -46957,9 +49553,15 @@ paths: description: The API URL to get the pull request review where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &655 + - &654 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -46971,6 +49573,12 @@ paths: description: The API URL to get the pull request review comment where the secret was detected. example: 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. + example: https://github.com/octocat/Hello-World/pull/2846#discussion_r12 required: - pull_request_review_comment_url nullable: true @@ -47201,7 +49809,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &331 + pattern_config_version: &330 type: string description: The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate @@ -47210,7 +49818,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &330 + items: &329 type: object properties: token_type: @@ -47276,7 +49884,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *330 + items: *329 examples: default: value: @@ -47333,7 +49941,7 @@ paths: schema: type: object properties: - pattern_config_version: *331 + pattern_config_version: *330 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -47359,7 +49967,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *331 + custom_pattern_version: *330 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -47457,7 +50065,7 @@ paths: application/json: schema: type: array - items: &659 + items: &658 description: A repository security advisory. type: object properties: @@ -47677,7 +50285,7 @@ paths: login: type: string description: The username of the user credited. - type: *332 + type: *331 credits_detailed: type: array nullable: true @@ -47687,7 +50295,7 @@ paths: type: object properties: user: *4 - type: *332 + type: *331 state: type: string description: The state of the user's acceptance of the @@ -47711,7 +50319,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *198 + items: *197 private_fork: readOnly: true nullable: true @@ -47780,7 +50388,7 @@ paths: - private_fork version: '2026-03-10' examples: - default: &660 + default: &659 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -48167,7 +50775,7 @@ paths: application/json: schema: type: array - items: *333 + items: *332 examples: default: value: @@ -48385,9 +50993,9 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 examples: - default: *173 + default: *172 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48456,7 +51064,7 @@ paths: url: https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *75 - - *150 + - *149 responses: '204': description: Response @@ -48479,7 +51087,7 @@ paths: url: https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *75 - - *150 + - *149 responses: '204': description: Response @@ -48520,7 +51128,7 @@ paths: type: integer network_configurations: type: array - items: &334 + items: &333 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -48638,6 +51246,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 @@ -48653,9 +51274,9 @@ paths: description: Response content: application/json: - schema: *334 + schema: *333 examples: - default: &335 + default: &334 value: id: 123456789ABCDEF name: My network configuration @@ -48684,7 +51305,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - *75 - - &336 + - &335 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -48696,9 +51317,9 @@ paths: description: Response content: application/json: - schema: *334 + schema: *333 examples: - default: *335 + default: *334 headers: Link: *67 x-github: @@ -48720,7 +51341,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - *75 - - *336 + - *335 requestBody: required: true content: @@ -48748,6 +51369,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: @@ -48760,9 +51394,9 @@ paths: description: Response content: application/json: - schema: *334 + schema: *333 examples: - default: *335 + default: *334 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48782,7 +51416,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - *75 - - *336 + - *335 responses: '204': description: Response @@ -48922,13 +51556,13 @@ paths: application/json: schema: type: array - items: *337 + items: *336 examples: - default: *338 + default: *337 '500': *55 '403': *29 '404': *6 - '422': *339 + '422': *338 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48968,9 +51602,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *260 + default: *259 headers: Link: *67 '403': *29 @@ -49064,7 +51698,7 @@ paths: description: Response content: application/json: - schema: &340 + schema: &339 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -49127,8 +51761,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *258 - required: *259 + properties: *257 + required: *258 nullable: true members_count: type: integer @@ -49391,7 +52025,7 @@ paths: - repos_count - organization examples: - default: &341 + default: &340 value: id: 1 node_id: MDQ6VGVhbTE= @@ -49479,9 +52113,9 @@ paths: description: Response content: application/json: - schema: *340 + schema: *339 examples: - default: *341 + default: *340 '404': *6 x-github: githubCloudOnly: false @@ -49565,16 +52199,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *340 + schema: *339 examples: - default: *341 + default: *340 '201': description: Response content: application/json: - schema: *340 + schema: *339 examples: - default: *341 + default: *340 '404': *6 '422': *15 '403': *29 @@ -49604,7 +52238,7 @@ paths: responses: '204': description: Response - '422': &342 + '422': &341 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -49638,12 +52272,12 @@ paths: application/json: schema: type: array - items: *237 + items: *236 examples: - default: *238 + default: *237 headers: Link: *67 - '422': *342 + '422': *341 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49725,7 +52359,7 @@ paths: description: Response content: application/json: - schema: &343 + schema: &342 title: Team Membership description: Team Membership type: object @@ -49752,7 +52386,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &676 + response-if-user-is-a-team-maintainer: &675 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -49815,9 +52449,9 @@ paths: description: Response content: application/json: - schema: *343 + schema: *342 examples: - response-if-users-membership-with-team-is-now-pending: &677 + response-if-users-membership-with-team-is-now-pending: &676 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -49891,9 +52525,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *267 + default: *266 headers: Link: *67 x-github: @@ -49924,14 +52558,14 @@ paths: parameters: - *75 - *77 + - *343 - *344 - - *345 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &678 + schema: &677 title: Team Repository description: A team's access to a repository. type: object @@ -50581,8 +53215,8 @@ paths: parameters: - *75 - *77 + - *343 - *344 - - *345 requestBody: required: false content: @@ -50629,8 +53263,8 @@ paths: parameters: - *75 - *77 + - *343 - *344 - - *345 responses: '204': description: Response @@ -50665,9 +53299,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - response-if-child-teams-exist: &679 + response-if-child-teams-exist: &678 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -50821,7 +53455,7 @@ paths: resources: type: object properties: - core: &346 + core: &345 title: Rate Limit type: object properties: @@ -50838,21 +53472,21 @@ paths: - remaining - reset - used - graphql: *346 - search: *346 - code_search: *346 - source_import: *346 - integration_manifest: *346 - code_scanning_upload: *346 - actions_runner_registration: *346 - scim: *346 - dependency_snapshots: *346 - dependency_sbom: *346 - code_scanning_autofix: *346 + graphql: *345 + search: *345 + code_search: *345 + source_import: *345 + integration_manifest: *345 + code_scanning_upload: *345 + actions_runner_registration: *345 + scim: *345 + dependency_snapshots: *345 + dependency_sbom: *345 + code_scanning_autofix: *345 required: - core - search - rate: *346 + rate: *345 required: - rate - resources @@ -50965,14 +53599,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: + - *343 - *344 - - *345 responses: '200': description: Response content: application/json: - schema: *347 + schema: *346 examples: default-response: summary: Default response @@ -51477,7 +54111,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *348 + '301': *347 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51495,8 +54129,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: + - *343 - *344 - - *345 requestBody: required: false content: @@ -51787,10 +54421,10 @@ paths: description: Response content: application/json: - schema: *347 + schema: *346 examples: - default: *349 - '307': &350 + default: *348 + '307': &349 description: Temporary Redirect content: application/json: @@ -51819,8 +54453,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: + - *343 - *344 - - *345 responses: '204': description: Response @@ -51842,7 +54476,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *350 + '307': *349 '404': *6 '409': *54 x-github: @@ -51866,11 +54500,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: + - *343 - *344 - - *345 - *17 - *19 - - &383 + - &382 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -51893,7 +54527,7 @@ paths: type: integer artifacts: type: array - items: &351 + items: &350 title: Artifact description: An artifact type: object @@ -51971,7 +54605,7 @@ paths: - expires_at - updated_at examples: - default: &384 + default: &383 value: total_count: 2 artifacts: @@ -52032,9 +54666,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: + - *343 - *344 - - *345 - - &352 + - &351 name: artifact_id description: The unique identifier of the artifact. in: path @@ -52046,7 +54680,7 @@ paths: description: Response content: application/json: - schema: *351 + schema: *350 examples: default: value: @@ -52084,9 +54718,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: + - *343 - *344 - - *345 - - *352 + - *351 responses: '204': description: Response @@ -52110,9 +54744,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: + - *343 - *344 - - *345 - - *352 + - *351 - name: archive_format in: path required: true @@ -52126,7 +54760,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': &544 + '410': &543 description: Gone content: application/json: @@ -52151,14 +54785,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: + - *343 - *344 - - *345 responses: '200': description: Response content: application/json: - schema: &353 + schema: &352 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -52191,13 +54825,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: + - *343 - *344 - - *345 requestBody: required: true content: application/json: - schema: *353 + schema: *352 examples: selected_actions: *42 responses: @@ -52226,14 +54860,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: + - *343 - *344 - - *345 responses: '200': description: Response content: application/json: - schema: &354 + schema: &353 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -52266,13 +54900,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: + - *343 - *344 - - *345 requestBody: required: true content: application/json: - schema: *354 + schema: *353 examples: selected_actions: *44 responses: @@ -52303,14 +54937,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: + - *343 - *344 - - *345 responses: '200': description: Response content: application/json: - schema: *355 + schema: *354 examples: default: value: @@ -52336,11 +54970,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: + - *343 - *344 - - *345 - *17 - *19 - - &356 + - &355 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 @@ -52374,7 +55008,7 @@ paths: description: Response content: application/json: - schema: &357 + schema: &356 title: Repository actions caches description: Repository actions caches type: object @@ -52416,7 +55050,7 @@ paths: - total_count - actions_caches examples: - default: &358 + default: &357 value: total_count: 1 actions_caches: @@ -52448,23 +55082,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: + - *343 - *344 - - *345 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *356 + - *355 responses: '200': description: Response content: application/json: - schema: *357 + schema: *356 examples: - default: *358 + default: *357 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52484,8 +55118,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: + - *343 - *344 - - *345 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -52516,9 +55150,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: + - *343 - *344 - - *345 - - &359 + - &358 name: job_id description: The unique identifier of the job. in: path @@ -52530,7 +55164,7 @@ paths: description: Response content: application/json: - schema: &387 + schema: &386 title: Job description: Information of a job execution in a workflow run type: object @@ -52837,9 +55471,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: + - *343 - *344 - - *345 - - *359 + - *358 responses: '302': description: Response @@ -52867,9 +55501,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: + - *343 - *344 - - *345 - - *359 + - *358 requestBody: required: false content: @@ -52890,7 +55524,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -52914,8 +55548,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: + - *343 - *344 - - *345 responses: '200': description: Status response @@ -52965,8 +55599,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: + - *343 - *344 - - *345 requestBody: required: true content: @@ -53000,7 +55634,7 @@ paths: description: Empty response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -53029,8 +55663,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -53048,7 +55682,7 @@ paths: type: integer secrets: type: array - items: &389 + items: &388 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -53068,7 +55702,7 @@ paths: - created_at - updated_at examples: - default: &390 + default: &389 value: total_count: 2 secrets: @@ -53101,9 +55735,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: + - *343 - *344 - - *345 - - *360 + - *359 - *19 responses: '200': @@ -53120,7 +55754,7 @@ paths: type: integer variables: type: array - items: &393 + items: &392 title: Actions Variable type: object properties: @@ -53150,7 +55784,7 @@ paths: - created_at - updated_at examples: - default: &394 + default: &393 value: total_count: 2 variables: @@ -53183,8 +55817,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: + - *343 - *344 - - *345 responses: '200': description: Response @@ -53193,12 +55827,12 @@ paths: schema: type: object properties: - enabled: &362 + enabled: &361 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *146 - selected_actions_url: *361 - sha_pinning_required: *147 + allowed_actions: *145 + selected_actions_url: *360 + sha_pinning_required: *146 required: - enabled examples: @@ -53226,8 +55860,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: + - *343 - *344 - - *345 responses: '204': description: Response @@ -53238,9 +55872,9 @@ paths: schema: type: object properties: - enabled: *362 - allowed_actions: *146 - sha_pinning_required: *147 + enabled: *361 + allowed_actions: *145 + sha_pinning_required: *146 required: - enabled examples: @@ -53270,14 +55904,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: + - *343 - *344 - - *345 responses: '200': description: Response content: application/json: - schema: &363 + schema: &362 type: object properties: access_level: @@ -53294,7 +55928,7 @@ paths: required: - access_level examples: - default: &364 + default: &363 value: access_level: organization x-github: @@ -53318,15 +55952,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: + - *343 - *344 - - *345 requestBody: required: true content: application/json: - schema: *363 + schema: *362 examples: - default: *364 + default: *363 responses: '204': description: Response @@ -53350,14 +55984,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: + - *343 - *344 - - *345 responses: '200': description: Response content: application/json: - schema: *365 + schema: *364 examples: default: value: @@ -53381,8 +56015,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: + - *343 - *344 - - *345 responses: '204': description: Empty response for successful settings update @@ -53392,7 +56026,7 @@ paths: required: true content: application/json: - schema: *366 + schema: *365 examples: default: summary: Set retention days @@ -53416,16 +56050,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: + - *343 - *344 - - *345 responses: '200': description: Response content: application/json: - schema: *148 + schema: *147 examples: - default: *367 + default: *366 '404': *6 x-github: enabledForGitHubApps: true @@ -53444,8 +56078,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: + - *343 - *344 - - *345 responses: '204': description: Response @@ -53455,7 +56089,7 @@ paths: required: true content: application/json: - schema: *148 + schema: *147 examples: default: summary: Set approval policy to first time contributors @@ -53479,16 +56113,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: + - *343 - *344 - - *345 responses: '200': description: Response content: application/json: - schema: *368 + schema: *367 examples: - default: *149 + default: *148 '403': *29 '404': *6 x-github: @@ -53508,15 +56142,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: + - *343 - *344 - - *345 requestBody: required: true content: application/json: - schema: *369 + schema: *368 examples: - default: *149 + default: *148 responses: '204': description: Empty response for successful settings update @@ -53540,16 +56174,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *343 - *344 - - *345 responses: '200': description: Response content: application/json: - schema: *151 + schema: *150 examples: - default: *152 + default: *151 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53568,8 +56202,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *343 - *344 - - *345 responses: '204': description: Response @@ -53577,9 +56211,9 @@ paths: required: false content: application/json: - schema: *151 + schema: *150 examples: - selected_actions: *152 + selected_actions: *151 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53601,16 +56235,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: + - *343 - *344 - - *345 responses: '200': description: Response content: application/json: - schema: *370 + schema: *369 examples: - default: *156 + default: *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53631,8 +56265,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: + - *343 - *344 - - *345 responses: '204': description: Success response @@ -53643,9 +56277,9 @@ paths: required: true content: application/json: - schema: *371 + schema: *370 examples: - default: *156 + default: *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53672,8 +56306,8 @@ paths: in: query schema: type: string + - *343 - *344 - - *345 - *17 - *19 responses: @@ -53691,9 +56325,9 @@ paths: type: integer runners: type: array - items: *163 + items: *162 examples: - default: *164 + default: *163 headers: Link: *67 x-github: @@ -53717,8 +56351,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: + - *343 - *344 - - *345 responses: '200': description: Response @@ -53726,9 +56360,9 @@ paths: application/json: schema: type: array - items: *372 + items: *371 examples: - default: *373 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53750,8 +56384,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: + - *343 - *344 - - *345 requestBody: required: true content: @@ -53794,7 +56428,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *374 + '201': *373 '404': *6 '422': *7 '409': *54 @@ -53825,16 +56459,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: + - *343 - *344 - - *345 responses: '201': description: Response content: application/json: - schema: *165 + schema: *164 examples: - default: *375 + default: *374 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53862,16 +56496,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: + - *343 - *344 - - *345 responses: '201': description: Response content: application/json: - schema: *165 + schema: *164 examples: - default: *376 + default: *375 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53893,17 +56527,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: + - *343 - *344 - - *345 - - *162 + - *161 responses: '200': description: Response content: application/json: - schema: *163 + schema: *162 examples: - default: *377 + default: *376 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53924,9 +56558,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: + - *343 - *344 - - *345 - - *162 + - *161 responses: '204': description: Response @@ -53952,11 +56586,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: + - *343 - *344 - - *345 - - *162 + - *161 responses: - '200': *167 + '200': *166 '404': *6 x-github: githubCloudOnly: false @@ -53978,9 +56612,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: + - *343 - *344 - - *345 - - *162 + - *161 requestBody: required: true content: @@ -54004,7 +56638,7 @@ paths: - gpu - accelerated responses: - '200': *167 + '200': *166 '404': *6 '422': *7 x-github: @@ -54028,9 +56662,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: + - *343 - *344 - - *345 - - *162 + - *161 requestBody: required: true content: @@ -54055,7 +56689,7 @@ paths: - gpu - accelerated responses: - '200': *167 + '200': *166 '404': *6 '422': *7 x-github: @@ -54079,11 +56713,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: + - *343 - *344 - - *345 - - *162 + - *161 responses: - '200': *378 + '200': *377 '404': *6 x-github: githubCloudOnly: false @@ -54110,12 +56744,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: + - *343 - *344 - - *345 - - *162 - - *379 + - *161 + - *378 responses: - '200': *167 + '200': *166 '404': *6 '422': *7 x-github: @@ -54141,9 +56775,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: + - *343 - *344 - - *345 - - &397 + - &396 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. @@ -54151,7 +56785,7 @@ paths: required: false schema: type: string - - &398 + - &397 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -54159,7 +56793,7 @@ paths: required: false schema: type: string - - &399 + - &398 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -54168,7 +56802,7 @@ paths: required: false schema: type: string - - &400 + - &399 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 @@ -54195,7 +56829,7 @@ paths: - pending - *17 - *19 - - &401 + - &400 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)." @@ -54204,7 +56838,7 @@ paths: schema: type: string format: date-time - - &380 + - &379 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -54213,13 +56847,13 @@ paths: schema: type: boolean default: false - - &402 + - &401 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &403 + - &402 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -54242,7 +56876,7 @@ paths: type: integer workflow_runs: type: array - items: &381 + items: &380 title: Workflow Run description: An invocation of a workflow type: object @@ -54390,7 +57024,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &425 + properties: &424 id: type: string description: SHA for the commit @@ -54441,7 +57075,7 @@ paths: - name - email nullable: true - required: &426 + required: &425 - id - tree_id - message @@ -54449,8 +57083,8 @@ paths: - author - committer nullable: true - repository: *161 - head_repository: *161 + repository: *160 + head_repository: *160 head_repository_id: type: integer example: 5 @@ -54488,7 +57122,7 @@ paths: - workflow_url - pull_requests examples: - default: &404 + default: &403 value: total_count: 1 workflow_runs: @@ -54724,24 +57358,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: + - *343 - *344 - - *345 - - &382 + - &381 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *380 + - *379 responses: '200': description: Response content: application/json: - schema: *381 + schema: *380 examples: - default: &385 + default: &384 value: id: 30433642 name: Build @@ -54982,9 +57616,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: + - *343 - *344 - - *345 - - *382 + - *381 responses: '204': description: Response @@ -55007,9 +57641,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: + - *343 - *344 - - *345 - - *382 + - *381 responses: '200': description: Response @@ -55128,15 +57762,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: + - *343 - *344 - - *345 - - *382 + - *381 responses: '201': description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -55163,12 +57797,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: + - *343 - *344 - - *345 - - *382 + - *381 - *17 - *19 - - *383 + - *382 - *61 responses: '200': @@ -55185,9 +57819,9 @@ paths: type: integer artifacts: type: array - items: *351 + items: *350 examples: - default: *384 + default: *383 headers: Link: *67 x-github: @@ -55211,25 +57845,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: + - *343 - *344 - - *345 - - *382 - - &386 + - *381 + - &385 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *380 + - *379 responses: '200': description: Response content: application/json: - schema: *381 + schema: *380 examples: - default: *385 + default: *384 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55252,10 +57886,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: + - *343 - *344 - - *345 - - *382 - - *386 + - *381 + - *385 - *17 - *19 responses: @@ -55273,9 +57907,9 @@ paths: type: integer jobs: type: array - items: *387 + items: *386 examples: - default: &388 + default: &387 value: total_count: 1 jobs: @@ -55388,10 +58022,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: + - *343 - *344 - - *345 - - *382 - - *386 + - *381 + - *385 responses: '302': description: Response @@ -55419,15 +58053,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: + - *343 - *344 - - *345 - - *382 + - *381 responses: '202': description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -55454,9 +58088,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: + - *343 - *344 - - *345 - - *382 + - *381 requestBody: required: true content: @@ -55523,15 +58157,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: + - *343 - *344 - - *345 - - *382 + - *381 responses: '202': description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -55558,9 +58192,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: + - *343 - *344 - - *345 - - *382 + - *381 - 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 @@ -55590,9 +58224,9 @@ paths: type: integer jobs: type: array - items: *387 + items: *386 examples: - default: *388 + default: *387 headers: Link: *67 x-github: @@ -55617,9 +58251,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: + - *343 - *344 - - *345 - - *382 + - *381 responses: '302': description: Response @@ -55646,9 +58280,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: + - *343 - *344 - - *345 - - *382 + - *381 responses: '204': description: Response @@ -55675,9 +58309,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: + - *343 - *344 - - *345 - - *382 + - *381 responses: '200': description: Response @@ -55737,7 +58371,7 @@ paths: items: type: object properties: - type: &510 + type: &509 type: string description: The type of reviewer. enum: @@ -55747,7 +58381,7 @@ paths: reviewer: anyOf: - *4 - - *198 + - *197 required: - environment - wait_timer @@ -55822,9 +58456,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: + - *343 - *344 - - *345 - - *382 + - *381 requestBody: required: true content: @@ -55871,12 +58505,12 @@ paths: application/json: schema: type: array - items: &505 + items: &504 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &749 + properties: &748 url: type: string format: uri @@ -55961,7 +58595,7 @@ paths: nullable: true properties: *80 required: *81 - required: &750 + required: &749 - id - node_id - sha @@ -55977,7 +58611,7 @@ paths: - created_at - updated_at examples: - default: &506 + default: &505 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -56033,9 +58667,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: + - *343 - *344 - - *345 - - *382 + - *381 requestBody: required: false content: @@ -56056,7 +58690,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -56079,9 +58713,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: + - *343 - *344 - - *345 - - *382 + - *381 requestBody: required: false content: @@ -56102,7 +58736,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -56134,9 +58768,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: + - *343 - *344 - - *345 - - *382 + - *381 responses: '200': description: Response @@ -56273,8 +58907,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -56292,9 +58926,9 @@ paths: type: integer secrets: type: array - items: *389 + items: *388 examples: - default: *390 + default: *389 headers: Link: *67 x-github: @@ -56319,16 +58953,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: + - *343 - *344 - - *345 responses: '200': description: Response content: application/json: - schema: *391 + schema: *390 examples: - default: *392 + default: *391 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56350,17 +58984,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: + - *343 - *344 - - *345 - - *169 + - *168 responses: '200': description: Response content: application/json: - schema: *389 + schema: *388 examples: - default: &523 + default: &522 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -56386,9 +59020,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: + - *343 - *344 - - *345 - - *169 + - *168 requestBody: required: true content: @@ -56419,7 +59053,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -56445,9 +59079,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: + - *343 - *344 - - *345 - - *169 + - *168 responses: '204': description: Response @@ -56472,9 +59106,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: + - *343 - *344 - - *345 - - *360 + - *359 - *19 responses: '200': @@ -56491,9 +59125,9 @@ paths: type: integer variables: type: array - items: *393 + items: *392 examples: - default: *394 + default: *393 headers: Link: *67 x-github: @@ -56516,8 +59150,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -56544,7 +59178,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -56569,17 +59203,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: + - *343 - *344 - - *345 - - *172 + - *171 responses: '200': description: Response content: application/json: - schema: *393 + schema: *392 examples: - default: &524 + default: &523 value: name: USERNAME value: octocat @@ -56605,9 +59239,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: + - *343 - *344 - - *345 - - *172 + - *171 requestBody: required: true content: @@ -56649,9 +59283,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: + - *343 - *344 - - *345 - - *172 + - *171 responses: '204': description: Response @@ -56676,8 +59310,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -56695,7 +59329,7 @@ paths: type: integer workflows: type: array - items: &395 + items: &394 title: Workflow description: A GitHub Actions workflow type: object @@ -56802,9 +59436,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: + - *343 - *344 - - *345 - - &396 + - &395 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -56819,7 +59453,7 @@ paths: description: Response content: application/json: - schema: *395 + schema: *394 examples: default: value: @@ -56852,9 +59486,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: + - *343 - *344 - - *345 - - *396 + - *395 responses: '204': description: Response @@ -56879,9 +59513,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: + - *343 - *344 - - *345 - - *396 + - *395 responses: '204': description: Empty response when `return_run_details` parameter is `false`. @@ -56976,9 +59610,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: + - *343 - *344 - - *345 - - *396 + - *395 responses: '204': description: Response @@ -57005,19 +59639,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: + - *343 - *344 - - *345 + - *395 - *396 - *397 - *398 - *399 - - *400 - *17 - *19 + - *400 + - *379 - *401 - - *380 - *402 - - *403 responses: '200': description: Response @@ -57033,9 +59667,9 @@ paths: type: integer workflow_runs: type: array - items: *381 + items: *380 examples: - default: *404 + default: *403 headers: Link: *67 x-github: @@ -57067,9 +59701,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: + - *343 - *344 - - *345 - - *396 + - *395 responses: '200': description: Response @@ -57130,8 +59764,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: + - *343 - *344 - - *345 - *61 - *17 - *47 @@ -57295,8 +59929,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -57333,8 +59967,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: + - *343 - *344 - - *345 - name: assignee in: path required: true @@ -57370,8 +60004,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -57481,8 +60115,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: + - *343 - *344 - - *345 - *17 - *47 - *48 @@ -57539,7 +60173,7 @@ paths: initiator: type: string examples: - default: *405 + default: *404 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57573,8 +60207,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: + - *343 - *344 - - *345 responses: '200': description: Response @@ -57582,7 +60216,7 @@ paths: application/json: schema: type: array - items: &406 + items: &405 title: Autolink reference description: An autolink reference. type: object @@ -57636,8 +60270,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -57676,9 +60310,9 @@ paths: description: response content: application/json: - schema: *406 + schema: *405 examples: - default: &407 + default: &406 value: id: 1 key_prefix: TICKET- @@ -57709,9 +60343,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: + - *343 - *344 - - *345 - - &408 + - &407 name: autolink_id description: The unique identifier of the autolink. in: path @@ -57723,9 +60357,9 @@ paths: description: Response content: application/json: - schema: *406 + schema: *405 examples: - default: *407 + default: *406 '404': *6 x-github: githubCloudOnly: false @@ -57745,9 +60379,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: + - *343 - *344 - - *345 - - *408 + - *407 responses: '204': description: Response @@ -57771,8 +60405,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: + - *343 - *344 - - *345 responses: '200': description: Response if Dependabot is enabled @@ -57820,8 +60454,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: + - *343 - *344 - - *345 responses: '204': description: Response @@ -57842,8 +60476,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: + - *343 - *344 - - *345 responses: '204': description: Response @@ -57863,8 +60497,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: + - *343 - *344 - - *345 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -57902,7 +60536,7 @@ paths: - url protected: type: boolean - protection: &410 + protection: &409 title: Branch Protection description: Branch Protection type: object @@ -57944,7 +60578,7 @@ paths: required: - contexts - checks - enforce_admins: &413 + enforce_admins: &412 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -57959,7 +60593,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &415 + required_pull_request_reviews: &414 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -57980,7 +60614,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *198 + items: *197 apps: description: The list of apps with review dismissal access. @@ -58009,7 +60643,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *198 + items: *197 apps: description: The list of apps allowed to bypass pull request requirements. @@ -58035,7 +60669,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &412 + restrictions: &411 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -58098,7 +60732,7 @@ paths: type: string teams: type: array - items: *198 + items: *197 apps: type: array items: @@ -58312,9 +60946,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: + - *343 - *344 - - *345 - - &411 + - &410 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). @@ -58328,14 +60962,14 @@ paths: description: Response content: application/json: - schema: &421 + schema: &420 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &478 + commit: &477 title: Commit description: Commit type: object @@ -58369,7 +61003,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &409 + properties: &408 name: type: string example: '"Chris Wanstrath"' @@ -58385,7 +61019,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *409 + properties: *408 nullable: true message: type: string @@ -58406,7 +61040,7 @@ paths: required: - sha - url - verification: &530 + verification: &529 title: Verification type: object properties: @@ -58440,12 +61074,12 @@ paths: nullable: true oneOf: - *4 - - *170 + - *169 committer: nullable: true oneOf: - *4 - - *170 + - *169 parents: type: array items: @@ -58476,7 +61110,7 @@ paths: type: integer files: type: array - items: &491 + items: &490 title: Diff Entry description: Diff Entry type: object @@ -58560,7 +61194,7 @@ paths: - self protected: type: boolean - protection: *410 + protection: *409 protection_url: type: string format: uri @@ -58667,7 +61301,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *348 + '301': *347 '404': *6 x-github: githubCloudOnly: false @@ -58689,15 +61323,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: + - *343 - *344 - - *345 - - *411 + - *410 responses: '200': description: Response content: application/json: - schema: *410 + schema: *409 examples: default: value: @@ -58891,9 +61525,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: + - *343 - *344 - - *345 - - *411 + - *410 requestBody: required: true content: @@ -59148,7 +61782,7 @@ paths: url: type: string format: uri - required_status_checks: &418 + required_status_checks: &417 title: Status Check Policy description: Status Check Policy type: object @@ -59224,7 +61858,7 @@ paths: items: *4 teams: type: array - items: *198 + items: *197 apps: type: array items: *5 @@ -59242,7 +61876,7 @@ paths: items: *4 teams: type: array - items: *198 + items: *197 apps: type: array items: *5 @@ -59300,7 +61934,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *412 + restrictions: *411 required_conversation_resolution: type: object properties: @@ -59412,9 +62046,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: + - *343 - *344 - - *345 - - *411 + - *410 responses: '204': description: Response @@ -59439,17 +62073,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: + - *343 - *344 - - *345 - - *411 + - *410 responses: '200': description: Response content: application/json: - schema: *413 + schema: *412 examples: - default: &414 + default: &413 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -59471,17 +62105,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: + - *343 - *344 - - *345 - - *411 + - *410 responses: '200': description: Response content: application/json: - schema: *413 + schema: *412 examples: - default: *414 + default: *413 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59500,9 +62134,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: + - *343 - *344 - - *345 - - *411 + - *410 responses: '204': description: Response @@ -59527,17 +62161,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: + - *343 - *344 - - *345 - - *411 + - *410 responses: '200': description: Response content: application/json: - schema: *415 + schema: *414 examples: - default: &416 + default: &415 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -59633,9 +62267,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: + - *343 - *344 - - *345 - - *411 + - *410 requestBody: required: false content: @@ -59733,9 +62367,9 @@ paths: description: Response content: application/json: - schema: *415 + schema: *414 examples: - default: *416 + default: *415 '422': *15 x-github: githubCloudOnly: false @@ -59756,9 +62390,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: + - *343 - *344 - - *345 - - *411 + - *410 responses: '204': description: Response @@ -59785,17 +62419,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: + - *343 - *344 - - *345 - - *411 + - *410 responses: '200': description: Response content: application/json: - schema: *413 + schema: *412 examples: - default: &417 + default: &416 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -59818,17 +62452,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: + - *343 - *344 - - *345 - - *411 + - *410 responses: '200': description: Response content: application/json: - schema: *413 + schema: *412 examples: - default: *417 + default: *416 '404': *6 x-github: githubCloudOnly: false @@ -59848,9 +62482,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: + - *343 - *344 - - *345 - - *411 + - *410 responses: '204': description: Response @@ -59875,17 +62509,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: + - *343 - *344 - - *345 - - *411 + - *410 responses: '200': description: Response content: application/json: - schema: *418 + schema: *417 examples: - default: &419 + default: &418 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -59911,9 +62545,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: + - *343 - *344 - - *345 - - *411 + - *410 requestBody: required: false content: @@ -59965,9 +62599,9 @@ paths: description: Response content: application/json: - schema: *418 + schema: *417 examples: - default: *419 + default: *418 '404': *6 '422': *15 x-github: @@ -59989,9 +62623,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: + - *343 - *344 - - *345 - - *411 + - *410 responses: '204': description: Response @@ -60015,9 +62649,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: + - *343 - *344 - - *345 - - *411 + - *410 responses: '200': description: Response @@ -60051,9 +62685,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: + - *343 - *344 - - *345 - - *411 + - *410 requestBody: required: false content: @@ -60120,9 +62754,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: + - *343 - *344 - - *345 - - *411 + - *410 requestBody: required: false content: @@ -60186,9 +62820,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: + - *343 - *344 - - *345 - - *411 + - *410 requestBody: content: application/json: @@ -60254,15 +62888,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: + - *343 - *344 - - *345 - - *411 + - *410 responses: '200': description: Response content: application/json: - schema: *412 + schema: *411 examples: default: value: @@ -60353,9 +62987,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: + - *343 - *344 - - *345 - - *411 + - *410 responses: '204': description: Response @@ -60378,9 +63012,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: + - *343 - *344 - - *345 - - *411 + - *410 responses: '200': description: Response @@ -60390,7 +63024,7 @@ paths: type: array items: *5 examples: - default: &420 + default: &419 value: - id: 1 slug: octoapp @@ -60447,9 +63081,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: + - *343 - *344 - - *345 - - *411 + - *410 requestBody: required: true content: @@ -60483,7 +63117,7 @@ paths: type: array items: *5 examples: - default: *420 + default: *419 '422': *15 x-github: githubCloudOnly: false @@ -60504,9 +63138,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: + - *343 - *344 - - *345 - - *411 + - *410 requestBody: required: true content: @@ -60540,7 +63174,7 @@ paths: type: array items: *5 examples: - default: *420 + default: *419 '422': *15 x-github: githubCloudOnly: false @@ -60561,9 +63195,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: + - *343 - *344 - - *345 - - *411 + - *410 requestBody: required: true content: @@ -60597,7 +63231,7 @@ paths: type: array items: *5 examples: - default: *420 + default: *419 '422': *15 x-github: githubCloudOnly: false @@ -60619,9 +63253,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: + - *343 - *344 - - *345 - - *411 + - *410 responses: '200': description: Response @@ -60629,9 +63263,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *260 + default: *259 '404': *6 x-github: githubCloudOnly: false @@ -60651,9 +63285,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: + - *343 - *344 - - *345 - - *411 + - *410 requestBody: required: false content: @@ -60689,9 +63323,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *260 + default: *259 '422': *15 x-github: githubCloudOnly: false @@ -60712,9 +63346,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: + - *343 - *344 - - *345 - - *411 + - *410 requestBody: required: false content: @@ -60750,9 +63384,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *260 + default: *259 '422': *15 x-github: githubCloudOnly: false @@ -60773,9 +63407,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: + - *343 - *344 - - *345 - - *411 + - *410 requestBody: content: application/json: @@ -60810,9 +63444,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *260 + default: *259 '422': *15 x-github: githubCloudOnly: false @@ -60834,9 +63468,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: + - *343 - *344 - - *345 - - *411 + - *410 responses: '200': description: Response @@ -60870,9 +63504,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: + - *343 - *344 - - *345 - - *411 + - *410 requestBody: required: true content: @@ -60930,9 +63564,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: + - *343 - *344 - - *345 - - *411 + - *410 requestBody: required: true content: @@ -60990,9 +63624,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: + - *343 - *344 - - *345 - - *411 + - *410 requestBody: required: true content: @@ -61052,9 +63686,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: + - *343 - *344 - - *345 - - *411 + - *410 requestBody: required: true content: @@ -61076,7 +63710,7 @@ paths: description: Response content: application/json: - schema: *421 + schema: *420 examples: default: value: @@ -61192,8 +63826,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -61472,7 +64106,7 @@ paths: description: Response content: application/json: - schema: &422 + schema: &421 title: CheckRun description: A check performed on the code of a given code change type: object @@ -61592,7 +64226,7 @@ paths: check. type: array items: *90 - deployment: &742 + deployment: &741 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -61872,9 +64506,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: + - *343 - *344 - - *345 - - &423 + - &422 name: check_run_id description: The unique identifier of the check run. in: path @@ -61886,9 +64520,9 @@ paths: description: Response content: application/json: - schema: *422 + schema: *421 examples: - default: &424 + default: &423 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -61988,9 +64622,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: + - *343 - *344 - - *345 - - *423 + - *422 requestBody: required: true content: @@ -62230,9 +64864,9 @@ paths: description: Response content: application/json: - schema: *422 + schema: *421 examples: - default: *424 + default: *423 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62252,9 +64886,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: + - *343 - *344 - - *345 - - *423 + - *422 - *17 - *19 responses: @@ -62349,15 +64983,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: + - *343 - *344 - - *345 - - *423 + - *422 responses: '201': description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -62395,8 +65029,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -62418,7 +65052,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &427 + schema: &426 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -62495,7 +65129,7 @@ paths: nullable: true properties: *80 required: *81 - repository: *161 + repository: *160 created_at: type: string format: date-time @@ -62504,12 +65138,12 @@ paths: type: string format: date-time nullable: true - head_commit: &770 + head_commit: &769 title: Simple Commit description: A commit. type: object - properties: *425 - required: *426 + properties: *424 + required: *425 latest_check_runs_count: type: integer check_runs_url: @@ -62537,7 +65171,7 @@ paths: - check_runs_url - pull_requests examples: - default: &428 + default: &427 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -62828,9 +65462,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *427 + schema: *426 examples: - default: *428 + default: *427 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62849,8 +65483,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -62911,7 +65545,7 @@ paths: required: - app_id - setting - repository: *161 + repository: *160 examples: default: value: @@ -63159,9 +65793,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: + - *343 - *344 - - *345 - - &429 + - &428 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -63173,9 +65807,9 @@ paths: description: Response content: application/json: - schema: *427 + schema: *426 examples: - default: *428 + default: *427 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63198,17 +65832,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: + - *343 - *344 - - *345 - - *429 - - &484 + - *428 + - &483 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &485 + - &484 name: status description: Returns check runs with the specified `status`. in: query @@ -63247,9 +65881,9 @@ paths: type: integer check_runs: type: array - items: *422 + items: *421 examples: - default: &486 + default: &485 value: total_count: 1 check_runs: @@ -63351,15 +65985,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: + - *343 - *344 - - *345 - - *429 + - *428 responses: '201': description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -63386,21 +66020,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: + - *343 - *344 - - *345 + - *429 - *430 - - *431 - *19 - *17 - - &448 + - &447 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: *432 - - &449 + schema: *431 + - &448 name: pr description: The number of the pull request for the results you want to list. in: query @@ -63425,13 +66059,13 @@ paths: be returned. in: query required: false - schema: *433 + schema: *432 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *434 + schema: *433 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -63450,14 +66084,14 @@ paths: items: type: object properties: - number: *179 - created_at: *180 - updated_at: *181 - url: *182 - html_url: *183 - instances_url: *435 - state: *188 - fixed_at: *184 + number: *178 + created_at: *179 + updated_at: *180 + url: *181 + html_url: *182 + instances_url: *434 + state: *187 + fixed_at: *183 dismissed_by: title: Simple User description: A GitHub user. @@ -63465,12 +66099,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *185 - dismissed_reason: *436 - dismissed_comment: *437 - rule: *438 - tool: *439 - most_recent_instance: *440 + dismissed_at: *184 + dismissed_reason: *435 + dismissed_comment: *436 + rule: *437 + tool: *438 + most_recent_instance: *439 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -63596,7 +66230,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &441 + '403': &440 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -63623,9 +66257,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: + - *343 - *344 - - *345 - - &442 + - &441 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -63633,23 +66267,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *179 + schema: *178 responses: '200': description: Response content: application/json: - schema: &443 + schema: &442 type: object properties: - number: *179 - created_at: *180 - updated_at: *181 - url: *182 - html_url: *183 - instances_url: *435 - state: *188 - fixed_at: *184 + number: *178 + created_at: *179 + updated_at: *180 + url: *181 + html_url: *182 + instances_url: *434 + state: *187 + fixed_at: *183 dismissed_by: title: Simple User description: A GitHub user. @@ -63657,9 +66291,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *185 - dismissed_reason: *436 - dismissed_comment: *437 + dismissed_at: *184 + dismissed_reason: *435 + dismissed_comment: *436 rule: type: object properties: @@ -63713,8 +66347,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *439 - most_recent_instance: *440 + tool: *438 + most_recent_instance: *439 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -63813,7 +66447,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *441 + '403': *440 '404': *6 '503': *121 x-github: @@ -63833,9 +66467,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: + - *343 - *344 - - *345 - - *442 + - *441 requestBody: required: true content: @@ -63850,8 +66484,8 @@ paths: enum: - open - dismissed - dismissed_reason: *436 - dismissed_comment: *437 + dismissed_reason: *435 + dismissed_comment: *436 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -63879,7 +66513,7 @@ paths: description: Response content: application/json: - schema: *443 + schema: *442 examples: default: value: @@ -63955,7 +66589,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &447 + '403': &446 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -63982,15 +66616,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: + - *343 - *344 - - *345 - - *442 + - *441 responses: '200': description: Response content: application/json: - schema: &444 + schema: &443 type: object properties: status: @@ -64016,13 +66650,13 @@ paths: - description - started_at examples: - default: &445 + default: &444 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &446 + '400': &445 description: Bad Request content: application/json: @@ -64033,7 +66667,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': *441 + '403': *440 '404': *6 '503': *121 x-github: @@ -64058,29 +66692,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: + - *343 - *344 - - *345 - - *442 + - *441 responses: '200': description: OK content: application/json: - schema: *444 + schema: *443 examples: - default: *445 + default: *444 '202': description: Accepted content: application/json: - schema: *444 + schema: *443 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *446 + '400': *445 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -64112,9 +66746,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: + - *343 - *344 - - *345 - - *442 + - *441 requestBody: required: false content: @@ -64159,8 +66793,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *446 - '403': *447 + '400': *445 + '403': *446 '404': *6 '422': description: Unprocessable Entity @@ -64184,13 +66818,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: + - *343 - *344 - - *345 - - *442 + - *441 - *19 - *17 + - *447 - *448 - - *449 responses: '200': description: Response @@ -64201,10 +66835,10 @@ paths: items: type: object properties: - ref: *432 - analysis_key: *450 - environment: *451 - category: *452 + ref: *431 + analysis_key: *449 + environment: *450 + category: *451 state: type: string description: State of a code scanning alert instance. @@ -64219,7 +66853,7 @@ paths: properties: text: type: string - location: *453 + location: *452 html_url: type: string classifications: @@ -64227,7 +66861,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: *454 + items: *453 examples: default: value: @@ -64264,7 +66898,7 @@ paths: end_column: 50 classifications: - source - '403': *441 + '403': *440 '404': *6 '503': *121 x-github: @@ -64298,25 +66932,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: + - *343 - *344 - - *345 + - *429 - *430 - - *431 - *19 - *17 - - *449 + - *448 - 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: *432 + schema: *431 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &455 + schema: &454 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -64337,23 +66971,23 @@ paths: application/json: schema: type: array - items: &456 + items: &455 type: object properties: - ref: *432 - commit_sha: &464 + ref: *431 + commit_sha: &463 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: *450 + analysis_key: *449 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *452 + category: *451 error: type: string example: error reading field xyz @@ -64377,8 +67011,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *455 - tool: *439 + sarif_id: *454 + tool: *438 deletable: type: boolean warning: @@ -64439,7 +67073,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *441 + '403': *440 '404': *6 '503': *121 x-github: @@ -64475,8 +67109,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: + - *343 - *344 - - *345 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -64489,7 +67123,7 @@ paths: description: Response content: application/json: - schema: *456 + schema: *455 examples: response: summary: application/json response @@ -64543,7 +67177,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *441 + '403': *440 '404': *6 '422': description: Response if analysis could not be processed @@ -64630,8 +67264,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: + - *343 - *344 - - *345 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -64684,7 +67318,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': *447 + '403': *446 '404': *6 '503': *121 x-github: @@ -64706,8 +67340,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: + - *343 - *344 - - *345 responses: '200': description: Response @@ -64715,7 +67349,7 @@ paths: application/json: schema: type: array - items: &457 + items: &456 title: CodeQL Database description: A CodeQL database. type: object @@ -64826,7 +67460,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': *441 + '403': *440 '404': *6 '503': *121 x-github: @@ -64855,8 +67489,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: + - *343 - *344 - - *345 - name: language in: path description: The language of the CodeQL database. @@ -64868,7 +67502,7 @@ paths: description: Response content: application/json: - schema: *457 + schema: *456 examples: default: value: @@ -64900,9 +67534,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': &493 + '302': &492 description: Found - '403': *441 + '403': *440 '404': *6 '503': *121 x-github: @@ -64924,8 +67558,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: + - *343 - *344 - - *345 - name: language in: path description: The language of the CodeQL database. @@ -64935,7 +67569,7 @@ paths: responses: '204': description: Response - '403': *447 + '403': *446 '404': *6 '503': *121 x-github: @@ -64963,8 +67597,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -64973,7 +67607,7 @@ paths: type: object additionalProperties: false properties: - language: &458 + language: &457 type: string description: The language targeted by the CodeQL query enum: @@ -65053,7 +67687,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &462 + schema: &461 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -65063,7 +67697,7 @@ paths: description: The ID of the variant analysis. controller_repo: *66 actor: *4 - query_language: *458 + query_language: *457 query_pack_url: type: string description: The download url for the query pack. @@ -65110,7 +67744,7 @@ paths: items: type: object properties: - repository: &459 + repository: &458 title: Repository Identifier description: Repository Identifier type: object @@ -65146,7 +67780,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &463 + analysis_status: &462 type: string description: The new status of the CodeQL variant analysis repository task. @@ -65178,7 +67812,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &460 + access_mismatch_repos: &459 type: object properties: repository_count: @@ -65192,7 +67826,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: *459 + items: *458 required: - repository_count - repositories @@ -65214,8 +67848,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *460 - over_limit_repos: *460 + no_codeql_db_repos: *459 + over_limit_repos: *459 required: - access_mismatch_repos - not_found_repos @@ -65231,7 +67865,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &461 + value: &460 summary: Default response value: id: 1 @@ -65377,10 +68011,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *461 + value: *460 repository_lists: summary: Response for a successful variant analysis submission - value: *461 + value: *460 '404': *6 '422': description: Unable to process variant analysis submission @@ -65408,8 +68042,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: + - *343 - *344 - - *345 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -65421,9 +68055,9 @@ paths: description: Response content: application/json: - schema: *462 + schema: *461 examples: - default: *461 + default: *460 '404': *6 '503': *121 x-github: @@ -65446,7 +68080,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: - - *344 + - *343 - name: repo in: path description: The name of the controller repository. @@ -65481,7 +68115,7 @@ paths: type: object properties: repository: *66 - analysis_status: *463 + analysis_status: *462 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -65606,8 +68240,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: + - *343 - *344 - - *345 responses: '200': description: Response @@ -65709,7 +68343,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *441 + '403': *440 '404': *6 '503': *121 x-github: @@ -65730,8 +68364,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -65798,7 +68432,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -65823,7 +68457,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *447 + '403': *446 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -65894,8 +68528,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -65903,7 +68537,7 @@ paths: schema: type: object properties: - commit_sha: *464 + commit_sha: *463 ref: type: string description: |- @@ -65961,7 +68595,7 @@ paths: schema: type: object properties: - id: *455 + id: *454 url: type: string description: The REST API URL for checking the status of the upload. @@ -65975,7 +68609,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': *447 + '403': *446 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -65998,8 +68632,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: + - *343 - *344 - - *345 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -66045,7 +68679,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': *441 + '403': *440 '404': description: Not Found if the sarif id does not match any upload '503': *121 @@ -66070,8 +68704,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: + - *343 - *344 - - *345 responses: '200': description: Response @@ -66127,7 +68761,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': *192 + '204': *191 '304': *37 '403': *29 '404': *6 @@ -66152,8 +68786,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: + - *343 - *344 - - *345 - 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 @@ -66273,8 +68907,8 @@ paths: parameters: - *17 - *19 + - *343 - *344 - - *345 responses: '200': description: Response @@ -66290,7 +68924,7 @@ paths: type: integer codespaces: type: array - items: *248 + items: *247 examples: default: value: @@ -66588,8 +69222,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -66652,17 +69286,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *248 + schema: *247 examples: - default: *465 + default: *464 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *248 + schema: *247 examples: - default: *465 + default: *464 '400': *14 '401': *25 '403': *29 @@ -66691,8 +69325,8 @@ paths: parameters: - *17 - *19 + - *343 - *344 - - *345 responses: '200': description: Response @@ -66756,8 +69390,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: + - *343 - *344 - - *345 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -66792,14 +69426,14 @@ paths: type: integer machines: type: array - items: &685 + items: &684 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *466 - required: *467 + properties: *465 + required: *466 examples: - default: &686 + default: &685 value: total_count: 2 machines: @@ -66839,8 +69473,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: + - *343 - *344 - - *345 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -66924,8 +69558,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: + - *343 - *344 - - *345 - 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 @@ -66991,8 +69625,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -67010,7 +69644,7 @@ paths: type: integer secrets: type: array - items: &471 + items: &470 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -67030,7 +69664,7 @@ paths: - created_at - updated_at examples: - default: *468 + default: *467 headers: Link: *67 x-github: @@ -67053,16 +69687,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: + - *343 - *344 - - *345 responses: '200': description: Response content: application/json: - schema: *469 + schema: *468 examples: - default: *470 + default: *469 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -67082,17 +69716,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: + - *343 - *344 - - *345 - - *169 + - *168 responses: '200': description: Response content: application/json: - schema: *471 + schema: *470 examples: - default: *472 + default: *471 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67112,9 +69746,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: + - *343 - *344 - - *345 - - *169 + - *168 requestBody: required: true content: @@ -67142,7 +69776,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -67166,9 +69800,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: + - *343 - *344 - - *345 - - *169 + - *168 responses: '204': description: Response @@ -67196,8 +69830,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: + - *343 - *344 - - *345 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -67239,7 +69873,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &473 + properties: &472 login: type: string example: octocat @@ -67332,7 +69966,7 @@ paths: user_view_type: type: string example: public - required: &474 + required: &473 - avatar_url - events_url - followers_url @@ -67406,8 +70040,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: + - *343 - *344 - - *345 - *71 responses: '204': @@ -67454,8 +70088,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: + - *343 - *344 - - *345 - *71 requestBody: required: false @@ -67482,7 +70116,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &543 + schema: &542 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -67493,7 +70127,7 @@ paths: example: 42 type: integer format: int64 - repository: *161 + repository: *160 invitee: title: Simple User description: A GitHub user. @@ -67711,8 +70345,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: + - *343 - *344 - - *345 - *71 responses: '204': @@ -67744,8 +70378,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: + - *343 - *344 - - *345 - *71 responses: '200': @@ -67766,8 +70400,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *473 - required: *474 + properties: *472 + required: *473 nullable: true required: - permission @@ -67822,8 +70456,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -67833,7 +70467,7 @@ paths: application/json: schema: type: array - items: &475 + items: &474 title: Commit Comment description: Commit Comment type: object @@ -67891,7 +70525,7 @@ paths: - created_at - updated_at examples: - default: &480 + default: &479 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -67950,17 +70584,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: + - *343 - *344 - - *345 - *101 responses: '200': description: Response content: application/json: - schema: *475 + schema: *474 examples: - default: &481 + default: &480 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -68017,8 +70651,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: + - *343 - *344 - - *345 - *101 requestBody: required: true @@ -68041,7 +70675,7 @@ paths: description: Response content: application/json: - schema: *475 + schema: *474 examples: default: value: @@ -68092,8 +70726,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: + - *343 - *344 - - *345 - *101 responses: '204': @@ -68115,8 +70749,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: + - *343 - *344 - - *345 - *101 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -68143,7 +70777,7 @@ paths: application/json: schema: type: array - items: &476 + items: &475 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -68186,7 +70820,7 @@ paths: - content - created_at examples: - default: &547 + default: &546 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -68231,8 +70865,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: + - *343 - *344 - - *345 - *101 requestBody: required: true @@ -68265,9 +70899,9 @@ paths: description: Reaction exists content: application/json: - schema: *476 + schema: *475 examples: - default: &477 + default: &476 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -68296,9 +70930,9 @@ paths: description: Reaction created content: application/json: - schema: *476 + schema: *475 examples: - default: *477 + default: *476 '422': *15 x-github: githubCloudOnly: false @@ -68320,10 +70954,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: + - *343 - *344 - - *345 - *101 - - &548 + - &547 name: reaction_id description: The unique identifier of the reaction. in: path @@ -68378,8 +71012,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: + - *343 - *344 - - *345 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -68435,9 +71069,9 @@ paths: application/json: schema: type: array - items: *478 + items: *477 examples: - default: &599 + default: &598 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -68531,9 +71165,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: + - *343 - *344 - - *345 - - &479 + - &478 name: commit_sha description: The SHA of the commit. in: path @@ -68605,9 +71239,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: + - *343 - *344 - - *345 - - *479 + - *478 - *17 - *19 responses: @@ -68617,9 +71251,9 @@ paths: application/json: schema: type: array - items: *475 + items: *474 examples: - default: *480 + default: *479 headers: Link: *67 x-github: @@ -68647,9 +71281,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: + - *343 - *344 - - *345 - - *479 + - *478 requestBody: required: true content: @@ -68684,9 +71318,9 @@ paths: description: Response content: application/json: - schema: *475 + schema: *474 examples: - default: *481 + default: *480 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -68714,9 +71348,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: + - *343 - *344 - - *345 - - *479 + - *478 - *17 - *19 responses: @@ -68726,9 +71360,9 @@ paths: application/json: schema: type: array - items: *482 + items: *481 examples: - default: &591 + default: &590 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -69265,11 +71899,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: + - *343 - *344 - - *345 - *19 - *17 - - &483 + - &482 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)" @@ -69284,9 +71918,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *477 examples: - default: &578 + default: &577 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -69399,11 +72033,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: + - *343 - *344 - - *345 + - *482 - *483 - *484 - - *485 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -69437,9 +72071,9 @@ paths: type: integer check_runs: type: array - items: *422 + items: *421 examples: - default: *486 + default: *485 headers: Link: *67 x-github: @@ -69464,9 +72098,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: + - *343 - *344 - - *345 - - *483 + - *482 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -69474,7 +72108,7 @@ paths: schema: type: integer example: 1 - - *484 + - *483 - *17 - *19 responses: @@ -69492,7 +72126,7 @@ paths: type: integer check_suites: type: array - items: *427 + items: *426 examples: default: value: @@ -69692,9 +72326,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: + - *343 - *344 - - *345 - - *483 + - *482 - *17 - *19 responses: @@ -69761,7 +72395,7 @@ paths: type: string total_count: type: integer - repository: *161 + repository: *160 commit_url: type: string format: uri @@ -69892,9 +72526,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: + - *343 - *344 - - *345 - - *483 + - *482 - *17 - *19 responses: @@ -69904,7 +72538,7 @@ paths: application/json: schema: type: array - items: &664 + items: &663 title: Status description: The status of a commit. type: object @@ -69985,7 +72619,7 @@ paths: site_admin: false headers: Link: *67 - '301': *348 + '301': *347 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70013,8 +72647,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: + - *343 - *344 - - *345 responses: '200': description: Response @@ -70043,20 +72677,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *487 - required: *488 + properties: *486 + required: *487 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &489 + properties: &488 url: type: string format: uri html_url: type: string format: uri - required: &490 + required: &489 - url - html_url nullable: true @@ -70070,26 +72704,26 @@ paths: contributing: title: Community Health File type: object - properties: *489 - required: *490 + properties: *488 + required: *489 nullable: true readme: title: Community Health File type: object - properties: *489 - required: *490 + properties: *488 + required: *489 nullable: true issue_template: title: Community Health File type: object - properties: *489 - required: *490 + properties: *488 + required: *489 nullable: true pull_request_template: title: Community Health File type: object - properties: *489 - required: *490 + properties: *488 + required: *489 nullable: true required: - code_of_conduct @@ -70216,8 +72850,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: + - *343 - *344 - - *345 - *19 - *17 - name: basehead @@ -70260,8 +72894,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *478 - merge_base_commit: *478 + base_commit: *477 + merge_base_commit: *477 status: type: string enum: @@ -70281,10 +72915,10 @@ paths: example: 6 commits: type: array - items: *478 + items: *477 files: type: array - items: *491 + items: *490 required: - url - html_url @@ -70570,8 +73204,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: + - *343 - *344 - - *345 - name: path description: path parameter in: path @@ -70731,7 +73365,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &492 + response-if-content-is-a-file-github-object: &491 summary: Response if content is a file value: type: file @@ -70863,7 +73497,7 @@ paths: - size - type - url - - &604 + - &603 title: Content File description: Content File type: object @@ -71064,7 +73698,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *492 + response-if-content-is-a-file: *491 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -71133,7 +73767,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *493 + '302': *492 '304': *37 x-github: githubCloudOnly: false @@ -71186,8 +73820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: + - *343 - *344 - - *345 - name: path description: path parameter in: path @@ -71280,7 +73914,7 @@ paths: description: Response content: application/json: - schema: &494 + schema: &493 title: File Commit description: File Commit type: object @@ -71432,7 +74066,7 @@ paths: description: Response content: application/json: - schema: *494 + schema: *493 examples: example-for-creating-a-file: value: @@ -71486,7 +74120,7 @@ paths: schema: oneOf: - *3 - - &525 + - &524 description: Repository rule violation was detected type: object properties: @@ -71507,7 +74141,7 @@ paths: items: type: object properties: - placeholder_id: &656 + placeholder_id: &655 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -71539,8 +74173,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: + - *343 - *344 - - *345 - name: path description: path parameter in: path @@ -71601,7 +74235,7 @@ paths: description: Response content: application/json: - schema: *494 + schema: *493 examples: default: value: @@ -71656,8 +74290,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: + - *343 - *344 - - *345 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -71780,23 +74414,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: + - *343 - *344 - - *345 + - *199 - *200 - *201 - *202 - - *203 - 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 + - *203 + - *494 - *204 - - *495 - *205 - *206 - - *207 - *61 - *47 - *48 @@ -71808,11 +74442,11 @@ paths: application/json: schema: type: array - items: &499 + items: &498 type: object description: A Dependabot alert. properties: - number: *179 + number: *178 state: type: string description: The state of the Dependabot alert. @@ -71854,13 +74488,14 @@ paths: - unknown - direct - transitive - security_advisory: *496 + - inconclusive + security_advisory: *495 security_vulnerability: *65 - url: *182 - html_url: *183 - created_at: *180 - updated_at: *181 - dismissed_at: *185 + url: *181 + html_url: *182 + created_at: *179 + updated_at: *180 + dismissed_at: *184 dismissed_by: title: Simple User description: A GitHub user. @@ -71884,9 +74519,9 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *184 - auto_dismissed_at: *497 - dismissal_request: *498 + fixed_at: *183 + auto_dismissed_at: *496 + dismissal_request: *497 assignees: type: array description: The users assigned to this alert. @@ -71958,7 +74593,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 @@ -72141,9 +74776,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: + - *343 - *344 - - *345 - - &500 + - &499 name: alert_number in: path description: |- @@ -72152,13 +74787,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *179 + schema: *178 responses: '200': description: Response content: application/json: - schema: *499 + schema: *498 examples: default: value: @@ -72215,7 +74850,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 @@ -72290,9 +74925,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: + - *343 - *344 - - *345 - - *500 + - *499 requestBody: required: true content: @@ -72348,7 +74983,7 @@ paths: description: Response content: application/json: - schema: *499 + schema: *498 examples: default: value: @@ -72478,8 +75113,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -72497,7 +75132,7 @@ paths: type: integer secrets: type: array - items: &503 + items: &502 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -72550,16 +75185,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: + - *343 - *344 - - *345 responses: '200': description: Response content: application/json: - schema: *501 + schema: *500 examples: - default: *502 + default: *501 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72579,15 +75214,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: + - *343 - *344 - - *345 - - *169 + - *168 responses: '200': description: Response content: application/json: - schema: *503 + schema: *502 examples: default: value: @@ -72613,9 +75248,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: + - *343 - *344 - - *345 - - *169 + - *168 requestBody: required: true content: @@ -72643,7 +75278,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -72667,9 +75302,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: + - *343 - *344 - - *345 - - *169 + - *168 responses: '204': description: Response @@ -72691,8 +75326,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: + - *343 - *344 - - *345 - 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 @@ -72852,8 +75487,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: + - *343 - *344 - - *345 responses: '200': description: Response @@ -73092,8 +75727,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: + - *343 - *344 - - *345 requestBody: required: true content: @@ -73168,7 +75803,7 @@ paths: - version - url additionalProperties: false - metadata: &504 + metadata: &503 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -73201,7 +75836,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *504 + metadata: *503 resolved: type: object description: A collection of resolved package dependencies. @@ -73214,7 +75849,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *504 + metadata: *503 relationship: type: string description: A notation of whether a dependency is requested @@ -73343,8 +75978,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: + - *343 - *344 - - *345 - name: sha description: The SHA recorded at creation time. in: query @@ -73384,9 +76019,9 @@ paths: application/json: schema: type: array - items: *505 + items: *504 examples: - default: *506 + default: *505 headers: Link: *67 x-github: @@ -73452,8 +76087,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -73534,7 +76169,7 @@ paths: description: Response content: application/json: - schema: *505 + schema: *504 examples: simple-example: summary: Simple example @@ -73607,9 +76242,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: + - *343 - *344 - - *345 - - &507 + - &506 name: deployment_id description: deployment_id parameter in: path @@ -73621,7 +76256,7 @@ paths: description: Response content: application/json: - schema: *505 + schema: *504 examples: default: value: @@ -73686,9 +76321,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: + - *343 - *344 - - *345 - - *507 + - *506 responses: '204': description: Response @@ -73710,9 +76345,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: + - *343 - *344 - - *345 - - *507 + - *506 - *17 - *19 responses: @@ -73722,7 +76357,7 @@ paths: application/json: schema: type: array - items: &508 + items: &507 title: Deployment Status description: The status of a deployment. type: object @@ -73883,9 +76518,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: + - *343 - *344 - - *345 - - *507 + - *506 requestBody: required: true content: @@ -73960,9 +76595,9 @@ paths: description: Response content: application/json: - schema: *508 + schema: *507 examples: - default: &509 + default: &508 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -74018,9 +76653,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: + - *343 - *344 - - *345 - - *507 + - *506 - name: status_id in: path required: true @@ -74031,9 +76666,9 @@ paths: description: Response content: application/json: - schema: *508 + schema: *507 examples: - default: *509 + default: *508 '404': *6 x-github: githubCloudOnly: false @@ -74058,8 +76693,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -74116,8 +76751,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -74134,7 +76769,7 @@ paths: type: integer environments: type: array - items: &511 + items: &510 title: Environment description: Details of a deployment environment type: object @@ -74186,7 +76821,7 @@ paths: type: type: string example: wait_timer - wait_timer: &513 + wait_timer: &512 type: integer example: 30 description: The amount of time to delay a job after @@ -74223,11 +76858,11 @@ paths: items: type: object properties: - type: *510 + type: *509 reviewer: anyOf: - *4 - - *198 + - *197 required: - id - node_id @@ -74247,7 +76882,7 @@ paths: - id - node_id - type - deployment_branch_policy: &514 + deployment_branch_policy: &513 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -74363,9 +76998,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: + - *343 - *344 - - *345 - - &512 + - &511 name: environment_name in: path required: true @@ -74378,9 +77013,9 @@ paths: description: Response content: application/json: - schema: *511 + schema: *510 examples: - default: &515 + default: &514 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -74464,9 +77099,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: + - *343 - *344 - - *345 - - *512 + - *511 requestBody: required: false content: @@ -74475,7 +77110,7 @@ paths: type: object nullable: true properties: - wait_timer: *513 + wait_timer: *512 prevent_self_review: type: boolean example: false @@ -74492,13 +77127,13 @@ paths: items: type: object properties: - type: *510 + type: *509 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *514 + deployment_branch_policy: *513 additionalProperties: false examples: default: @@ -74518,9 +77153,9 @@ paths: description: Response content: application/json: - schema: *511 + schema: *510 examples: - default: *515 + default: *514 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -74544,9 +77179,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: + - *343 - *344 - - *345 - - *512 + - *511 responses: '204': description: Default response @@ -74571,9 +77206,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: + - *343 - *344 - - *345 - - *512 + - *511 - *17 - *19 responses: @@ -74591,7 +77226,7 @@ paths: example: 2 branch_policies: type: array - items: &516 + items: &515 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -74648,9 +77283,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: + - *343 - *344 - - *345 - - *512 + - *511 requestBody: required: true content: @@ -74696,9 +77331,9 @@ paths: description: Response content: application/json: - schema: *516 + schema: *515 examples: - example-wildcard: &517 + example-wildcard: &516 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -74740,10 +77375,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: + - *343 - *344 - - *345 - - *512 - - &518 + - *511 + - &517 name: branch_policy_id in: path required: true @@ -74755,9 +77390,9 @@ paths: description: Response content: application/json: - schema: *516 + schema: *515 examples: - default: *517 + default: *516 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74776,10 +77411,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: + - *343 - *344 - - *345 - - *512 - - *518 + - *511 + - *517 requestBody: required: true content: @@ -74807,9 +77442,9 @@ paths: description: Response content: application/json: - schema: *516 + schema: *515 examples: - default: *517 + default: *516 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74828,10 +77463,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: + - *343 - *344 - - *345 - - *512 - - *518 + - *511 + - *517 responses: '204': description: Response @@ -74856,9 +77491,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *512 - - *345 + - *511 - *344 + - *343 responses: '200': description: List of deployment protection rules @@ -74874,7 +77509,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &519 + items: &518 title: Deployment protection rule description: Deployment protection rule type: object @@ -74893,7 +77528,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &520 + app: &519 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -74992,9 +77627,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: - - *512 - - *345 + - *511 - *344 + - *343 requestBody: content: application/json: @@ -75015,9 +77650,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *519 + schema: *518 examples: - default: &521 + default: &520 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -75052,9 +77687,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: - - *512 - - *345 + - *511 - *344 + - *343 - *19 - *17 responses: @@ -75073,7 +77708,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *520 + items: *519 examples: default: value: @@ -75108,10 +77743,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: + - *343 - *344 - - *345 - - *512 - - &522 + - *511 + - &521 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -75123,9 +77758,9 @@ paths: description: Response content: application/json: - schema: *519 + schema: *518 examples: - default: *521 + default: *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75146,10 +77781,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *512 - - *345 + - *511 - *344 - - *522 + - *343 + - *521 responses: '204': description: Response @@ -75175,9 +77810,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: + - *343 - *344 - - *345 - - *512 + - *511 - *17 - *19 responses: @@ -75195,9 +77830,9 @@ paths: type: integer secrets: type: array - items: *389 + items: *388 examples: - default: *390 + default: *389 headers: Link: *67 x-github: @@ -75222,17 +77857,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: + - *343 - *344 - - *345 - - *512 + - *511 responses: '200': description: Response content: application/json: - schema: *391 + schema: *390 examples: - default: *392 + default: *391 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75254,18 +77889,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: + - *343 - *344 - - *345 - - *512 - - *169 + - *511 + - *168 responses: '200': description: Response content: application/json: - schema: *389 + schema: *388 examples: - default: *523 + default: *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75287,10 +77922,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: + - *343 - *344 - - *345 - - *512 - - *169 + - *511 + - *168 requestBody: required: true content: @@ -75321,7 +77956,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -75347,10 +77982,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: + - *343 - *344 - - *345 - - *512 - - *169 + - *511 + - *168 responses: '204': description: Default response @@ -75375,10 +78010,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: + - *343 - *344 - - *345 - - *512 - - *360 + - *511 + - *359 - *19 responses: '200': @@ -75395,9 +78030,9 @@ paths: type: integer variables: type: array - items: *393 + items: *392 examples: - default: *394 + default: *393 headers: Link: *67 x-github: @@ -75420,9 +78055,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: + - *343 - *344 - - *345 - - *512 + - *511 requestBody: required: true content: @@ -75449,7 +78084,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -75474,18 +78109,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: + - *343 - *344 - - *345 - - *512 - - *172 + - *511 + - *171 responses: '200': description: Response content: application/json: - schema: *393 + schema: *392 examples: - default: *524 + default: *523 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75506,10 +78141,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: + - *343 - *344 - - *345 - - *172 - - *512 + - *171 + - *511 requestBody: required: true content: @@ -75551,10 +78186,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: + - *343 - *344 - - *345 - - *172 - - *512 + - *171 + - *511 responses: '204': description: Response @@ -75576,8 +78211,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -75645,8 +78280,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: + - *343 - *344 - - *345 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -75668,7 +78303,7 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: default: value: @@ -75805,8 +78440,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: + - *343 - *344 - - *345 requestBody: required: false content: @@ -75838,9 +78473,9 @@ paths: description: Response content: application/json: - schema: *347 + schema: *346 examples: - default: *349 + default: *348 '400': *14 '422': *15 '403': *29 @@ -75861,8 +78496,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -75922,7 +78557,7 @@ paths: schema: oneOf: - *129 - - *525 + - *524 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75947,8 +78582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: + - *343 - *344 - - *345 - name: file_sha in: path required: true @@ -76047,8 +78682,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -76157,7 +78792,7 @@ paths: description: Response content: application/json: - schema: &526 + schema: &525 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -76371,15 +79006,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: + - *343 - *344 - - *345 - - *479 + - *478 responses: '200': description: Response content: application/json: - schema: *526 + schema: *525 examples: default: value: @@ -76435,9 +79070,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: + - *343 - *344 - - *345 - - &527 + - &526 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. @@ -76454,7 +79089,7 @@ paths: application/json: schema: type: array - items: &528 + items: &527 title: Git Reference description: Git references within a repository type: object @@ -76529,17 +79164,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: + - *343 - *344 - - *345 - - *527 + - *526 responses: '200': description: Response content: application/json: - schema: *528 + schema: *527 examples: - default: &529 + default: &528 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -76568,8 +79203,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -76598,9 +79233,9 @@ paths: description: Response content: application/json: - schema: *528 + schema: *527 examples: - default: *529 + default: *528 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -76626,9 +79261,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: + - *343 - *344 - - *345 - - *527 + - *526 requestBody: required: true content: @@ -76657,9 +79292,9 @@ paths: description: Response content: application/json: - schema: *528 + schema: *527 examples: - default: *529 + default: *528 '422': *15 '409': *54 x-github: @@ -76677,9 +79312,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: + - *343 - *344 - - *345 - - *527 + - *526 responses: '204': description: Response @@ -76734,8 +79369,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -76802,7 +79437,7 @@ paths: description: Response content: application/json: - schema: &531 + schema: &530 title: Git Tag description: Metadata for a Git tag type: object @@ -76853,7 +79488,7 @@ paths: - sha - type - url - verification: *530 + verification: *529 required: - sha - url @@ -76863,7 +79498,7 @@ paths: - tag - message examples: - default: &532 + default: &531 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -76936,8 +79571,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: + - *343 - *344 - - *345 - name: tag_sha in: path required: true @@ -76948,9 +79583,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *530 examples: - default: *532 + default: *531 '404': *6 '409': *54 x-github: @@ -76974,8 +79609,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -77048,7 +79683,7 @@ paths: description: Response content: application/json: - schema: &533 + schema: &532 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -77144,8 +79779,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: + - *343 - *344 - - *345 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -77168,7 +79803,7 @@ paths: description: Response content: application/json: - schema: *533 + schema: *532 examples: default-response: summary: Default response @@ -77227,8 +79862,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -77238,7 +79873,7 @@ paths: application/json: schema: type: array - items: &534 + items: &533 title: Webhook description: Webhooks for repositories. type: object @@ -77292,7 +79927,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &779 + last_response: &778 title: Hook Response type: object properties: @@ -77366,8 +80001,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: + - *343 - *344 - - *345 requestBody: required: false content: @@ -77419,9 +80054,9 @@ paths: description: Response content: application/json: - schema: *534 + schema: *533 examples: - default: &535 + default: &534 value: type: Repository id: 12345678 @@ -77469,17 +80104,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: + - *343 - *344 - - *345 - - *216 + - *215 responses: '200': description: Response content: application/json: - schema: *534 + schema: *533 examples: - default: *535 + default: *534 '404': *6 x-github: githubCloudOnly: false @@ -77499,9 +80134,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: + - *343 - *344 - - *345 - - *216 + - *215 requestBody: required: true content: @@ -77546,9 +80181,9 @@ paths: description: Response content: application/json: - schema: *534 + schema: *533 examples: - default: *535 + default: *534 '422': *15 '404': *6 x-github: @@ -77569,9 +80204,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: + - *343 - *344 - - *345 - - *216 + - *215 responses: '204': description: Response @@ -77595,9 +80230,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: + - *343 - *344 - - *345 - - *216 + - *215 responses: '200': description: Response @@ -77624,9 +80259,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: + - *343 - *344 - - *345 - - *216 + - *215 requestBody: required: false content: @@ -77670,12 +80305,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: + - *343 - *344 - - *345 - - *216 + - *215 - *17 + - *216 - *217 - - *218 responses: '200': description: Response @@ -77683,9 +80318,9 @@ paths: application/json: schema: type: array - items: *219 + items: *218 examples: - default: *220 + default: *219 '400': *14 '422': *15 x-github: @@ -77704,18 +80339,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: + - *343 - *344 - - *345 - - *216 + - *215 - *16 responses: '200': description: Response content: application/json: - schema: *221 + schema: *220 examples: - default: *222 + default: *221 '400': *14 '422': *15 x-github: @@ -77734,9 +80369,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: + - *343 - *344 - - *345 - - *216 + - *215 - *16 responses: '202': *39 @@ -77759,9 +80394,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: + - *343 - *344 - - *345 - - *216 + - *215 responses: '204': description: Response @@ -77786,9 +80421,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: + - *343 - *344 - - *345 - - *216 + - *215 responses: '204': description: Response @@ -77811,8 +80446,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: + - *343 - *344 - - *345 responses: '200': description: Response if immutable releases are enabled @@ -77858,10 +80493,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: + - *343 - *344 - - *345 responses: - '204': *192 + '204': *191 '409': *54 x-github: githubCloudOnly: false @@ -77879,10 +80514,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: + - *343 - *344 - - *345 responses: - '204': *192 + '204': *191 '409': *54 x-github: githubCloudOnly: false @@ -77937,14 +80572,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: + - *343 - *344 - - *345 responses: '200': description: Response content: application/json: - schema: &536 + schema: &535 title: Import description: A repository import from an external source. type: object @@ -78043,7 +80678,7 @@ paths: - html_url - authors_url examples: - default: &539 + default: &538 value: vcs: subversion use_lfs: true @@ -78059,7 +80694,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': &537 + '503': &536 description: Unavailable due to service under maintenance. content: application/json: @@ -78088,8 +80723,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -78137,7 +80772,7 @@ paths: description: Response content: application/json: - schema: *536 + schema: *535 examples: default: value: @@ -78162,7 +80797,7 @@ paths: type: string '422': *15 '404': *6 - '503': *537 + '503': *536 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78190,8 +80825,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: + - *343 - *344 - - *345 requestBody: required: false content: @@ -78240,7 +80875,7 @@ paths: description: Response content: application/json: - schema: *536 + schema: *535 examples: example-1: summary: Example 1 @@ -78288,7 +80923,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': *537 + '503': *536 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78311,12 +80946,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: + - *343 - *344 - - *345 responses: '204': description: Response - '503': *537 + '503': *536 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78342,9 +80977,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: + - *343 - *344 - - *345 - - &707 + - &706 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -78358,7 +80993,7 @@ paths: application/json: schema: type: array - items: &538 + items: &537 title: Porter Author description: Porter Author type: object @@ -78412,7 +81047,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': *537 + '503': *536 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78437,8 +81072,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: + - *343 - *344 - - *345 - name: author_id in: path required: true @@ -78468,7 +81103,7 @@ paths: description: Response content: application/json: - schema: *538 + schema: *537 examples: default: value: @@ -78481,7 +81116,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *537 + '503': *536 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78505,8 +81140,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: + - *343 - *344 - - *345 responses: '200': description: Response @@ -78547,7 +81182,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *537 + '503': *536 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78575,8 +81210,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -78603,11 +81238,11 @@ paths: description: Response content: application/json: - schema: *536 + schema: *535 examples: - default: *539 + default: *538 '422': *15 - '503': *537 + '503': *536 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78630,8 +81265,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: + - *343 - *344 - - *345 responses: '200': description: Response @@ -78639,8 +81274,8 @@ paths: application/json: schema: *22 examples: - default: *540 - '301': *348 + default: *539 + '301': *347 '404': *6 x-github: githubCloudOnly: false @@ -78660,8 +81295,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: + - *343 - *344 - - *345 responses: '200': description: Response @@ -78669,12 +81304,12 @@ paths: application/json: schema: anyOf: - - *235 + - *234 - type: object properties: {} additionalProperties: false examples: - default: &542 + default: &541 value: limit: collaborators_only origin: repository @@ -78699,13 +81334,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: + - *343 - *344 - - *345 requestBody: required: true content: application/json: - schema: *541 + schema: *540 examples: default: summary: Example request body @@ -78717,9 +81352,9 @@ paths: description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *542 + default: *541 '409': description: Response x-github: @@ -78741,8 +81376,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: + - *343 - *344 - - *345 responses: '204': description: Response @@ -78765,8 +81400,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -78776,9 +81411,9 @@ paths: application/json: schema: type: array - items: *543 + items: *542 examples: - default: &700 + default: &699 value: - id: 1 repository: @@ -78909,9 +81544,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: + - *343 - *344 - - *345 - - *239 + - *238 requestBody: required: false content: @@ -78940,7 +81575,7 @@ paths: description: Response content: application/json: - schema: *543 + schema: *542 examples: default: value: @@ -79071,9 +81706,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: + - *343 - *344 - - *345 - - *239 + - *238 responses: '204': description: Response @@ -79104,8 +81739,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: + - *343 - *344 - - *345 - 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 @@ -79153,7 +81788,7 @@ paths: required: false schema: type: string - - *246 + - *245 - name: sort description: What to sort results by. in: query @@ -79178,7 +81813,7 @@ paths: type: array items: *85 examples: - default: &556 + default: &555 value: - id: 1 node_id: MDU6SXNzdWUx @@ -79327,7 +81962,7 @@ paths: state_reason: completed headers: Link: *67 - '301': *348 + '301': *347 '422': *15 '404': *6 x-github: @@ -79356,8 +81991,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -79441,7 +82076,7 @@ paths: application/json: schema: *85 examples: - default: &553 + default: &552 value: id: 1 node_id: MDU6SXNzdWUx @@ -79598,7 +82233,7 @@ paths: '422': *15 '503': *121 '404': *6 - '410': *544 + '410': *543 x-github: triggersNotification: true githubCloudOnly: false @@ -79636,8 +82271,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: + - *343 - *344 - - *345 - *109 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -79658,9 +82293,9 @@ paths: application/json: schema: type: array - items: *545 + items: *544 examples: - default: &555 + default: &554 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -79718,17 +82353,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: + - *343 - *344 - - *345 - *101 responses: '200': description: Response content: application/json: - schema: *545 + schema: *544 examples: - default: &546 + default: &545 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -79783,8 +82418,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: + - *343 - *344 - - *345 - *101 requestBody: required: true @@ -79807,9 +82442,9 @@ paths: description: Response content: application/json: - schema: *545 + schema: *544 examples: - default: *546 + default: *545 '422': *15 x-github: githubCloudOnly: false @@ -79827,8 +82462,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: + - *343 - *344 - - *345 - *101 responses: '204': @@ -79857,15 +82492,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment parameters: + - *343 - *344 - - *345 - *101 responses: '200': description: Response content: application/json: - schema: *545 + schema: *544 examples: default: value: @@ -79921,7 +82556,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *544 + '410': *543 '422': *15 x-github: githubCloudOnly: false @@ -79938,8 +82573,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment parameters: + - *343 - *344 - - *345 - *101 responses: '204': @@ -79947,7 +82582,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *544 + '410': *543 '503': *121 x-github: githubCloudOnly: false @@ -79965,8 +82600,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: + - *343 - *344 - - *345 - *101 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -79993,9 +82628,9 @@ paths: application/json: schema: type: array - items: *476 + items: *475 examples: - default: *547 + default: *546 headers: Link: *67 '404': *6 @@ -80016,8 +82651,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: + - *343 - *344 - - *345 - *101 requestBody: required: true @@ -80050,16 +82685,16 @@ paths: description: Reaction exists content: application/json: - schema: *476 + schema: *475 examples: - default: *477 + default: *476 '201': description: Reaction created content: application/json: - schema: *476 + schema: *475 examples: - default: *477 + default: *476 '422': *15 x-github: githubCloudOnly: false @@ -80081,10 +82716,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: + - *343 - *344 - - *345 - *101 - - *548 + - *547 responses: '204': description: Response @@ -80104,8 +82739,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -80115,7 +82750,7 @@ paths: application/json: schema: type: array - items: &552 + items: &551 title: Issue Event description: Issue Event type: object @@ -80158,9 +82793,9 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *549 - required: *550 - x-github-breaking-changes: *551 + properties: *548 + required: *549 + x-github-breaking-changes: *550 nullable: true label: title: Issue Event Label @@ -80204,7 +82839,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *198 + requested_team: *197 dismissed_review: title: Issue Event Dismissed Review type: object @@ -80468,8 +83103,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: + - *343 - *344 - - *345 - name: event_id in: path required: true @@ -80480,7 +83115,7 @@ paths: description: Response content: application/json: - schema: *552 + schema: *551 examples: default: value: @@ -80673,7 +83308,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *544 + '410': *543 '403': *29 x-github: githubCloudOnly: false @@ -80707,9 +83342,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: + - *343 - *344 - - *345 - - &554 + - &553 name: issue_number description: The number that identifies the issue. in: path @@ -80725,7 +83360,7 @@ paths: examples: default: summary: Issue - value: *553 + value: *552 pinned_comment: summary: Issue with pinned comment value: @@ -80924,9 +83559,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *348 + '301': *347 '404': *6 - '410': *544 + '410': *543 '304': *37 x-github: githubCloudOnly: false @@ -80951,9 +83586,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: + - *343 - *344 - - *345 - - *554 + - *553 requestBody: required: false content: @@ -81079,13 +83714,13 @@ paths: application/json: schema: *85 examples: - default: *553 + default: *552 '422': *15 '503': *121 '403': *29 - '301': *348 + '301': *347 '404': *6 - '410': *544 + '410': *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81113,9 +83748,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: + - *343 - *344 - - *345 - - *554 + - *553 requestBody: required: false content: @@ -81143,7 +83778,7 @@ paths: application/json: schema: *85 examples: - default: *553 + default: *552 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81159,9 +83794,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: + - *343 - *344 - - *345 - - *554 + - *553 requestBody: content: application/json: @@ -81188,7 +83823,7 @@ paths: application/json: schema: *85 examples: - default: *553 + default: *552 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81210,9 +83845,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: + - *343 - *344 - - *345 - - *554 + - *553 - name: assignee in: path required: true @@ -81252,9 +83887,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: + - *343 - *344 - - *345 - - *554 + - *553 - *92 - *17 - *19 @@ -81265,13 +83900,13 @@ paths: application/json: schema: type: array - items: *545 + items: *544 examples: - default: *555 + default: *554 headers: Link: *67 '404': *6 - '410': *544 + '410': *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81300,9 +83935,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: + - *343 - *344 - - *345 - - *554 + - *553 requestBody: required: true content: @@ -81324,16 +83959,16 @@ paths: description: Response content: application/json: - schema: *545 + schema: *544 examples: - default: *546 + default: *545 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *544 + '410': *543 '422': *15 '404': *6 x-github: @@ -81361,9 +83996,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: + - *343 - *344 - - *345 - - *554 + - *553 - *17 - *19 responses: @@ -81375,12 +84010,12 @@ paths: type: array items: *85 examples: - default: *556 + default: *555 headers: Link: *67 - '301': *348 + '301': *347 '404': *6 - '410': *544 + '410': *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81408,9 +84043,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: + - *343 - *344 - - *345 - - *554 + - *553 requestBody: required: true content: @@ -81434,15 +84069,15 @@ paths: application/json: schema: *85 examples: - default: *553 + default: *552 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *348 + '301': *347 '403': *29 - '410': *544 + '410': *543 '422': *15 '404': *6 x-github: @@ -81473,9 +84108,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: + - *343 - *344 - - *345 - - *554 + - *553 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -81489,13 +84124,13 @@ paths: application/json: schema: *85 examples: - default: *553 - '301': *348 + default: *552 + '301': *347 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *544 + '410': *543 x-github: triggersNotification: true githubCloudOnly: false @@ -81521,9 +84156,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: + - *343 - *344 - - *345 - - *554 + - *553 - *17 - *19 responses: @@ -81535,12 +84170,12 @@ paths: type: array items: *85 examples: - default: *556 + default: *555 headers: Link: *67 - '301': *348 + '301': *347 '404': *6 - '410': *544 + '410': *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81557,9 +84192,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: + - *343 - *344 - - *345 - - *554 + - *553 - *17 - *19 responses: @@ -81573,7 +84208,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &559 + - &558 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -81627,7 +84262,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &560 + - &559 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -81763,7 +84398,7 @@ paths: - performed_via_github_app - assignee - assigner - - &561 + - &560 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -81814,7 +84449,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &562 + - &561 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -81865,7 +84500,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &563 + - &562 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -81919,7 +84554,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &564 + - &563 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -81953,7 +84588,7 @@ paths: properties: *80 required: *81 review_requester: *4 - requested_team: *198 + requested_team: *197 requested_reviewer: *4 required: - review_requester @@ -81966,7 +84601,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &565 + - &564 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -82000,7 +84635,7 @@ paths: properties: *80 required: *81 review_requester: *4 - requested_team: *198 + requested_team: *197 requested_reviewer: *4 required: - review_requester @@ -82013,7 +84648,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &566 + - &565 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -82073,7 +84708,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &567 + - &566 title: Locked Issue Event description: Locked Issue Event type: object @@ -82121,7 +84756,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &568 + - &567 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -82187,7 +84822,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &569 + - &568 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -82253,7 +84888,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &570 + - &569 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -82319,7 +84954,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &571 + - &570 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -82410,7 +85045,7 @@ paths: color: red headers: Link: *67 - '410': *544 + '410': *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82427,9 +85062,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: + - *343 - *344 - - *345 - - *554 + - *553 - *17 - *19 responses: @@ -82439,9 +85074,9 @@ paths: application/json: schema: type: array - items: *557 + items: *556 examples: - default: &670 + default: &669 value: - issue_field_id: 1 node_id: IFT_GDKND @@ -82465,9 +85100,9 @@ paths: value: '2025-12-25' headers: Link: *67 - '301': *348 + '301': *347 '404': *6 - '410': *544 + '410': *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82484,9 +85119,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: + - *343 - *344 - - *345 - - *554 + - *553 - *17 - *19 responses: @@ -82498,7 +85133,7 @@ paths: type: array items: *84 examples: - default: &558 + default: &557 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -82516,9 +85151,9 @@ paths: default: false headers: Link: *67 - '301': *348 + '301': *347 '404': *6 - '410': *544 + '410': *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82534,9 +85169,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: + - *343 - *344 - - *345 - - *554 + - *553 requestBody: required: false content: @@ -82581,10 +85216,10 @@ paths: type: array items: *84 examples: - default: *558 - '301': *348 + default: *557 + '301': *347 '404': *6 - '410': *544 + '410': *543 '422': *15 x-github: githubCloudOnly: false @@ -82601,9 +85236,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: + - *343 - *344 - - *345 - - *554 + - *553 requestBody: required: false content: @@ -82665,10 +85300,10 @@ paths: type: array items: *84 examples: - default: *558 - '301': *348 + default: *557 + '301': *347 '404': *6 - '410': *544 + '410': *543 '422': *15 x-github: githubCloudOnly: false @@ -82685,15 +85320,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: + - *343 - *344 - - *345 - - *554 + - *553 responses: '204': description: Response - '301': *348 + '301': *347 '404': *6 - '410': *544 + '410': *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82712,9 +85347,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: + - *343 - *344 - - *345 - - *554 + - *553 - name: name in: path required: true @@ -82738,9 +85373,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *348 + '301': *347 '404': *6 - '410': *544 + '410': *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82760,9 +85395,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: + - *343 - *344 - - *345 - - *554 + - *553 requestBody: required: false content: @@ -82790,7 +85425,7 @@ paths: '204': description: Response '403': *29 - '410': *544 + '410': *543 '404': *6 '422': *15 x-github: @@ -82808,9 +85443,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: + - *343 - *344 - - *345 - - *554 + - *553 responses: '204': description: Response @@ -82840,9 +85475,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: + - *343 - *344 - - *345 - - *554 + - *553 responses: '200': description: Response @@ -82850,10 +85485,10 @@ paths: application/json: schema: *85 examples: - default: *553 - '301': *348 + default: *552 + '301': *347 '404': *6 - '410': *544 + '410': *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82870,9 +85505,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: + - *343 - *344 - - *345 - - *554 + - *553 - 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. @@ -82898,13 +85533,13 @@ paths: application/json: schema: type: array - items: *476 + items: *475 examples: - default: *547 + default: *546 headers: Link: *67 '404': *6 - '410': *544 + '410': *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82922,9 +85557,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: + - *343 - *344 - - *345 - - *554 + - *553 requestBody: required: true content: @@ -82956,16 +85591,16 @@ paths: description: Response content: application/json: - schema: *476 + schema: *475 examples: - default: *477 + default: *476 '201': description: Response content: application/json: - schema: *476 + schema: *475 examples: - default: *477 + default: *476 '422': *15 x-github: githubCloudOnly: false @@ -82987,10 +85622,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: + - *343 - *344 - - *345 - - *554 - - *548 + - *553 + - *547 responses: '204': description: Response @@ -83019,9 +85654,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: + - *343 - *344 - - *345 - - *554 + - *553 requestBody: required: true content: @@ -83045,7 +85680,7 @@ paths: application/json: schema: *85 examples: - default: *553 + default: *552 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -83078,9 +85713,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: + - *343 - *344 - - *345 - - *554 + - *553 - *17 - *19 responses: @@ -83092,11 +85727,11 @@ paths: type: array items: *85 examples: - default: *556 + default: *555 headers: Link: *67 '404': *6 - '410': *544 + '410': *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83124,9 +85759,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: + - *343 - *344 - - *345 - - *554 + - *553 requestBody: required: true content: @@ -83155,14 +85790,14 @@ paths: application/json: schema: *85 examples: - default: *553 + default: *552 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *544 + '410': *543 '422': *15 '404': *6 x-github: @@ -83182,9 +85817,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: + - *343 - *344 - - *345 - - *554 + - *553 requestBody: required: true content: @@ -83217,7 +85852,7 @@ paths: application/json: schema: *85 examples: - default: *553 + default: *552 '403': *29 '404': *6 '422': *7 @@ -83239,9 +85874,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: + - *343 - *344 - - *345 - - *554 + - *553 - *17 - *19 responses: @@ -83256,6 +85891,7 @@ paths: description: Timeline Event type: object anyOf: + - *558 - *559 - *560 - *561 @@ -83268,7 +85904,6 @@ paths: - *568 - *569 - *570 - - *571 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -83329,8 +85964,8 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *572 - required: *573 + properties: *571 + required: *572 nullable: true required: - event @@ -83585,7 +86220,7 @@ paths: type: string comments: type: array - items: &593 + items: &592 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -83800,7 +86435,7 @@ paths: type: string comments: type: array - items: *475 + items: *474 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -84089,7 +86724,7 @@ paths: headers: Link: *67 '404': *6 - '410': *544 + '410': *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84106,8 +86741,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -84117,7 +86752,7 @@ paths: application/json: schema: type: array - items: &574 + items: &573 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -84183,8 +86818,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -84220,9 +86855,9 @@ paths: description: Response content: application/json: - schema: *574 + schema: *573 examples: - default: &575 + default: &574 value: id: 1 key: ssh-rsa AAA... @@ -84256,9 +86891,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: + - *343 - *344 - - *345 - - &576 + - &575 name: key_id description: The unique identifier of the key. in: path @@ -84270,9 +86905,9 @@ paths: description: Response content: application/json: - schema: *574 + schema: *573 examples: - default: *575 + default: *574 '404': *6 x-github: githubCloudOnly: false @@ -84290,9 +86925,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: + - *343 - *344 - - *345 - - *576 + - *575 responses: '204': description: Response @@ -84312,8 +86947,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -84325,7 +86960,7 @@ paths: type: array items: *84 examples: - default: *558 + default: *557 headers: Link: *67 '404': *6 @@ -84346,8 +86981,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -84385,7 +87020,7 @@ paths: application/json: schema: *84 examples: - default: &577 + default: &576 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -84417,8 +87052,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: + - *343 - *344 - - *345 - name: name in: path required: true @@ -84431,7 +87066,7 @@ paths: application/json: schema: *84 examples: - default: *577 + default: *576 '404': *6 x-github: githubCloudOnly: false @@ -84448,8 +87083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: + - *343 - *344 - - *345 - name: name in: path required: true @@ -84514,8 +87149,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: + - *343 - *344 - - *345 - name: name in: path required: true @@ -84541,8 +87176,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: + - *343 - *344 - - *345 responses: '200': description: Response @@ -84581,9 +87216,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: + - *343 - *344 - - *345 - - *448 + - *447 responses: '200': description: Response @@ -84728,8 +87363,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -84794,8 +87429,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -84829,9 +87464,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *478 + schema: *477 examples: - default: *578 + default: *577 '204': description: Response when already merged '404': @@ -84856,8 +87491,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: + - *343 - *344 - - *345 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -84898,12 +87533,12 @@ paths: application/json: schema: type: array - items: &579 + items: &578 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *280 - required: *281 + properties: *279 + required: *280 examples: default: value: @@ -84959,8 +87594,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -85000,9 +87635,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *578 examples: - default: &580 + default: &579 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -85061,9 +87696,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: + - *343 - *344 - - *345 - - &581 + - &580 name: milestone_number description: The number that identifies the milestone. in: path @@ -85075,9 +87710,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *578 examples: - default: *580 + default: *579 '404': *6 x-github: githubCloudOnly: false @@ -85094,9 +87729,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: + - *343 - *344 - - *345 - - *581 + - *580 requestBody: required: false content: @@ -85134,9 +87769,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *578 examples: - default: *580 + default: *579 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85152,9 +87787,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: + - *343 - *344 - - *345 - - *581 + - *580 responses: '204': description: Response @@ -85175,9 +87810,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: + - *343 - *344 - - *345 - - *581 + - *580 - *17 - *19 responses: @@ -85189,7 +87824,7 @@ paths: type: array items: *84 examples: - default: *558 + default: *557 headers: Link: *67 x-github: @@ -85208,12 +87843,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: + - *343 - *344 - - *345 + - *581 - *582 - - *583 - *92 - - *584 + - *583 - *17 - *19 responses: @@ -85225,7 +87860,7 @@ paths: type: array items: *112 examples: - default: *585 + default: *584 headers: Link: *67 x-github: @@ -85249,8 +87884,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: + - *343 - *344 - - *345 requestBody: required: false content: @@ -85308,14 +87943,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: + - *343 - *344 - - *345 responses: '200': description: Response content: application/json: - schema: &586 + schema: &585 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -85440,7 +88075,7 @@ paths: - custom_404 - public examples: - default: &587 + default: &586 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -85481,8 +88116,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -85536,9 +88171,9 @@ paths: description: Response content: application/json: - schema: *586 + schema: *585 examples: - default: *587 + default: *586 '422': *15 '409': *54 x-github: @@ -85561,8 +88196,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -85661,8 +88296,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: + - *343 - *344 - - *345 responses: '204': description: Response @@ -85688,8 +88323,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -85699,7 +88334,7 @@ paths: application/json: schema: type: array - items: &588 + items: &587 title: Page Build description: Page Build type: object @@ -85793,8 +88428,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: + - *343 - *344 - - *345 responses: '201': description: Response @@ -85839,16 +88474,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: + - *343 - *344 - - *345 responses: '200': description: Response content: application/json: - schema: *588 + schema: *587 examples: - default: &589 + default: &588 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -85896,8 +88531,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: + - *343 - *344 - - *345 - name: build_id in: path required: true @@ -85908,9 +88543,9 @@ paths: description: Response content: application/json: - schema: *588 + schema: *587 examples: - default: *589 + default: *588 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85930,8 +88565,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -86036,9 +88671,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: + - *343 - *344 - - *345 - - &590 + - &589 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -86096,11 +88731,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: + - *343 - *344 - - *345 - - *590 + - *589 responses: - '204': *192 + '204': *191 '404': *6 x-github: githubCloudOnly: false @@ -86125,8 +88760,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: + - *343 - *344 - - *345 responses: '200': description: Response @@ -86357,7 +88992,7 @@ paths: description: Empty response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -86384,8 +89019,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: + - *343 - *344 - - *345 responses: '200': description: Private vulnerability reporting status @@ -86422,10 +89057,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: + - *343 - *344 - - *345 responses: - '204': *192 + '204': *191 '422': *14 x-github: githubCloudOnly: false @@ -86444,10 +89079,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: + - *343 - *344 - - *345 responses: - '204': *192 + '204': *191 '422': *14 x-github: githubCloudOnly: false @@ -86467,8 +89102,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: + - *343 - *344 - - *345 responses: '200': description: Response @@ -86476,7 +89111,7 @@ paths: application/json: schema: type: array - items: *295 + items: *294 examples: default: value: @@ -86507,8 +89142,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: + - *343 - *344 - - *345 requestBody: required: true content: @@ -86520,7 +89155,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *295 + items: *294 required: - properties examples: @@ -86570,8 +89205,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: + - *343 - *344 - - *345 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -86631,9 +89266,9 @@ paths: application/json: schema: type: array - items: *482 + items: *481 examples: - default: *591 + default: *590 headers: Link: *67 '304': *37 @@ -86665,8 +89300,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -86731,7 +89366,7 @@ paths: description: Response content: application/json: - schema: &595 + schema: &594 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -86842,8 +89477,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *280 - required: *281 + properties: *279 + required: *280 nullable: true active_lock_reason: type: string @@ -86886,7 +89521,7 @@ paths: items: *4 requested_teams: type: array - items: *333 + items: *332 head: type: object properties: @@ -86924,14 +89559,14 @@ paths: _links: type: object properties: - comments: *282 - commits: *282 - statuses: *282 - html: *282 - issue: *282 - review_comments: *282 - review_comment: *282 - self: *282 + comments: *281 + commits: *281 + statuses: *281 + html: *281 + issue: *281 + review_comments: *281 + review_comment: *281 + self: *281 required: - comments - commits @@ -86942,7 +89577,7 @@ paths: - review_comment - self author_association: *82 - auto_merge: *592 + auto_merge: *591 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -87128,7 +89763,7 @@ paths: - review_comments version: '2026-03-10' examples: - default: &596 + default: &595 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -87655,8 +90290,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: + - *343 - *344 - - *345 - name: sort in: query required: false @@ -87685,9 +90320,9 @@ paths: application/json: schema: type: array - items: *593 + items: *592 examples: - default: &598 + default: &597 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -87764,17 +90399,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: + - *343 - *344 - - *345 - *101 responses: '200': description: Response content: application/json: - schema: *593 + schema: *592 examples: - default: &594 + default: &593 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -87849,8 +90484,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: + - *343 - *344 - - *345 - *101 requestBody: required: true @@ -87873,9 +90508,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *592 examples: - default: *594 + default: *593 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87891,8 +90526,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: + - *343 - *344 - - *345 - *101 responses: '204': @@ -87914,8 +90549,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: + - *343 - *344 - - *345 - *101 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -87942,9 +90577,9 @@ paths: application/json: schema: type: array - items: *476 + items: *475 examples: - default: *547 + default: *546 headers: Link: *67 '404': *6 @@ -87965,8 +90600,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: + - *343 - *344 - - *345 - *101 requestBody: required: true @@ -87999,16 +90634,16 @@ paths: description: Reaction exists content: application/json: - schema: *476 + schema: *475 examples: - default: *477 + default: *476 '201': description: Reaction created content: application/json: - schema: *476 + schema: *475 examples: - default: *477 + default: *476 '422': *15 x-github: githubCloudOnly: false @@ -88030,10 +90665,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: + - *343 - *344 - - *345 - *101 - - *548 + - *547 responses: '204': description: Response @@ -88076,9 +90711,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: + - *343 - *344 - - *345 - - &597 + - &596 name: pull_number description: The number that identifies the pull request. in: path @@ -88091,9 +90726,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *595 + schema: *594 examples: - default: *596 + default: *595 '304': *37 '404': *6 '406': @@ -88128,9 +90763,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: + - *343 - *344 - - *345 - - *597 + - *596 requestBody: required: false content: @@ -88172,9 +90807,9 @@ paths: description: Response content: application/json: - schema: *595 + schema: *594 examples: - default: *596 + default: *595 '422': *15 '403': *29 x-github: @@ -88196,9 +90831,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: + - *343 - *344 - - *345 - - *597 + - *596 requestBody: required: true content: @@ -88258,17 +90893,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *248 + schema: *247 examples: - default: *465 + default: *464 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *248 + schema: *247 examples: - default: *465 + default: *464 '401': *25 '403': *29 '404': *6 @@ -88298,9 +90933,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: + - *343 - *344 - - *345 - - *597 + - *596 - *109 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -88321,9 +90956,9 @@ paths: application/json: schema: type: array - items: *593 + items: *592 examples: - default: *598 + default: *597 headers: Link: *67 x-github: @@ -88356,9 +90991,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: + - *343 - *344 - - *345 - - *597 + - *596 requestBody: required: true content: @@ -88463,7 +91098,7 @@ paths: description: Response content: application/json: - schema: *593 + schema: *592 examples: example-for-a-multi-line-comment: value: @@ -88551,9 +91186,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: + - *343 - *344 - - *345 - - *597 + - *596 - *101 requestBody: required: true @@ -88576,7 +91211,7 @@ paths: description: Response content: application/json: - schema: *593 + schema: *592 examples: default: value: @@ -88662,9 +91297,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: + - *343 - *344 - - *345 - - *597 + - *596 - *17 - *19 responses: @@ -88674,9 +91309,9 @@ paths: application/json: schema: type: array - items: *478 + items: *477 examples: - default: *599 + default: *598 headers: Link: *67 x-github: @@ -88706,9 +91341,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: + - *343 - *344 - - *345 - - *597 + - *596 - *17 - *19 responses: @@ -88718,7 +91353,7 @@ paths: application/json: schema: type: array - items: *491 + items: *490 examples: default: value: @@ -88756,9 +91391,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: + - *343 - *344 - - *345 - - *597 + - *596 responses: '204': description: Response if pull request has been merged @@ -88781,9 +91416,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: + - *343 - *344 - - *345 - - *597 + - *596 requestBody: required: false content: @@ -88894,9 +91529,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: + - *343 - *344 - - *345 - - *597 + - *596 responses: '200': description: Response @@ -88912,7 +91547,7 @@ paths: items: *4 teams: type: array - items: *198 + items: *197 required: - users - teams @@ -88971,9 +91606,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: + - *343 - *344 - - *345 - - *597 + - *596 requestBody: required: false content: @@ -89010,7 +91645,7 @@ paths: description: Response content: application/json: - schema: *482 + schema: *481 examples: default: value: @@ -89546,9 +92181,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: + - *343 - *344 - - *345 - - *597 + - *596 requestBody: required: true content: @@ -89582,7 +92217,7 @@ paths: description: Response content: application/json: - schema: *482 + schema: *481 examples: default: value: @@ -90087,9 +92722,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: + - *343 - *344 - - *345 - - *597 + - *596 - *17 - *19 responses: @@ -90099,7 +92734,7 @@ paths: application/json: schema: type: array - items: &600 + items: &599 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -90250,9 +92885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: + - *343 - *344 - - *345 - - *597 + - *596 requestBody: required: false content: @@ -90338,9 +92973,9 @@ paths: description: Response content: application/json: - schema: *600 + schema: *599 examples: - default: &602 + default: &601 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -90403,10 +93038,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: + - *343 - *344 - - *345 - - *597 - - &601 + - *596 + - &600 name: review_id description: The unique identifier of the review. in: path @@ -90418,9 +93053,9 @@ paths: description: Response content: application/json: - schema: *600 + schema: *599 examples: - default: &603 + default: &602 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -90479,10 +93114,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: + - *343 - *344 - - *345 - - *597 - - *601 + - *596 + - *600 requestBody: required: true content: @@ -90505,7 +93140,7 @@ paths: description: Response content: application/json: - schema: *600 + schema: *599 examples: default: value: @@ -90567,18 +93202,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: + - *343 - *344 - - *345 - - *597 - - *601 + - *596 + - *600 responses: '200': description: Response content: application/json: - schema: *600 + schema: *599 examples: - default: *602 + default: *601 '422': *7 '404': *6 x-github: @@ -90605,10 +93240,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: + - *343 - *344 - - *345 - - *597 - - *601 + - *596 + - *600 - *17 - *19 responses: @@ -90691,9 +93326,9 @@ paths: _links: type: object properties: - self: *282 - html: *282 - pull_request: *282 + self: *281 + html: *281 + pull_request: *281 required: - self - html @@ -90843,10 +93478,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: + - *343 - *344 - - *345 - - *597 - - *601 + - *596 + - *600 requestBody: required: true content: @@ -90874,7 +93509,7 @@ paths: description: Response content: application/json: - schema: *600 + schema: *599 examples: default: value: @@ -90937,10 +93572,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: + - *343 - *344 - - *345 - - *597 - - *601 + - *596 + - *600 requestBody: required: true content: @@ -90975,9 +93610,9 @@ paths: description: Response content: application/json: - schema: *600 + schema: *599 examples: - default: *603 + default: *602 '404': *6 '422': *7 '403': *29 @@ -90999,9 +93634,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: + - *343 - *344 - - *345 - - *597 + - *596 requestBody: required: false content: @@ -91064,8 +93699,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: + - *343 - *344 - - *345 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -91078,9 +93713,9 @@ paths: description: Response content: application/json: - schema: *604 + schema: *603 examples: - default: &605 + default: &604 value: type: file encoding: base64 @@ -91122,8 +93757,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: + - *343 - *344 - - *345 - name: dir description: The alternate path to look for a README file in: path @@ -91143,9 +93778,9 @@ paths: description: Response content: application/json: - schema: *604 + schema: *603 examples: - default: *605 + default: *604 '404': *6 '422': *15 x-github: @@ -91167,8 +93802,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -91178,7 +93813,7 @@ paths: application/json: schema: type: array - items: *606 + items: *605 examples: default: value: @@ -91272,8 +93907,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -91349,9 +93984,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *605 examples: - default: &610 + default: &609 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -91456,9 +94091,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: + - *343 - *344 - - *345 - - &608 + - &607 name: asset_id description: The unique identifier of the asset. in: path @@ -91470,9 +94105,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *606 examples: - default: &609 + default: &608 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 @@ -91507,7 +94142,7 @@ paths: type: User site_admin: false '404': *6 - '302': *493 + '302': *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91523,9 +94158,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: + - *343 - *344 - - *345 - - *608 + - *607 requestBody: required: false content: @@ -91553,9 +94188,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *606 examples: - default: *609 + default: *608 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91571,9 +94206,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: + - *343 - *344 - - *345 - - *608 + - *607 responses: '204': description: Response @@ -91598,8 +94233,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -91684,16 +94319,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: + - *343 - *344 - - *345 responses: '200': description: Response content: application/json: - schema: *606 + schema: *605 examples: - default: *610 + default: *609 '404': *6 x-github: githubCloudOnly: false @@ -91711,8 +94346,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: + - *343 - *344 - - *345 - name: tag description: tag parameter in: path @@ -91725,9 +94360,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *605 examples: - default: *610 + default: *609 '404': *6 x-github: githubCloudOnly: false @@ -91749,9 +94384,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: + - *343 - *344 - - *345 - - &611 + - &610 name: release_id description: The unique identifier of the release. in: path @@ -91765,9 +94400,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: *606 + schema: *605 examples: - default: *610 + default: *609 '401': description: Unauthorized x-github: @@ -91785,9 +94420,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: + - *343 - *344 - - *345 - - *611 + - *610 requestBody: required: false content: @@ -91851,9 +94486,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *605 examples: - default: *610 + default: *609 '404': description: Not Found if the discussion category name is invalid content: @@ -91874,9 +94509,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: + - *343 - *344 - - *345 - - *611 + - *610 responses: '204': description: Response @@ -91897,9 +94532,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: + - *343 - *344 - - *345 - - *611 + - *610 - *17 - *19 responses: @@ -91909,7 +94544,7 @@ paths: application/json: schema: type: array - items: *607 + items: *606 examples: default: value: @@ -91990,9 +94625,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: + - *343 - *344 - - *345 - - *611 + - *610 - name: name in: query required: true @@ -92018,7 +94653,7 @@ paths: description: Response for successful upload content: application/json: - schema: *607 + schema: *606 examples: response-for-successful-upload: value: @@ -92073,9 +94708,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: + - *343 - *344 - - *345 - - *611 + - *610 - 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. @@ -92099,9 +94734,9 @@ paths: application/json: schema: type: array - items: *476 + items: *475 examples: - default: *547 + default: *546 headers: Link: *67 '404': *6 @@ -92122,9 +94757,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: + - *343 - *344 - - *345 - - *611 + - *610 requestBody: required: true content: @@ -92154,16 +94789,16 @@ paths: description: Reaction exists content: application/json: - schema: *476 + schema: *475 examples: - default: *477 + default: *476 '201': description: Reaction created content: application/json: - schema: *476 + schema: *475 examples: - default: *477 + default: *476 '422': *15 x-github: githubCloudOnly: false @@ -92185,10 +94820,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: + - *343 - *344 - - *345 - - *611 - - *548 + - *610 + - *547 responses: '204': description: Response @@ -92212,9 +94847,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: + - *343 - *344 - - *345 - - *411 + - *410 - *17 - *19 responses: @@ -92230,8 +94865,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *305 - - &612 + - *304 + - &611 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -92250,69 +94885,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. + - allOf: + - *305 + - *611 - allOf: - *306 - - *612 + - *611 - allOf: - *307 - - *612 + - *611 - allOf: - - *308 - *612 + - *611 - allOf: - - *613 - - *612 + - *308 + - *611 - allOf: - *309 - - *612 + - *611 - allOf: - *310 - - *612 + - *611 - allOf: - *311 - - *612 + - *611 - allOf: - *312 - - *612 + - *611 - allOf: - *313 - - *612 + - *611 - allOf: - *314 - - *612 + - *611 - allOf: - *315 - - *612 + - *611 - allOf: - *316 - - *612 + - *611 - allOf: - *317 - - *612 + - *611 - allOf: - *318 - - *612 + - *611 - allOf: - *319 - - *612 + - *611 - allOf: - *320 - - *612 + - *611 - allOf: - *321 - - *612 + - *611 - allOf: - *322 - - *612 + - *611 - allOf: - *323 - - *612 + - *611 - allOf: - *324 - - *612 - - allOf: - - *325 - - *612 + - *611 examples: default: value: @@ -92351,8 +94986,8 @@ paths: category: repos subcategory: rules parameters: + - *343 - *344 - - *345 - *17 - *19 - name: includes_parents @@ -92363,7 +94998,7 @@ paths: schema: type: boolean default: true - - *614 + - *613 responses: '200': description: Response @@ -92371,7 +95006,7 @@ paths: application/json: schema: type: array - items: *326 + items: *325 examples: default: value: @@ -92418,8 +95053,8 @@ paths: category: repos subcategory: rules parameters: + - *343 - *344 - - *345 requestBody: description: Request body required: true @@ -92439,16 +95074,16 @@ paths: - tag - push default: branch - enforcement: *302 + enforcement: *301 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *303 - conditions: *300 + items: *302 + conditions: *299 rules: type: array description: An array of rules within the ruleset. - items: *615 + items: *614 required: - name - enforcement @@ -92479,9 +95114,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *325 examples: - default: &625 + default: &624 value: id: 42 name: super cool ruleset @@ -92529,12 +95164,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: + - *343 - *344 - - *345 + - *615 - *616 - *617 - *618 - - *619 - *17 - *19 responses: @@ -92542,9 +95177,9 @@ paths: description: Response content: application/json: - schema: *620 + schema: *619 examples: - default: *621 + default: *620 '404': *6 '500': *55 x-github: @@ -92565,17 +95200,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: + - *343 - *344 - - *345 - - *622 + - *621 responses: '200': description: Response content: application/json: - schema: *623 + schema: *622 examples: - default: *624 + default: *623 '404': *6 '500': *55 x-github: @@ -92603,8 +95238,8 @@ paths: category: repos subcategory: rules parameters: + - *343 - *344 - - *345 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92624,9 +95259,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *325 examples: - default: *625 + default: *624 '404': *6 '500': *55 put: @@ -92644,8 +95279,8 @@ paths: category: repos subcategory: rules parameters: + - *343 - *344 - - *345 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92670,16 +95305,16 @@ paths: - branch - tag - push - enforcement: *302 + enforcement: *301 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *303 - conditions: *300 + items: *302 + conditions: *299 rules: description: An array of rules within the ruleset. type: array - items: *615 + items: *614 examples: default: value: @@ -92707,9 +95342,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *325 examples: - default: *625 + default: *624 '404': *6 '422': *15 '500': *55 @@ -92728,8 +95363,8 @@ paths: category: repos subcategory: rules parameters: + - *343 - *344 - - *345 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92752,8 +95387,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: + - *343 - *344 - - *345 - *17 - *19 - name: ruleset_id @@ -92769,9 +95404,9 @@ paths: application/json: schema: type: array - items: *329 + items: *328 examples: - default: *626 + default: *625 '404': *6 '500': *55 x-github: @@ -92790,8 +95425,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: + - *343 - *344 - - *345 - name: ruleset_id description: The ID of the ruleset. in: path @@ -92809,7 +95444,7 @@ paths: description: Response content: application/json: - schema: *627 + schema: *626 examples: default: value: @@ -92864,22 +95499,22 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: + - *343 - *344 - - *345 + - *627 - *628 - *629 - *630 - *631 - - *632 - *61 - *19 - *17 + - *632 - *633 - *634 - *635 - *636 - *637 - - *638 responses: '200': description: Response @@ -92887,11 +95522,11 @@ paths: application/json: schema: type: array - items: &642 + items: &641 type: object properties: - number: *179 - created_at: *180 + number: *178 + created_at: *179 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -92899,15 +95534,15 @@ paths: format: date-time readOnly: true nullable: true - url: *182 - html_url: *183 + url: *181 + html_url: *182 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *639 - resolution: *640 + state: *638 + resolution: *639 resolved_at: type: string format: date-time @@ -93003,7 +95638,7 @@ paths: pull request. ' - oneOf: *641 + oneOf: *640 nullable: true has_more_locations: type: boolean @@ -93152,16 +95787,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: + - *343 - *344 - - *345 - - *442 - - *638 + - *441 + - *637 responses: '200': description: Response content: application/json: - schema: *642 + schema: *641 examples: default: value: @@ -93215,9 +95850,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: + - *343 - *344 - - *345 - - *442 + - *441 requestBody: required: true content: @@ -93225,8 +95860,8 @@ paths: schema: type: object properties: - state: *639 - resolution: *640 + state: *638 + resolution: *639 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -93262,7 +95897,7 @@ paths: description: Response content: application/json: - schema: *642 + schema: *641 examples: default: value: @@ -93357,9 +95992,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: + - *343 - *344 - - *345 - - *442 + - *441 - *19 - *17 responses: @@ -93370,7 +96005,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &801 + items: &800 type: object properties: type: @@ -93396,6 +96031,7 @@ paths: example: commit details: oneOf: + - *642 - *643 - *644 - *645 @@ -93408,7 +96044,6 @@ paths: - *652 - *653 - *654 - - *655 examples: default: value: @@ -93494,8 +96129,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -93503,14 +96138,14 @@ paths: schema: type: object properties: - reason: &657 + reason: &656 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *656 + placeholder_id: *655 required: - reason - placeholder_id @@ -93527,7 +96162,7 @@ paths: schema: type: object properties: - reason: *657 + reason: *656 expire_at: type: string format: date-time @@ -93573,8 +96208,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: + - *343 - *344 - - *345 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -93589,7 +96224,7 @@ paths: properties: incremental_scans: type: array - items: &658 + items: &657 description: Information on a single scan performed by secret scanning on the repository type: object @@ -93615,15 +96250,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *658 + items: *657 backfill_scans: type: array - items: *658 + items: *657 custom_pattern_backfill_scans: type: array items: allOf: - - *658 + - *657 - type: object properties: pattern_name: @@ -93693,8 +96328,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: + - *343 - *344 - - *345 - *61 - name: sort description: The property to sort the results by. @@ -93738,9 +96373,9 @@ paths: application/json: schema: type: array - items: *659 + items: *658 examples: - default: *660 + default: *659 '400': *14 '404': *6 x-github: @@ -93763,8 +96398,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -93837,7 +96472,7 @@ paths: login: type: string description: The username of the user credited. - type: *332 + type: *331 required: - login - type @@ -93924,9 +96559,9 @@ paths: description: Response content: application/json: - schema: *659 + schema: *658 examples: - default: &662 + default: &661 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -94159,8 +96794,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -94264,7 +96899,7 @@ paths: description: Response content: application/json: - schema: *659 + schema: *658 examples: default: value: @@ -94411,17 +97046,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: + - *343 - *344 - - *345 - - *661 + - *660 responses: '200': description: Response content: application/json: - schema: *659 + schema: *658 examples: - default: *662 + default: *661 '403': *29 '404': *6 x-github: @@ -94445,9 +97080,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: + - *343 - *344 - - *345 - - *661 + - *660 requestBody: required: true content: @@ -94520,7 +97155,7 @@ paths: login: type: string description: The username of the user credited. - type: *332 + type: *331 required: - login - type @@ -94606,10 +97241,10 @@ paths: description: Response content: application/json: - schema: *659 + schema: *658 examples: - default: *662 - add_credit: *662 + default: *661 + add_credit: *661 '403': *29 '404': *6 '422': @@ -94647,9 +97282,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: + - *343 - *344 - - *345 - - *661 + - *660 responses: '202': *39 '400': *14 @@ -94676,17 +97311,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: + - *343 - *344 - - *345 - - *661 + - *660 responses: '202': description: Response content: application/json: - schema: *347 + schema: *346 examples: - default: *349 + default: *348 '400': *14 '422': *15 '403': *29 @@ -94712,8 +97347,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -94812,8 +97447,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: + - *343 - *344 - - *345 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -94822,7 +97457,7 @@ paths: application/json: schema: type: array - items: &663 + items: &662 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -94835,7 +97470,7 @@ paths: - 1124 - -435 '202': *39 - '204': *192 + '204': *191 '422': description: Repository contains more than 10,000 commits x-github: @@ -94855,8 +97490,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: + - *343 - *344 - - *345 responses: '200': description: Response @@ -94905,7 +97540,7 @@ paths: total: 89 week: 1336280400 '202': *39 - '204': *192 + '204': *191 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94932,8 +97567,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: + - *343 - *344 - - *345 responses: '200': description: Response @@ -95007,7 +97642,7 @@ paths: d: 77 c: 10 '202': *39 - '204': *192 + '204': *191 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95029,8 +97664,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: + - *343 - *344 - - *345 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -95184,8 +97819,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: + - *343 - *344 - - *345 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -95195,7 +97830,7 @@ paths: application/json: schema: type: array - items: *663 + items: *662 examples: default: value: @@ -95208,7 +97843,7 @@ paths: - - 0 - 2 - 21 - '204': *192 + '204': *191 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95228,8 +97863,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: + - *343 - *344 - - *345 - name: sha in: path required: true @@ -95283,7 +97918,7 @@ paths: description: Response content: application/json: - schema: *664 + schema: *663 examples: default: value: @@ -95337,8 +97972,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -95370,14 +98005,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: + - *343 - *344 - - *345 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &665 + schema: &664 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -95445,8 +98080,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: + - *343 - *344 - - *345 requestBody: required: false content: @@ -95472,7 +98107,7 @@ paths: description: Response content: application/json: - schema: *665 + schema: *664 examples: default: value: @@ -95499,8 +98134,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: + - *343 - *344 - - *345 responses: '204': description: Response @@ -95520,8 +98155,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -95600,8 +98235,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: + - *343 - *344 - - *345 - name: ref in: path required: true @@ -95637,8 +98272,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: + - *343 - *344 - - *345 - *17 - *19 responses: @@ -95648,9 +98283,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - default: *260 + default: *259 headers: Link: *67 '404': *6 @@ -95670,8 +98305,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: + - *343 - *344 - - *345 - *19 - *17 responses: @@ -95679,7 +98314,7 @@ paths: description: Response content: application/json: - schema: &666 + schema: &665 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -95691,7 +98326,7 @@ paths: required: - names examples: - default: &667 + default: &666 value: names: - octocat @@ -95714,8 +98349,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -95746,9 +98381,9 @@ paths: description: Response content: application/json: - schema: *666 + schema: *665 examples: - default: *667 + default: *666 '404': *6 '422': *7 x-github: @@ -95769,9 +98404,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: + - *343 - *344 - - *345 - - &668 + - &667 name: per description: The time frame to display results for. in: query @@ -95800,7 +98435,7 @@ paths: example: 128 clones: type: array - items: &669 + items: &668 title: Traffic type: object properties: @@ -95887,8 +98522,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: + - *343 - *344 - - *345 responses: '200': description: Response @@ -95978,8 +98613,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: + - *343 - *344 - - *345 responses: '200': description: Response @@ -96039,9 +98674,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: + - *343 - *344 - - *345 - - *668 + - *667 responses: '200': description: Response @@ -96060,7 +98695,7 @@ paths: example: 3782 views: type: array - items: *669 + items: *668 required: - uniques - count @@ -96137,8 +98772,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: + - *343 - *344 - - *345 requestBody: required: true content: @@ -96174,7 +98809,7 @@ paths: description: Response content: application/json: - schema: *161 + schema: *160 examples: default: value: @@ -96412,8 +99047,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: + - *343 - *344 - - *345 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -96436,8 +99071,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: + - *343 - *344 - - *345 responses: '204': description: Response @@ -96459,8 +99094,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: + - *343 - *344 - - *345 responses: '204': description: Response @@ -96486,8 +99121,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: + - *343 - *344 - - *345 - name: ref in: path required: true @@ -96579,9 +99214,9 @@ paths: description: Response content: application/json: - schema: *347 + schema: *346 examples: - default: *349 + default: *348 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -96622,7 +99257,7 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: default: value: @@ -96728,8 +99363,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *150 - - *554 + - *149 + - *553 requestBody: required: true content: @@ -96793,9 +99428,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *557 + items: *556 examples: - default: *670 + default: *669 '400': *14 '403': *29 '404': *6 @@ -96831,8 +99466,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *150 - - *554 + - *149 + - *553 requestBody: required: true content: @@ -96897,9 +99532,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *557 + items: *556 examples: - default: *670 + default: *669 '400': *14 '403': *29 '404': *6 @@ -96930,9 +99565,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: - - *150 - - *554 - - *242 + - *149 + - *553 + - *241 responses: '204': description: Issue field value deleted successfully @@ -97053,7 +99688,7 @@ paths: html_url: type: string format: uri - repository: *161 + repository: *160 score: type: number file_size: @@ -97071,7 +99706,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &671 + text_matches: &670 title: Search Result Text Matches type: array items: @@ -97233,7 +99868,7 @@ paths: enum: - author-date - committer-date - - &672 + - &671 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 @@ -97304,7 +99939,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *409 + properties: *408 nullable: true comment_count: type: integer @@ -97324,7 +99959,7 @@ paths: url: type: string format: uri - verification: *530 + verification: *529 required: - author - committer @@ -97343,7 +99978,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *409 + properties: *408 nullable: true parents: type: array @@ -97356,12 +99991,12 @@ paths: type: string sha: type: string - repository: *161 + repository: *160 score: type: number node_id: type: string - text_matches: *671 + text_matches: *670 required: - sha - node_id @@ -97553,7 +100188,7 @@ paths: - interactions - created - updated - - *672 + - *671 - *17 - *19 - name: advanced_search @@ -97667,11 +100302,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 issue_field_values: type: array - items: *557 + items: *556 state: type: string state_reason: @@ -97688,8 +100323,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *280 - required: *281 + properties: *279 + required: *280 nullable: true comments: type: integer @@ -97703,7 +100338,7 @@ paths: type: string format: date-time nullable: true - text_matches: *671 + text_matches: *670 pull_request: type: object properties: @@ -97747,7 +100382,7 @@ paths: timeline_url: type: string format: uri - type: *243 + type: *242 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -98003,7 +100638,7 @@ paths: enum: - created - updated - - *672 + - *671 - *17 - *19 responses: @@ -98047,7 +100682,7 @@ paths: nullable: true score: type: number - text_matches: *671 + text_matches: *670 required: - id - node_id @@ -98132,7 +100767,7 @@ paths: - forks - help-wanted-issues - updated - - *672 + - *671 - *17 - *19 responses: @@ -98380,7 +101015,7 @@ paths: - admin - pull - push - text_matches: *671 + text_matches: *670 temp_clone_token: type: string allow_merge_commit: @@ -98680,7 +101315,7 @@ paths: type: string format: uri nullable: true - text_matches: *671 + text_matches: *670 related: type: array nullable: true @@ -98871,7 +101506,7 @@ paths: - followers - repositories - joined - - *672 + - *671 - *17 - *19 responses: @@ -98975,7 +101610,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *671 + text_matches: *670 blog: type: string nullable: true @@ -99054,7 +101689,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &675 + - &674 name: team_id description: The unique identifier of the team. in: path @@ -99066,9 +101701,9 @@ paths: description: Response content: application/json: - schema: *340 + schema: *339 examples: - default: *341 + default: *340 '404': *6 x-github: githubCloudOnly: false @@ -99095,7 +101730,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *675 + - *674 requestBody: required: true content: @@ -99158,16 +101793,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *340 + schema: *339 examples: - default: *341 + default: *340 '201': description: Response content: application/json: - schema: *340 + schema: *339 examples: - default: *341 + default: *340 '404': *6 '422': *15 '403': *29 @@ -99195,7 +101830,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *675 + - *674 responses: '204': description: Response @@ -99224,7 +101859,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *675 + - *674 - *17 - *19 responses: @@ -99234,9 +101869,9 @@ paths: application/json: schema: type: array - items: *237 + items: *236 examples: - default: *238 + default: *237 headers: Link: *67 x-github: @@ -99262,7 +101897,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *675 + - *674 - name: role description: Filters members returned by their role in the team. in: query @@ -99313,7 +101948,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *675 + - *674 - *71 responses: '204': @@ -99350,7 +101985,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *675 + - *674 - *71 responses: '204': @@ -99390,7 +102025,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *675 + - *674 - *71 responses: '204': @@ -99427,16 +102062,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *675 + - *674 - *71 responses: '200': description: Response content: application/json: - schema: *343 + schema: *342 examples: - response-if-user-is-a-team-maintainer: *676 + response-if-user-is-a-team-maintainer: *675 '404': *6 x-github: githubCloudOnly: false @@ -99469,7 +102104,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *675 + - *674 - *71 requestBody: required: false @@ -99495,9 +102130,9 @@ paths: description: Response content: application/json: - schema: *343 + schema: *342 examples: - response-if-users-membership-with-team-is-now-pending: *677 + response-if-users-membership-with-team-is-now-pending: *676 '403': description: Forbidden if team synchronization is set up '422': @@ -99531,7 +102166,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *675 + - *674 - *71 responses: '204': @@ -99559,7 +102194,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *675 + - *674 - *17 - *19 responses: @@ -99569,9 +102204,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *267 + default: *266 headers: Link: *67 '404': *6 @@ -99601,15 +102236,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *675 + - *674 + - *343 - *344 - - *345 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *678 + schema: *677 examples: alternative-response-with-extra-repository-information: value: @@ -99760,9 +102395,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *675 + - *674 + - *343 - *344 - - *345 requestBody: required: false content: @@ -99812,9 +102447,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *675 + - *674 + - *343 - *344 - - *345 responses: '204': description: Response @@ -99839,7 +102474,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *675 + - *674 - *17 - *19 responses: @@ -99849,9 +102484,9 @@ paths: application/json: schema: type: array - items: *198 + items: *197 examples: - response-if-child-teams-exist: *679 + response-if-child-teams-exist: *678 headers: Link: *67 '404': *6 @@ -99884,7 +102519,7 @@ paths: application/json: schema: oneOf: - - &681 + - &680 title: Private User description: Private User type: object @@ -100087,7 +102722,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *680 + - *679 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -100240,7 +102875,7 @@ paths: description: Response content: application/json: - schema: *681 + schema: *680 examples: default: value: @@ -100443,9 +103078,9 @@ paths: type: integer codespaces: type: array - items: *248 + items: *247 examples: - default: *249 + default: *248 '304': *37 '500': *55 '401': *25 @@ -100584,17 +103219,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *248 + schema: *247 examples: - default: *465 + default: *464 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *248 + schema: *247 examples: - default: *465 + default: *464 '401': *25 '403': *29 '404': *6 @@ -100638,7 +103273,7 @@ paths: type: integer secrets: type: array - items: &682 + items: &681 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -100678,7 +103313,7 @@ paths: - visibility - selected_repositories_url examples: - default: *468 + default: *467 headers: Link: *67 x-github: @@ -100748,13 +103383,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *169 + - *168 responses: '200': description: Response content: application/json: - schema: *682 + schema: *681 examples: default: value: @@ -100784,7 +103419,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *169 + - *168 requestBody: required: true content: @@ -100829,7 +103464,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -100857,7 +103492,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *169 + - *168 responses: '204': description: Response @@ -100882,7 +103517,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *169 + - *168 responses: '200': description: Response @@ -100898,9 +103533,9 @@ paths: type: integer repositories: type: array - items: *161 + items: *160 examples: - default: *199 + default: *198 '401': *25 '403': *29 '404': *6 @@ -100925,7 +103560,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *169 + - *168 requestBody: required: true content: @@ -100979,7 +103614,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *169 + - *168 - name: repository_id in: path required: true @@ -101012,7 +103647,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *169 + - *168 - name: repository_id in: path required: true @@ -101044,15 +103679,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *250 + - *249 responses: '200': description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *465 + default: *464 '304': *37 '500': *55 '401': *25 @@ -101078,7 +103713,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *250 + - *249 requestBody: required: false content: @@ -101108,9 +103743,9 @@ paths: description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *465 + default: *464 '401': *25 '403': *29 '404': *6 @@ -101132,7 +103767,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *250 + - *249 responses: '202': *39 '304': *37 @@ -101161,13 +103796,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *250 + - *249 responses: '202': description: Response content: application/json: - schema: &683 + schema: &682 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -101208,7 +103843,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &684 + default: &683 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -101240,7 +103875,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *250 + - *249 - name: export_id in: path required: true @@ -101253,9 +103888,9 @@ paths: description: Response content: application/json: - schema: *683 + schema: *682 examples: - default: *684 + default: *683 '404': *6 x-github: githubCloudOnly: false @@ -101276,7 +103911,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *250 + - *249 responses: '200': description: Response @@ -101292,9 +103927,9 @@ paths: type: integer machines: type: array - items: *685 + items: *684 examples: - default: *686 + default: *685 '304': *37 '500': *55 '401': *25 @@ -101323,7 +103958,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *250 + - *249 requestBody: required: true content: @@ -101373,13 +104008,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *347 + repository: *346 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *466 - required: *467 + properties: *465 + required: *466 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -102153,15 +104788,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *250 + - *249 responses: '200': description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *465 + default: *464 '304': *37 '500': *55 '400': *14 @@ -102193,15 +104828,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *250 + - *249 responses: '200': description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *465 + default: *464 '500': *55 '401': *25 '403': *29 @@ -102231,9 +104866,9 @@ paths: application/json: schema: type: array - items: *261 + items: *260 examples: - default: &697 + default: &696 value: - id: 197 name: hello_docker @@ -102334,7 +104969,7 @@ paths: application/json: schema: type: array - items: &687 + items: &686 title: Email description: Email type: object @@ -102399,9 +105034,9 @@ paths: application/json: schema: type: array - items: *687 + items: *686 examples: - default: &699 + default: &698 value: - email: octocat@github.com verified: true @@ -102476,7 +105111,7 @@ paths: application/json: schema: type: array - items: *687 + items: *686 examples: default: value: @@ -102732,7 +105367,7 @@ paths: application/json: schema: type: array - items: &688 + items: &687 title: GPG Key description: A unique encryption key type: object @@ -102863,7 +105498,7 @@ paths: - subkeys - revoked examples: - default: &715 + default: &714 value: - id: 3 name: Octocat's GPG Key @@ -102948,9 +105583,9 @@ paths: description: Response content: application/json: - schema: *688 + schema: *687 examples: - default: &689 + default: &688 value: id: 3 name: Octocat's GPG Key @@ -103007,7 +105642,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &690 + - &689 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -103019,9 +105654,9 @@ paths: description: Response content: application/json: - schema: *688 + schema: *687 examples: - default: *689 + default: *688 '404': *6 '304': *37 '403': *29 @@ -103044,7 +105679,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *690 + - *689 responses: '204': description: Response @@ -103237,7 +105872,7 @@ paths: allOf: - *79 examples: - default: *153 + default: *152 headers: Link: *67 '404': *6 @@ -103263,7 +105898,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *150 + - *149 responses: '204': description: Response @@ -103289,7 +105924,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *150 + - *149 responses: '204': description: Response @@ -103323,12 +105958,12 @@ paths: application/json: schema: anyOf: - - *235 + - *234 - type: object properties: {} additionalProperties: false examples: - default: *236 + default: *235 '204': description: Response when there are no restrictions x-github: @@ -103352,7 +105987,7 @@ paths: required: true content: application/json: - schema: *541 + schema: *540 examples: default: value: @@ -103363,7 +105998,7 @@ paths: description: Response content: application/json: - schema: *235 + schema: *234 examples: default: value: @@ -103444,7 +106079,7 @@ paths: - closed - all default: open - - *246 + - *245 - name: sort description: What to sort results by. in: query @@ -103469,7 +106104,7 @@ paths: type: array items: *85 examples: - default: *247 + default: *246 headers: Link: *67 '404': *6 @@ -103502,7 +106137,7 @@ paths: application/json: schema: type: array - items: &691 + items: &690 title: Key description: Key type: object @@ -103603,9 +106238,9 @@ paths: description: Response content: application/json: - schema: *691 + schema: *690 examples: - default: &692 + default: &691 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -103638,15 +106273,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *576 + - *575 responses: '200': description: Response content: application/json: - schema: *691 + schema: *690 examples: - default: *692 + default: *691 '404': *6 '304': *37 '403': *29 @@ -103669,7 +106304,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *576 + - *575 responses: '204': description: Response @@ -103702,7 +106337,7 @@ paths: application/json: schema: type: array - items: &693 + items: &692 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -103770,7 +106405,7 @@ paths: - account - plan examples: - default: &694 + default: &693 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -103832,9 +106467,9 @@ paths: application/json: schema: type: array - items: *693 + items: *692 examples: - default: *694 + default: *693 headers: Link: *67 '304': *37 @@ -103874,7 +106509,7 @@ paths: application/json: schema: type: array - items: *252 + items: *251 examples: default: value: @@ -103988,7 +106623,7 @@ paths: description: Response content: application/json: - schema: *252 + schema: *251 examples: default: value: @@ -104075,7 +106710,7 @@ paths: description: Response content: application/json: - schema: *252 + schema: *251 examples: default: value: @@ -104147,7 +106782,7 @@ paths: application/json: schema: type: array - items: *254 + items: *253 examples: default: value: @@ -104400,7 +107035,7 @@ paths: description: Response content: application/json: - schema: *254 + schema: *253 examples: default: value: @@ -104580,7 +107215,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *255 + - *254 - name: exclude in: query required: false @@ -104593,7 +107228,7 @@ paths: description: Response content: application/json: - schema: *254 + schema: *253 examples: default: value: @@ -104787,7 +107422,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *255 + - *254 responses: '302': description: Response @@ -104813,7 +107448,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *255 + - *254 responses: '204': description: Response @@ -104842,8 +107477,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *255 - - *695 + - *254 + - *694 responses: '204': description: Response @@ -104867,7 +107502,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *255 + - *254 - *17 - *19 responses: @@ -104877,9 +107512,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *267 + default: *266 headers: Link: *67 '404': *6 @@ -104976,7 +107611,7 @@ paths: - docker - nuget - container - - *696 + - *695 - *19 - *17 responses: @@ -104986,10 +107621,10 @@ paths: application/json: schema: type: array - items: *261 + items: *260 examples: - default: *697 - '400': *698 + default: *696 + '400': *697 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105009,16 +107644,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: + - *262 - *263 - - *264 responses: '200': description: Response content: application/json: - schema: *261 + schema: *260 examples: - default: &716 + default: &715 value: id: 40201 name: octo-name @@ -105131,8 +107766,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: + - *262 - *263 - - *264 responses: '204': description: Response @@ -105162,8 +107797,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: + - *262 - *263 - - *264 - name: token description: package token schema: @@ -105195,8 +107830,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: + - *262 - *263 - - *264 - *19 - *17 - name: state @@ -105216,7 +107851,7 @@ paths: application/json: schema: type: array - items: *265 + items: *264 examples: default: value: @@ -105265,15 +107900,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: + - *262 - *263 - - *264 - - *266 + - *265 responses: '200': description: Response content: application/json: - schema: *265 + schema: *264 examples: default: value: @@ -105309,9 +107944,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: + - *262 - *263 - - *264 - - *266 + - *265 responses: '204': description: Response @@ -105341,9 +107976,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: + - *262 - *263 - - *264 - - *266 + - *265 responses: '204': description: Response @@ -105380,9 +108015,9 @@ paths: application/json: schema: type: array - items: *687 + items: *686 examples: - default: *699 + default: *698 headers: Link: *67 '304': *37 @@ -105495,7 +108130,7 @@ paths: type: array items: *79 examples: - default: &706 + default: &705 summary: Default response value: - id: 1296269 @@ -105799,9 +108434,9 @@ paths: description: Response content: application/json: - schema: *347 + schema: *346 examples: - default: *349 + default: *348 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -105845,9 +108480,9 @@ paths: application/json: schema: type: array - items: *543 + items: *542 examples: - default: *700 + default: *699 headers: Link: *67 '304': *37 @@ -105870,7 +108505,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *239 + - *238 responses: '204': description: Response @@ -105899,7 +108534,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *239 + - *238 responses: '204': description: Response @@ -105932,7 +108567,7 @@ paths: application/json: schema: type: array - items: &701 + items: &700 title: Social account description: Social media account type: object @@ -105947,7 +108582,7 @@ paths: - provider - url examples: - default: &702 + default: &701 value: - provider: twitter url: https://twitter.com/github @@ -106009,9 +108644,9 @@ paths: application/json: schema: type: array - items: *701 + items: *700 examples: - default: *702 + default: *701 '422': *15 '304': *37 '404': *6 @@ -106098,7 +108733,7 @@ paths: application/json: schema: type: array - items: &703 + items: &702 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -106118,7 +108753,7 @@ paths: - title - created_at examples: - default: &734 + default: &733 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -106182,9 +108817,9 @@ paths: description: Response content: application/json: - schema: *703 + schema: *702 examples: - default: &704 + default: &703 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -106214,7 +108849,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: - - &705 + - &704 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -106226,9 +108861,9 @@ paths: description: Response content: application/json: - schema: *703 + schema: *702 examples: - default: *704 + default: *703 '404': *6 '304': *37 '403': *29 @@ -106251,7 +108886,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: - - *705 + - *704 responses: '204': description: Response @@ -106280,7 +108915,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &735 + - &734 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 @@ -106305,11 +108940,11 @@ paths: type: array items: *79 examples: - default-response: *706 + default-response: *705 application/vnd.github.v3.star+json: schema: type: array - items: &736 + items: &735 title: Starred Repository description: Starred Repository type: object @@ -106465,8 +109100,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: + - *343 - *344 - - *345 responses: '204': description: Response if this repository is starred by you @@ -106494,8 +109129,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: + - *343 - *344 - - *345 responses: '204': description: Response @@ -106519,8 +109154,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: + - *343 - *344 - - *345 responses: '204': description: Response @@ -106553,9 +109188,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *267 + default: *266 headers: Link: *67 '304': *37 @@ -106592,7 +109227,7 @@ paths: application/json: schema: type: array - items: *340 + items: *339 examples: default: value: @@ -106678,10 +109313,10 @@ paths: application/json: schema: oneOf: - - *681 - *680 + - *679 examples: - default-response: &710 + default-response: &709 summary: Default response value: login: octocat @@ -106716,7 +109351,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &711 + response-with-git-hub-plan-information: &710 summary: Response with GitHub plan information value: login: octocat @@ -106773,14 +109408,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &708 + - &707 name: user_id description: The unique identifier of the user. in: path required: true schema: type: string - - *279 + - *278 requestBody: required: true description: Details of the draft item to create in the project. @@ -106814,9 +109449,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *284 examples: - draft_issue: *286 + draft_issue: *285 '304': *37 '403': *29 '401': *25 @@ -106839,7 +109474,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *707 + - *706 - *17 responses: '200': @@ -106874,8 +109509,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *708 - - *279 + - *707 + - *278 requestBody: required: true content: @@ -106946,17 +109581,17 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *709 + schema: *708 examples: table_view: summary: Response for creating a table view - value: *290 + value: *289 board_view: summary: Response for creating a board view with filter - value: *290 + value: *289 roadmap_view: summary: Response for creating a roadmap view - value: *290 + value: *289 '304': *37 '403': *29 '401': *25 @@ -106998,11 +109633,11 @@ paths: application/json: schema: oneOf: - - *681 - *680 + - *679 examples: - default-response: *710 - response-with-git-hub-plan-information: *711 + default-response: *709 + response-with-git-hub-plan-information: *710 '404': *6 x-github: githubCloudOnly: false @@ -107052,8 +109687,8 @@ paths: required: - subject_digests examples: - default: *712 - withPredicateType: *713 + default: *711 + withPredicateType: *712 responses: '200': description: Response @@ -107106,7 +109741,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *714 + default: *713 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107326,12 +109961,12 @@ paths: initiator: type: string examples: - default: *405 + default: *404 '201': description: Response content: application/json: - schema: *170 + schema: *169 examples: default: value: @@ -107379,9 +110014,9 @@ paths: application/json: schema: type: array - items: *261 + items: *260 examples: - default: *697 + default: *696 '403': *29 '401': *25 x-github: @@ -107765,9 +110400,9 @@ paths: application/json: schema: type: array - items: *688 + items: *687 examples: - default: *715 + default: *714 headers: Link: *67 x-github: @@ -107871,7 +110506,7 @@ paths: application/json: schema: *22 examples: - default: *540 + default: *539 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107995,7 +110630,7 @@ paths: - docker - nuget - container - - *696 + - *695 - *71 - *19 - *17 @@ -108006,12 +110641,12 @@ paths: application/json: schema: type: array - items: *261 + items: *260 examples: - default: *697 + default: *696 '403': *29 '401': *25 - '400': *698 + '400': *697 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108031,17 +110666,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: + - *262 - *263 - - *264 - *71 responses: '200': description: Response content: application/json: - schema: *261 + schema: *260 examples: - default: *716 + default: *715 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108062,8 +110697,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: + - *262 - *263 - - *264 - *71 responses: '204': @@ -108096,8 +110731,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: + - *262 - *263 - - *264 - *71 - name: token description: package token @@ -108130,8 +110765,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: + - *262 - *263 - - *264 - *71 responses: '200': @@ -108140,7 +110775,7 @@ paths: application/json: schema: type: array - items: *265 + items: *264 examples: default: value: @@ -108198,16 +110833,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: + - *262 - *263 - - *264 - - *266 + - *265 - *71 responses: '200': description: Response content: application/json: - schema: *265 + schema: *264 examples: default: value: @@ -108242,10 +110877,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: + - *262 - *263 - - *264 - *71 - - *266 + - *265 responses: '204': description: Response @@ -108277,10 +110912,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: + - *262 - *263 - - *264 - *71 - - *266 + - *265 responses: '204': description: Response @@ -108321,9 +110956,9 @@ paths: application/json: schema: type: array - items: *277 + items: *276 examples: - default: *278 + default: *277 headers: Link: *67 '304': *37 @@ -108345,16 +110980,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *279 + - *278 - *71 responses: '200': description: Response content: application/json: - schema: *277 + schema: *276 examples: - default: *278 + default: *277 headers: Link: *67 '304': *37 @@ -108376,7 +111011,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *279 + - *278 - *71 - *17 - *47 @@ -108388,9 +111023,9 @@ paths: application/json: schema: type: array - items: *283 + items: *282 examples: - default: *717 + default: *716 headers: Link: *67 '304': *37 @@ -108412,7 +111047,7 @@ paths: url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project parameters: - *71 - - *279 + - *278 requestBody: required: true content: @@ -108450,7 +111085,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *718 + items: *717 required: - name - data_type @@ -108466,7 +111101,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *719 + iteration_configuration: *718 required: - name - data_type @@ -108488,20 +111123,20 @@ paths: value: name: Due date data_type: date - single_select_field: *720 - iteration_field: *721 + single_select_field: *719 + iteration_field: *720 responses: '201': description: Response content: application/json: - schema: *283 + schema: *282 examples: - text_field: *722 - number_field: *723 - date_field: *724 - single_select_field: *725 - iteration_field: *726 + text_field: *721 + number_field: *722 + date_field: *723 + single_select_field: *724 + iteration_field: *725 '304': *37 '403': *29 '401': *25 @@ -108522,17 +111157,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *279 - - *727 + - *278 + - *726 - *71 responses: '200': description: Response content: application/json: - schema: *283 + schema: *282 examples: - default: *728 + default: *727 headers: Link: *67 '304': *37 @@ -108555,7 +111190,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *279 + - *278 - *71 - *47 - *48 @@ -108588,9 +111223,9 @@ paths: application/json: schema: type: array - items: *287 + items: *286 examples: - default: *288 + default: *287 headers: Link: *67 '304': *37 @@ -108612,7 +111247,7 @@ paths: url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - *71 - - *279 + - *278 requestBody: required: true description: Details of the item to add to the project. You can specify either @@ -108682,22 +111317,22 @@ paths: description: Response content: application/json: - schema: *285 + schema: *284 examples: issue_with_id: summary: Response for adding an issue using its unique ID - value: *286 + value: *285 pull_request_with_id: summary: Response for adding a pull request using its unique ID - value: *286 + value: *285 issue_with_nwo: summary: Response for adding an issue using repository owner, name, and issue number - value: *286 + value: *285 pull_request_with_nwo: summary: Response for adding a pull request using repository owner, name, and PR number - value: *286 + value: *285 '304': *37 '403': *29 '401': *25 @@ -108717,9 +111352,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *279 + - *278 - *71 - - *289 + - *288 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -108739,9 +111374,9 @@ paths: description: Response content: application/json: - schema: *287 + schema: *286 examples: - default: *288 + default: *287 headers: Link: *67 '304': *37 @@ -108762,9 +111397,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *279 + - *278 - *71 - - *289 + - *288 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -108834,13 +111469,13 @@ paths: description: Response content: application/json: - schema: *287 + schema: *286 examples: - text_field: *288 - number_field: *288 - date_field: *288 - single_select_field: *288 - iteration_field: *288 + text_field: *287 + number_field: *287 + date_field: *287 + single_select_field: *287 + iteration_field: *287 '401': *25 '403': *29 '404': *6 @@ -108860,9 +111495,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *279 + - *278 - *71 - - *289 + - *288 responses: '204': description: Response @@ -108884,9 +111519,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-project-view parameters: - - *279 + - *278 - *71 - - *729 + - *728 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -108912,9 +111547,9 @@ paths: application/json: schema: type: array - items: *287 + items: *286 examples: - default: *288 + default: *287 headers: Link: *67 '304': *37 @@ -109133,9 +111768,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *267 + default: *266 headers: Link: *67 x-github: @@ -109161,7 +111796,7 @@ paths: - *123 - *125 - *124 - - *730 + - *729 - *126 responses: '200': @@ -109292,7 +111927,7 @@ paths: parameters: - *71 - *123 - - *731 + - *730 - *124 responses: '200': @@ -109391,9 +112026,9 @@ paths: - *123 - *125 - *124 - - *732 + - *731 - *126 - - *733 + - *732 responses: '200': description: Response when getting a billing usage summary @@ -109527,9 +112162,9 @@ paths: application/json: schema: type: array - items: *701 + items: *700 examples: - default: *702 + default: *701 headers: Link: *67 x-github: @@ -109559,9 +112194,9 @@ paths: application/json: schema: type: array - items: *703 + items: *702 examples: - default: *734 + default: *733 headers: Link: *67 x-github: @@ -109586,7 +112221,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *71 - - *735 + - *734 - *61 - *17 - *19 @@ -109598,11 +112233,11 @@ paths: schema: anyOf: - type: array - items: *736 + items: *735 - type: array items: *79 examples: - default-response: *706 + default-response: *705 headers: Link: *67 x-github: @@ -109631,9 +112266,9 @@ paths: application/json: schema: type: array - items: *161 + items: *160 examples: - default: *267 + default: *266 headers: Link: *67 x-github: @@ -109761,7 +112396,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &737 + enterprise: &736 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -109819,7 +112454,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &738 + installation: &737 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -109838,7 +112473,7 @@ x-webhooks: required: - id - node_id - organization: &739 + organization: &738 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -109898,13 +112533,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &740 + repository: &739 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &772 + properties: &771 id: description: Unique identifier of the repository example: 42 @@ -110599,7 +113234,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &773 + required: &772 - archive_url - assignees_url - blobs_url @@ -110673,7 +113308,7 @@ x-webhooks: - watchers_count - created_at - updated_at - x-github-breaking-changes: &774 + x-github-breaking-changes: &773 - changeset: remove_use_squash_pr_title_as_default patch: properties: @@ -110764,10 +113399,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -110843,11 +113478,11 @@ x-webhooks: type: string enum: - created - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 - rule: &741 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 + rule: &740 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) @@ -111070,11 +113705,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 - rule: *741 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 + rule: *740 sender: *4 required: - action @@ -111257,11 +113892,11 @@ x-webhooks: - everyone required: - from - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 - rule: *741 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 + rule: *740 sender: *4 required: - action @@ -111345,7 +113980,7 @@ x-webhooks: type: string enum: - completed - check_run: &743 + check_run: &742 title: CheckRun description: A check performed on the code of a given code change type: object @@ -111399,7 +114034,7 @@ x-webhooks: pull_requests: type: array items: *90 - repository: *161 + repository: *160 status: example: completed type: string @@ -111436,7 +114071,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *742 + deployment: *741 details_url: example: https://example.com type: string @@ -111521,10 +114156,10 @@ x-webhooks: - output - app - pull_requests - installation: *738 - enterprise: *737 - organization: *739 - repository: *740 + installation: *737 + enterprise: *736 + organization: *738 + repository: *739 sender: *4 required: - check_run @@ -111915,11 +114550,11 @@ x-webhooks: type: string enum: - created - check_run: *743 - installation: *738 - enterprise: *737 - organization: *739 - repository: *740 + check_run: *742 + installation: *737 + enterprise: *736 + organization: *738 + repository: *739 sender: *4 required: - check_run @@ -112313,11 +114948,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *743 - installation: *738 - enterprise: *737 - organization: *739 - repository: *740 + check_run: *742 + installation: *737 + enterprise: *736 + organization: *738 + repository: *739 requested_action: description: The action requested by the user. type: object @@ -112720,11 +115355,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *743 - installation: *738 - enterprise: *737 - organization: *739 - repository: *740 + check_run: *742 + installation: *737 + enterprise: *736 + organization: *738 + repository: *739 sender: *4 required: - check_run @@ -113694,10 +116329,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -114386,10 +117021,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -115072,10 +117707,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -115241,7 +117876,7 @@ x-webhooks: required: - login - id - dismissed_comment: *437 + dismissed_comment: *436 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -115386,20 +118021,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &744 + commit_oid: &743 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: *737 - installation: *738 - organization: *739 - ref: &745 + enterprise: *736 + installation: *737 + organization: *738 + ref: &744 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: *740 + repository: *739 sender: *4 required: - action @@ -115564,7 +118199,7 @@ x-webhooks: required: - login - id - dismissed_comment: *437 + dismissed_comment: *436 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -115794,12 +118429,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *744 - enterprise: *737 - installation: *738 - organization: *739 - ref: *745 - repository: *740 + commit_oid: *743 + enterprise: *736 + installation: *737 + organization: *738 + ref: *744 + repository: *739 sender: *4 required: - action @@ -115894,7 +118529,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *437 + dismissed_comment: *436 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -116065,12 +118700,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *744 - enterprise: *737 - installation: *738 - organization: *739 - ref: *745 - repository: *740 + commit_oid: *743 + enterprise: *736 + installation: *737 + organization: *738 + ref: *744 + repository: *739 sender: *4 required: - action @@ -116236,7 +118871,7 @@ x-webhooks: required: - login - id - dismissed_comment: *437 + dismissed_comment: *436 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -116402,12 +119037,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *744 - enterprise: *737 - installation: *738 - organization: *739 - ref: *745 - repository: *740 + commit_oid: *743 + enterprise: *736 + installation: *737 + organization: *738 + ref: *744 + repository: *739 sender: *4 required: - action @@ -116506,7 +119141,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *437 + dismissed_comment: *436 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -116681,16 +119316,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *740 + repository: *739 sender: *4 required: - action @@ -116787,7 +119422,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *437 + dismissed_comment: *436 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -116927,12 +119562,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *744 - enterprise: *737 - installation: *738 - organization: *739 - ref: *745 - repository: *740 + commit_oid: *743 + enterprise: *736 + installation: *737 + organization: *738 + ref: *744 + repository: *739 sender: *4 required: - action @@ -117098,7 +119733,7 @@ x-webhooks: required: - login - id - dismissed_comment: *437 + dismissed_comment: *436 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -117243,10 +119878,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -117501,10 +120136,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -117584,18 +120219,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *739 - pusher_type: &746 + organization: *738 + pusher_type: &745 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &747 + ref: &746 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -117605,7 +120240,7 @@ x-webhooks: enum: - tag - branch - repository: *740 + repository: *739 sender: *4 required: - ref @@ -117687,10 +120322,10 @@ x-webhooks: type: string enum: - created - definition: *291 - enterprise: *737 - installation: *738 - organization: *739 + definition: *290 + enterprise: *736 + installation: *737 + organization: *738 sender: *4 required: - action @@ -117775,9 +120410,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 sender: *4 required: - action @@ -117854,10 +120489,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *291 - enterprise: *737 - installation: *738 - organization: *739 + definition: *290 + enterprise: *736 + installation: *737 + organization: *738 sender: *4 required: - action @@ -117934,10 +120569,10 @@ x-webhooks: type: string enum: - updated - definition: *291 - enterprise: *737 - installation: *738 - organization: *739 + definition: *290 + enterprise: *736 + installation: *737 + organization: *738 sender: *4 required: - action @@ -118014,19 +120649,19 @@ x-webhooks: type: string enum: - updated - enterprise: *737 - installation: *738 - repository: *740 - organization: *739 + enterprise: *736 + installation: *737 + repository: *739 + organization: *738 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *295 + items: *294 old_property_values: type: array description: The old custom property values for the repository. - items: *295 + items: *294 required: - action - repository @@ -118102,18 +120737,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *737 - installation: *738 - organization: *739 - pusher_type: *746 - ref: *747 + enterprise: *736 + installation: *737 + organization: *738 + pusher_type: *745 + ref: *746 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *740 + repository: *739 sender: *4 required: - ref @@ -118193,11 +120828,11 @@ x-webhooks: type: string enum: - assignees_changed - alert: *499 - installation: *738 - organization: *739 - enterprise: *737 - repository: *740 + alert: *498 + installation: *737 + organization: *738 + enterprise: *736 + repository: *739 sender: *4 required: - action @@ -118277,11 +120912,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *499 - installation: *738 - organization: *739 - enterprise: *737 - repository: *740 + alert: *498 + installation: *737 + organization: *738 + enterprise: *736 + repository: *739 sender: *4 required: - action @@ -118362,11 +120997,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *499 - installation: *738 - organization: *739 - enterprise: *737 - repository: *740 + alert: *498 + installation: *737 + organization: *738 + enterprise: *736 + repository: *739 sender: *4 required: - action @@ -118447,11 +121082,11 @@ x-webhooks: type: string enum: - created - alert: *499 - installation: *738 - organization: *739 - enterprise: *737 - repository: *740 + alert: *498 + installation: *737 + organization: *738 + enterprise: *736 + repository: *739 sender: *4 required: - action @@ -118530,11 +121165,11 @@ x-webhooks: type: string enum: - dismissed - alert: *499 - installation: *738 - organization: *739 - enterprise: *737 - repository: *740 + alert: *498 + installation: *737 + organization: *738 + enterprise: *736 + repository: *739 sender: *4 required: - action @@ -118613,11 +121248,11 @@ x-webhooks: type: string enum: - fixed - alert: *499 - installation: *738 - organization: *739 - enterprise: *737 - repository: *740 + alert: *498 + installation: *737 + organization: *738 + enterprise: *736 + repository: *739 sender: *4 required: - action @@ -118697,11 +121332,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *499 - installation: *738 - organization: *739 - enterprise: *737 - repository: *740 + alert: *498 + installation: *737 + organization: *738 + enterprise: *736 + repository: *739 sender: *4 required: - action @@ -118780,11 +121415,11 @@ x-webhooks: type: string enum: - reopened - alert: *499 - installation: *738 - organization: *739 - enterprise: *737 - repository: *740 + alert: *498 + installation: *737 + organization: *738 + enterprise: *736 + repository: *739 sender: *4 required: - action @@ -118861,9 +121496,9 @@ x-webhooks: type: string enum: - created - enterprise: *737 - installation: *738 - key: &748 + enterprise: *736 + installation: *737 + key: &747 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -118899,8 +121534,8 @@ x-webhooks: - verified - created_at - read_only - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 required: - action @@ -118977,11 +121612,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *737 - installation: *738 - key: *748 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + key: *747 + organization: *738 + repository: *739 sender: *4 required: - action @@ -119537,12 +122172,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 - workflow: &754 + workflow: &753 title: Workflow type: object nullable: true @@ -120283,15 +122918,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *749 - required: *750 + properties: *748 + required: *749 nullable: true pull_requests: type: array - items: *595 - repository: *740 - organization: *739 - installation: *738 + items: *594 + repository: *739 + organization: *738 + installation: *737 sender: *4 responses: '200': @@ -120362,7 +122997,7 @@ x-webhooks: type: string enum: - approved - approver: &751 + approver: &750 type: object properties: avatar_url: @@ -120405,11 +123040,11 @@ x-webhooks: type: string comment: type: string - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 - reviewers: &752 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 + reviewers: &751 type: array items: type: object @@ -120488,7 +123123,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &753 + workflow_job_run: &752 type: object properties: conclusion: @@ -121219,18 +123854,18 @@ x-webhooks: type: string enum: - rejected - approver: *751 + approver: *750 comment: type: string - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 - reviewers: *752 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 + reviewers: *751 sender: *4 since: type: string - workflow_job_run: *753 + workflow_job_run: *752 workflow_job_runs: type: array items: @@ -121934,13 +124569,13 @@ x-webhooks: type: string enum: - requested - enterprise: *737 + enterprise: *736 environment: type: string - installation: *738 - organization: *739 - repository: *740 - requestor: &759 + installation: *737 + organization: *738 + repository: *739 + requestor: &758 title: User type: object nullable: true @@ -123829,12 +126464,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 - workflow: *754 + workflow: *753 workflow_run: title: Deployment Workflow Run type: object @@ -124514,7 +127149,7 @@ x-webhooks: type: string enum: - answered - answer: &757 + answer: &756 type: object properties: author_association: @@ -124671,11 +127306,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *755 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + discussion: *754 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -124802,11 +127437,11 @@ x-webhooks: - from required: - category - discussion: *755 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + discussion: *754 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -124889,11 +127524,11 @@ x-webhooks: type: string enum: - closed - discussion: *755 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + discussion: *754 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -124975,7 +127610,7 @@ x-webhooks: type: string enum: - created - comment: &756 + comment: &755 type: object properties: author_association: @@ -125132,11 +127767,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *755 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + discussion: *754 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -125219,12 +127854,12 @@ x-webhooks: type: string enum: - deleted - comment: *756 - discussion: *755 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + comment: *755 + discussion: *754 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -125319,12 +127954,12 @@ x-webhooks: - from required: - body - comment: *756 - discussion: *755 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + comment: *755 + discussion: *754 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -125408,11 +128043,11 @@ x-webhooks: type: string enum: - created - discussion: *755 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + discussion: *754 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -125494,11 +128129,11 @@ x-webhooks: type: string enum: - deleted - discussion: *755 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + discussion: *754 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -125598,11 +128233,11 @@ x-webhooks: type: string required: - from - discussion: *755 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + discussion: *754 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -125684,10 +128319,10 @@ x-webhooks: type: string enum: - labeled - discussion: *755 - enterprise: *737 - installation: *738 - label: &758 + discussion: *754 + enterprise: *736 + installation: *737 + label: &757 title: Label type: object properties: @@ -125719,8 +128354,8 @@ x-webhooks: - color - default - description - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 required: - action @@ -125803,11 +128438,11 @@ x-webhooks: type: string enum: - locked - discussion: *755 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + discussion: *754 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -125889,11 +128524,11 @@ x-webhooks: type: string enum: - pinned - discussion: *755 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + discussion: *754 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -125975,11 +128610,11 @@ x-webhooks: type: string enum: - reopened - discussion: *755 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + discussion: *754 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -126064,16 +128699,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *755 - new_repository: *740 + new_discussion: *754 + new_repository: *739 required: - new_discussion - new_repository - discussion: *755 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + discussion: *754 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -126156,10 +128791,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *755 - old_answer: *757 - organization: *739 - repository: *740 + discussion: *754 + old_answer: *756 + organization: *738 + repository: *739 sender: *4 required: - action @@ -126241,12 +128876,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *755 - enterprise: *737 - installation: *738 - label: *758 - organization: *739 - repository: *740 + discussion: *754 + enterprise: *736 + installation: *737 + label: *757 + organization: *738 + repository: *739 sender: *4 required: - action @@ -126329,11 +128964,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *755 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + discussion: *754 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -126415,11 +129050,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *755 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + discussion: *754 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -126492,7 +129127,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *737 + enterprise: *736 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -127152,9 +129787,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *738 - organization: *739 - repository: *740 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - forkee @@ -127300,9 +129935,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 pages: description: The pages that were updated. type: array @@ -127339,7 +129974,7 @@ x-webhooks: - action - sha - html_url - repository: *740 + repository: *739 sender: *4 required: - pages @@ -127415,10 +130050,10 @@ x-webhooks: type: string enum: - created - enterprise: *737 + enterprise: *736 installation: *22 - organization: *739 - repositories: &760 + organization: *738 + repositories: &759 description: An array of repository objects that the installation can access. type: array @@ -127444,8 +130079,8 @@ x-webhooks: - name - full_name - private - repository: *740 - requester: *759 + repository: *739 + requester: *758 sender: *4 required: - action @@ -127520,11 +130155,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *737 + enterprise: *736 installation: *22 - organization: *739 - repositories: *760 - repository: *740 + organization: *738 + repositories: *759 + repository: *739 requester: nullable: true sender: *4 @@ -127600,11 +130235,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *737 + enterprise: *736 installation: *22 - organization: *739 - repositories: *760 - repository: *740 + organization: *738 + repositories: *759 + repository: *739 requester: nullable: true sender: *4 @@ -127680,10 +130315,10 @@ x-webhooks: type: string enum: - added - enterprise: *737 + enterprise: *736 installation: *22 - organization: *739 - repositories_added: &761 + organization: *738 + repositories_added: &760 description: An array of repository objects, which were added to the installation. type: array @@ -127729,15 +130364,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *740 - repository_selection: &762 + repository: *739 + repository_selection: &761 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *759 + requester: *758 sender: *4 required: - action @@ -127816,10 +130451,10 @@ x-webhooks: type: string enum: - removed - enterprise: *737 + enterprise: *736 installation: *22 - organization: *739 - repositories_added: *761 + organization: *738 + repositories_added: *760 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -127846,9 +130481,9 @@ x-webhooks: - name - full_name - private - repository: *740 - repository_selection: *762 - requester: *759 + repository: *739 + repository_selection: *761 + requester: *758 sender: *4 required: - action @@ -127927,11 +130562,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *737 + enterprise: *736 installation: *22 - organization: *739 - repositories: *760 - repository: *740 + organization: *738 + repositories: *759 + repository: *739 requester: nullable: true sender: *4 @@ -128109,10 +130744,10 @@ x-webhooks: type: string required: - from - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 target_type: type: string @@ -128191,11 +130826,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *737 + enterprise: *736 installation: *22 - organization: *739 - repositories: *760 - repository: *740 + organization: *738 + repositories: *759 + repository: *739 requester: nullable: true sender: *4 @@ -128369,8 +131004,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *572 - required: *573 + properties: *571 + required: *572 nullable: true user: title: User @@ -128455,8 +131090,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -129245,8 +131880,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 state: description: State of the issue; either 'open' or 'closed' type: string @@ -129262,7 +131897,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *242 updated_at: type: string format: date-time @@ -129595,8 +132230,8 @@ x-webhooks: - state - locked - assignee - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 required: - action @@ -129676,7 +132311,7 @@ x-webhooks: type: string enum: - deleted - comment: &763 + comment: &762 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -129833,8 +132468,8 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *572 - required: *573 + properties: *571 + required: *572 nullable: true required: - url @@ -129849,8 +132484,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -130635,8 +133270,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130652,7 +133287,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *242 updated_at: type: string format: date-time @@ -130987,8 +133622,8 @@ x-webhooks: - state - locked - assignee - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 required: - action @@ -131068,7 +133703,7 @@ x-webhooks: type: string enum: - edited - changes: &793 + changes: &792 description: The changes to the comment. type: object properties: @@ -131080,9 +133715,9 @@ x-webhooks: type: string required: - from - comment: *763 - enterprise: *737 - installation: *738 + comment: *762 + enterprise: *736 + installation: *737 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -131870,8 +134505,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131887,7 +134522,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *242 updated_at: type: string format: date-time @@ -132220,8 +134855,8 @@ x-webhooks: - state - locked - assignee - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 required: - action @@ -132302,9 +134937,9 @@ x-webhooks: type: string enum: - pinned - comment: *763 - enterprise: *737 - installation: *738 + comment: *762 + enterprise: *736 + installation: *737 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -133094,8 +135729,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133111,7 +135746,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *242 updated_at: type: string format: date-time @@ -133446,8 +136081,8 @@ x-webhooks: - state - locked - assignee - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 required: - action @@ -133527,9 +136162,9 @@ x-webhooks: type: string enum: - unpinned - comment: *763 - enterprise: *737 - installation: *738 + comment: *762 + enterprise: *736 + installation: *737 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -134319,8 +136954,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134336,7 +136971,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *242 updated_at: type: string format: date-time @@ -134671,8 +137306,8 @@ x-webhooks: - state - locked - assignee - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 required: - action @@ -134761,9 +137396,9 @@ x-webhooks: type: number blocking_issue: *85 blocking_issue_repo: *79 - installation: *738 - organization: *739 - repository: *740 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -134852,9 +137487,9 @@ x-webhooks: type: number blocking_issue: *85 blocking_issue_repo: *79 - installation: *738 - organization: *739 - repository: *740 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -134942,9 +137577,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *85 - installation: *738 - organization: *739 - repository: *740 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -135033,9 +137668,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *85 - installation: *738 - organization: *739 - repository: *740 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -135115,10 +137750,10 @@ x-webhooks: type: string enum: - assigned - assignee: *759 - enterprise: *737 - installation: *738 - issue: &766 + assignee: *758 + enterprise: *736 + installation: *737 + issue: &765 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -135910,11 +138545,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 issue_field_values: type: array - items: *557 + items: *556 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135930,7 +138565,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *242 updated_at: type: string format: date-time @@ -136031,8 +138666,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 required: - action @@ -136112,8 +138747,8 @@ x-webhooks: type: string enum: - closed - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -136910,11 +139545,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 issue_field_values: type: array - items: *557 + items: *556 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136930,7 +139565,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *242 updated_at: type: string format: date-time @@ -137166,8 +139801,8 @@ x-webhooks: required: - state - closed_at - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 required: - action @@ -137246,8 +139881,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -138035,11 +140670,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 issue_field_values: type: array - items: *557 + items: *556 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138055,7 +140690,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *242 updated_at: type: string format: date-time @@ -138155,8 +140790,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 required: - action @@ -138235,8 +140870,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139046,11 +141681,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 issue_field_values: type: array - items: *557 + items: *556 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139066,7 +141701,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *242 updated_at: type: string format: date-time @@ -139145,7 +141780,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &764 + milestone: &763 title: Milestone description: A collection of related issues and pull requests. type: object @@ -139283,8 +141918,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 required: - action @@ -139383,8 +142018,8 @@ x-webhooks: type: string required: - from - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -140176,11 +142811,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 issue_field_values: type: array - items: *557 + items: *556 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140193,7 +142828,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *243 + type: *242 title: description: Title of the issue type: string @@ -140297,9 +142932,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *758 - organization: *739 - repository: *740 + label: *757 + organization: *738 + repository: *739 sender: *4 required: - action @@ -140379,8 +143014,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141171,11 +143806,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 issue_field_values: type: array - items: *557 + items: *556 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141188,7 +143823,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *243 + type: *242 title: description: Title of the issue type: string @@ -141292,9 +143927,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *758 - organization: *739 - repository: *740 + label: *757 + organization: *738 + repository: *739 sender: *4 required: - action @@ -141374,8 +144009,8 @@ x-webhooks: type: string enum: - locked - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142190,11 +144825,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 issue_field_values: type: array - items: *557 + items: *556 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142207,7 +144842,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *243 + type: *242 title: description: Title of the issue type: string @@ -142288,8 +144923,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 required: - action @@ -142368,8 +145003,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -143178,11 +145813,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 issue_field_values: type: array - items: *557 + items: *556 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143198,7 +145833,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *242 updated_at: type: string format: date-time @@ -143276,9 +145911,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *764 - organization: *739 - repository: *740 + milestone: *763 + organization: *738 + repository: *739 sender: *4 required: - action @@ -144141,11 +146776,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 issue_field_values: type: array - items: *557 + items: *556 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144246,7 +146881,7 @@ x-webhooks: required: - login - id - type: *243 + type: *242 required: - id - number @@ -144726,8 +147361,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -145511,11 +148146,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 issue_field_values: type: array - items: *557 + items: *556 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145531,7 +148166,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *242 updated_at: type: string format: date-time @@ -145639,8 +148274,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 required: - action @@ -145720,9 +148355,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *737 - installation: *738 - issue: &765 + enterprise: *736 + installation: *737 + issue: &764 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -146508,11 +149143,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 issue_field_values: type: array - items: *557 + items: *556 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146528,7 +149163,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *242 updated_at: type: string format: date-time @@ -146628,8 +149263,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 required: - action @@ -146708,8 +149343,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147522,11 +150157,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 issue_field_values: type: array - items: *557 + items: *556 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147620,9 +150255,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *243 - organization: *739 - repository: *740 + type: *242 + organization: *738 + repository: *739 sender: *4 required: - action @@ -148491,11 +151126,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 issue_field_values: type: array - items: *557 + items: *556 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148511,7 +151146,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *242 updated_at: type: string format: date-time @@ -149090,11 +151725,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *737 - installation: *738 - issue: *765 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + issue: *764 + organization: *738 + repository: *739 sender: *4 required: - action @@ -149174,12 +151809,12 @@ x-webhooks: type: string enum: - typed - enterprise: *737 - installation: *738 - issue: *766 - type: *243 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + issue: *765 + type: *242 + organization: *738 + repository: *739 sender: *4 required: - action @@ -149260,7 +151895,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &796 + assignee: &795 title: User type: object nullable: true @@ -149330,11 +151965,11 @@ x-webhooks: required: - login - id - enterprise: *737 - installation: *738 - issue: *766 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + issue: *765 + organization: *738 + repository: *739 sender: *4 required: - action @@ -149413,12 +152048,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *737 - installation: *738 - issue: *766 - label: *758 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + issue: *765 + label: *757 + organization: *738 + repository: *739 sender: *4 required: - action @@ -149498,8 +152133,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -150312,11 +152947,11 @@ x-webhooks: properties: *86 required: *87 nullable: true - sub_issues_summary: *673 - issue_dependencies_summary: *674 + sub_issues_summary: *672 + issue_dependencies_summary: *673 issue_field_values: type: array - items: *557 + items: *556 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150332,7 +152967,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *243 + type: *242 updated_at: type: string format: date-time @@ -150410,8 +153045,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 required: - action @@ -150491,11 +153126,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *737 - installation: *738 - issue: *765 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + issue: *764 + organization: *738 + repository: *739 sender: *4 required: - action @@ -150574,12 +153209,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *737 - installation: *738 - issue: *766 - type: *243 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + issue: *765 + type: *242 + organization: *738 + repository: *739 sender: *4 required: - action @@ -150659,11 +153294,11 @@ x-webhooks: type: string enum: - created - enterprise: *737 - installation: *738 - label: *758 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + label: *757 + organization: *738 + repository: *739 sender: *4 required: - action @@ -150741,11 +153376,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *737 - installation: *738 - label: *758 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + label: *757 + organization: *738 + repository: *739 sender: *4 required: - action @@ -150855,11 +153490,11 @@ x-webhooks: type: string required: - from - enterprise: *737 - installation: *738 - label: *758 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + label: *757 + organization: *738 + repository: *739 sender: *4 required: - action @@ -150941,9 +153576,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *737 - installation: *738 - marketplace_purchase: &767 + enterprise: *736 + installation: *737 + marketplace_purchase: &766 title: Marketplace Purchase type: object required: @@ -151026,8 +153661,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *739 - previous_marketplace_purchase: &768 + organization: *738 + previous_marketplace_purchase: &767 title: Marketplace Purchase type: object properties: @@ -151107,7 +153742,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *740 + repository: *739 sender: *4 required: - action @@ -151187,10 +153822,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *737 - installation: *738 - marketplace_purchase: *767 - organization: *739 + enterprise: *736 + installation: *737 + marketplace_purchase: *766 + organization: *738 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -151273,7 +153908,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *740 + repository: *739 sender: *4 required: - action @@ -151355,10 +153990,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *737 - installation: *738 - marketplace_purchase: *767 - organization: *739 + enterprise: *736 + installation: *737 + marketplace_purchase: *766 + organization: *738 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -151440,7 +154075,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *740 + repository: *739 sender: *4 required: - action @@ -151521,8 +154156,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 marketplace_purchase: title: Marketplace Purchase type: object @@ -151604,9 +154239,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *739 - previous_marketplace_purchase: *768 - repository: *740 + organization: *738 + previous_marketplace_purchase: *767 + repository: *739 sender: *4 required: - action @@ -151686,12 +154321,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *737 - installation: *738 - marketplace_purchase: *767 - organization: *739 - previous_marketplace_purchase: *768 - repository: *740 + enterprise: *736 + installation: *737 + marketplace_purchase: *766 + organization: *738 + previous_marketplace_purchase: *767 + repository: *739 sender: *4 required: - action @@ -151793,11 +154428,11 @@ x-webhooks: type: string required: - to - enterprise: *737 - installation: *738 - member: *759 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + member: *758 + organization: *738 + repository: *739 sender: *4 required: - action @@ -151897,11 +154532,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *737 - installation: *738 - member: *759 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + member: *758 + organization: *738 + repository: *739 sender: *4 required: - action @@ -151980,11 +154615,11 @@ x-webhooks: type: string enum: - removed - enterprise: *737 - installation: *738 - member: *759 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + member: *758 + organization: *738 + repository: *739 sender: *4 required: - action @@ -152062,11 +154697,11 @@ x-webhooks: type: string enum: - added - enterprise: *737 - installation: *738 - member: *759 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + member: *758 + organization: *738 + repository: *739 scope: description: The scope of the membership. Currently, can only be `team`. @@ -152142,7 +154777,7 @@ x-webhooks: required: - login - id - team: &769 + team: &768 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -152365,11 +155000,11 @@ x-webhooks: type: string enum: - removed - enterprise: *737 - installation: *738 - member: *759 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + member: *758 + organization: *738 + repository: *739 scope: description: The scope of the membership. Currently, can only be `team`. @@ -152446,7 +155081,7 @@ x-webhooks: required: - login - id - team: *769 + team: *768 required: - action - scope @@ -152528,8 +155163,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *738 - merge_group: &771 + installation: *737 + merge_group: &770 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -152548,15 +155183,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *770 + head_commit: *769 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 required: - action @@ -152642,10 +155277,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *738 - merge_group: *771 - organization: *739 - repository: *740 + installation: *737 + merge_group: *770 + organization: *738 + repository: *739 sender: *4 required: - action @@ -152718,7 +155353,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *737 + enterprise: *736 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -152827,17 +155462,17 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *738 - organization: *739 + installation: *737 + organization: *738 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *772 - required: *773 - x-github-breaking-changes: *774 + properties: *771 + required: *772 + x-github-breaking-changes: *773 nullable: true sender: *4 required: @@ -152918,11 +155553,11 @@ x-webhooks: type: string enum: - closed - enterprise: *737 - installation: *738 - milestone: *764 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + milestone: *763 + organization: *738 + repository: *739 sender: *4 required: - action @@ -153001,9 +155636,9 @@ x-webhooks: type: string enum: - created - enterprise: *737 - installation: *738 - milestone: &775 + enterprise: *736 + installation: *737 + milestone: &774 title: Milestone description: A collection of related issues and pull requests. type: object @@ -153140,8 +155775,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 required: - action @@ -153220,11 +155855,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *737 - installation: *738 - milestone: *764 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + milestone: *763 + organization: *738 + repository: *739 sender: *4 required: - action @@ -153334,11 +155969,11 @@ x-webhooks: type: string required: - from - enterprise: *737 - installation: *738 - milestone: *764 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + milestone: *763 + organization: *738 + repository: *739 sender: *4 required: - action @@ -153418,11 +156053,11 @@ x-webhooks: type: string enum: - opened - enterprise: *737 - installation: *738 - milestone: *775 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + milestone: *774 + organization: *738 + repository: *739 sender: *4 required: - action @@ -153501,11 +156136,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *759 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + blocked_user: *758 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -153584,11 +156219,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *759 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + blocked_user: *758 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -153667,9 +156302,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *737 - installation: *738 - membership: &776 + enterprise: *736 + installation: *737 + membership: &775 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -153776,8 +156411,8 @@ x-webhooks: - role - organization_url - user - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 required: - action @@ -153855,11 +156490,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *737 - installation: *738 - membership: *776 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + membership: *775 + organization: *738 + repository: *739 sender: *4 required: - action @@ -153938,8 +156573,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -154055,10 +156690,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 - user: *759 + user: *758 required: - action - invitation @@ -154136,11 +156771,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *737 - installation: *738 - membership: *776 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + membership: *775 + organization: *738 + repository: *739 sender: *4 required: - action @@ -154227,11 +156862,11 @@ x-webhooks: properties: from: type: string - enterprise: *737 - installation: *738 - membership: *776 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + membership: *775 + organization: *738 + repository: *739 sender: *4 required: - action @@ -154308,9 +156943,9 @@ x-webhooks: type: string enum: - published - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 package: description: Information about the package. type: object @@ -154809,7 +157444,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &777 + items: &776 title: Ruby Gems metadata type: object properties: @@ -154904,7 +157539,7 @@ x-webhooks: - owner - package_version - registry - repository: *740 + repository: *739 sender: *4 required: - action @@ -154980,9 +157615,9 @@ x-webhooks: type: string enum: - updated - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 package: description: Information about the package. type: object @@ -155335,7 +157970,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *777 + items: *776 source_url: type: string format: uri @@ -155405,7 +158040,7 @@ x-webhooks: - owner - package_version - registry - repository: *740 + repository: *739 sender: *4 required: - action @@ -155581,12 +158216,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *737 + enterprise: *736 id: type: integer - installation: *738 - organization: *739 - repository: *740 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - id @@ -155663,7 +158298,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &778 + personal_access_token_request: &777 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -155809,10 +158444,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *737 - organization: *739 + enterprise: *736 + organization: *738 sender: *4 - installation: *738 + installation: *737 required: - action - personal_access_token_request @@ -155889,11 +158524,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *778 - enterprise: *737 - organization: *739 + personal_access_token_request: *777 + enterprise: *736 + organization: *738 sender: *4 - installation: *738 + installation: *737 required: - action - personal_access_token_request @@ -155969,11 +158604,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *778 - enterprise: *737 - organization: *739 + personal_access_token_request: *777 + enterprise: *736 + organization: *738 sender: *4 - installation: *738 + installation: *737 required: - action - personal_access_token_request @@ -156048,11 +158683,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *778 - organization: *739 - enterprise: *737 + personal_access_token_request: *777 + organization: *738 + enterprise: *736 sender: *4 - installation: *738 + installation: *737 required: - action - personal_access_token_request @@ -156157,7 +158792,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *779 + last_response: *778 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -156189,8 +158824,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 zen: description: Random string of GitHub zen. @@ -156435,10 +159070,10 @@ x-webhooks: - from required: - note - enterprise: *737 - installation: *738 - organization: *739 - project_card: &780 + enterprise: *736 + installation: *737 + organization: *738 + project_card: &779 title: Project Card type: object properties: @@ -156557,7 +159192,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *740 + repository: *739 sender: *4 required: - action @@ -156638,11 +159273,11 @@ x-webhooks: type: string enum: - created - enterprise: *737 - installation: *738 - organization: *739 - project_card: *780 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + project_card: *779 + repository: *739 sender: *4 required: - action @@ -156722,9 +159357,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 project_card: title: Project Card type: object @@ -156852,9 +159487,9 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *772 - required: *773 - x-github-breaking-changes: *774 + properties: *771 + required: *772 + x-github-breaking-changes: *773 nullable: true sender: *4 required: @@ -156948,11 +159583,11 @@ x-webhooks: - from required: - note - enterprise: *737 - installation: *738 - organization: *739 - project_card: *780 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + project_card: *779 + repository: *739 sender: *4 required: - action @@ -157046,9 +159681,9 @@ x-webhooks: - from required: - column_id - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 project_card: allOf: - title: Project Card @@ -157238,7 +159873,7 @@ x-webhooks: type: string required: - after_id - repository: *740 + repository: *739 sender: *4 required: - action @@ -157318,10 +159953,10 @@ x-webhooks: type: string enum: - closed - enterprise: *737 - installation: *738 - organization: *739 - project: &782 + enterprise: *736 + installation: *737 + organization: *738 + project: &781 title: Project type: object properties: @@ -157445,7 +160080,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *740 + repository: *739 sender: *4 required: - action @@ -157525,10 +160160,10 @@ x-webhooks: type: string enum: - created - enterprise: *737 - installation: *738 - organization: *739 - project_column: &781 + enterprise: *736 + installation: *737 + organization: *738 + project_column: &780 title: Project Column type: object properties: @@ -157567,7 +160202,7 @@ x-webhooks: - name - created_at - updated_at - repository: *740 + repository: *739 sender: *4 required: - action @@ -157646,19 +160281,19 @@ x-webhooks: type: string enum: - deleted - enterprise: *737 - installation: *738 - organization: *739 - project_column: *781 + enterprise: *736 + installation: *737 + organization: *738 + project_column: *780 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *772 - required: *773 - x-github-breaking-changes: *774 + properties: *771 + required: *772 + x-github-breaking-changes: *773 nullable: true sender: *4 required: @@ -157748,11 +160383,11 @@ x-webhooks: type: string required: - from - enterprise: *737 - installation: *738 - organization: *739 - project_column: *781 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + project_column: *780 + repository: *739 sender: *4 required: - action @@ -157832,11 +160467,11 @@ x-webhooks: type: string enum: - moved - enterprise: *737 - installation: *738 - organization: *739 - project_column: *781 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + project_column: *780 + repository: *739 sender: *4 required: - action @@ -157916,11 +160551,11 @@ x-webhooks: type: string enum: - created - enterprise: *737 - installation: *738 - organization: *739 - project: *782 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + project: *781 + repository: *739 sender: *4 required: - action @@ -158000,19 +160635,19 @@ x-webhooks: type: string enum: - deleted - enterprise: *737 - installation: *738 - organization: *739 - project: *782 + enterprise: *736 + installation: *737 + organization: *738 + project: *781 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *772 - required: *773 - x-github-breaking-changes: *774 + properties: *771 + required: *772 + x-github-breaking-changes: *773 nullable: true sender: *4 required: @@ -158114,11 +160749,11 @@ x-webhooks: type: string required: - from - enterprise: *737 - installation: *738 - organization: *739 - project: *782 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + project: *781 + repository: *739 sender: *4 required: - action @@ -158197,11 +160832,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *737 - installation: *738 - organization: *739 - project: *782 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + project: *781 + repository: *739 sender: *4 required: - action @@ -158282,9 +160917,9 @@ x-webhooks: type: string enum: - closed - installation: *738 - organization: *739 - projects_v2: *277 + installation: *737 + organization: *738 + projects_v2: *276 sender: *4 required: - action @@ -158365,9 +161000,9 @@ x-webhooks: type: string enum: - created - installation: *738 - organization: *739 - projects_v2: *277 + installation: *737 + organization: *738 + projects_v2: *276 sender: *4 required: - action @@ -158448,9 +161083,9 @@ x-webhooks: type: string enum: - deleted - installation: *738 - organization: *739 - projects_v2: *277 + installation: *737 + organization: *738 + projects_v2: *276 sender: *4 required: - action @@ -158567,9 +161202,9 @@ x-webhooks: type: string to: type: string - installation: *738 - organization: *739 - projects_v2: *277 + installation: *737 + organization: *738 + projects_v2: *276 sender: *4 required: - action @@ -158652,7 +161287,7 @@ x-webhooks: type: string enum: - archived - changes: &786 + changes: &785 type: object properties: archived_at: @@ -158666,9 +161301,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *738 - organization: *739 - projects_v2_item: &783 + installation: *737 + organization: *738 + projects_v2_item: &782 title: Projects v2 Item description: An item belonging to a project type: object @@ -158686,7 +161321,7 @@ x-webhooks: type: string description: The node ID of the content represented by this item. - content_type: *284 + content_type: *283 creator: *4 created_at: type: string @@ -158803,9 +161438,9 @@ x-webhooks: nullable: true to: type: string - installation: *738 - organization: *739 - projects_v2_item: *783 + installation: *737 + organization: *738 + projects_v2_item: *782 sender: *4 required: - action @@ -158887,9 +161522,9 @@ x-webhooks: type: string enum: - created - installation: *738 - organization: *739 - projects_v2_item: *783 + installation: *737 + organization: *738 + projects_v2_item: *782 sender: *4 required: - action @@ -158970,9 +161605,9 @@ x-webhooks: type: string enum: - deleted - installation: *738 - organization: *739 - projects_v2_item: *783 + installation: *737 + organization: *738 + projects_v2_item: *782 sender: *4 required: - action @@ -159078,7 +161713,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &784 + - &783 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -159100,7 +161735,7 @@ x-webhooks: required: - id - name - - &785 + - &784 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -159134,8 +161769,8 @@ x-webhooks: oneOf: - type: string - type: integer + - *783 - *784 - - *785 required: - field_value - type: object @@ -159151,9 +161786,9 @@ x-webhooks: nullable: true required: - body - installation: *738 - organization: *739 - projects_v2_item: *783 + installation: *737 + organization: *738 + projects_v2_item: *782 sender: *4 required: - action @@ -159248,9 +161883,9 @@ x-webhooks: to: type: string nullable: true - installation: *738 - organization: *739 - projects_v2_item: *783 + installation: *737 + organization: *738 + projects_v2_item: *782 sender: *4 required: - action @@ -159333,10 +161968,10 @@ x-webhooks: type: string enum: - restored - changes: *786 - installation: *738 - organization: *739 - projects_v2_item: *783 + changes: *785 + installation: *737 + organization: *738 + projects_v2_item: *782 sender: *4 required: - action @@ -159418,9 +162053,9 @@ x-webhooks: type: string enum: - reopened - installation: *738 - organization: *739 - projects_v2: *277 + installation: *737 + organization: *738 + projects_v2: *276 sender: *4 required: - action @@ -159501,14 +162136,14 @@ x-webhooks: type: string enum: - created - installation: *738 - organization: *739 - projects_v2_status_update: &789 + installation: *737 + organization: *738 + projects_v2_status_update: &788 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *787 - required: *788 + properties: *786 + required: *787 sender: *4 required: - action @@ -159589,9 +162224,9 @@ x-webhooks: type: string enum: - deleted - installation: *738 - organization: *739 - projects_v2_status_update: *789 + installation: *737 + organization: *738 + projects_v2_status_update: *788 sender: *4 required: - action @@ -159727,9 +162362,9 @@ x-webhooks: type: string format: date nullable: true - installation: *738 - organization: *739 - projects_v2_status_update: *789 + installation: *737 + organization: *738 + projects_v2_status_update: *788 sender: *4 required: - action @@ -159800,10 +162435,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - repository @@ -159880,13 +162515,13 @@ x-webhooks: type: string enum: - assigned - assignee: *759 - enterprise: *737 - installation: *738 - number: &790 + assignee: *758 + enterprise: *736 + installation: *737 + number: &789 description: The pull request number. type: integer - organization: *739 + organization: *738 pull_request: title: Pull Request type: object @@ -162191,7 +164826,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *740 + repository: *739 sender: *4 required: - action @@ -162288,11 +164923,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 number: type: integer - organization: *739 + organization: *738 pull_request: title: Pull Request type: object @@ -164592,7 +167227,7 @@ x-webhooks: - draft reason: type: string - repository: *740 + repository: *739 sender: *4 required: - action @@ -164689,11 +167324,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 number: type: integer - organization: *739 + organization: *738 pull_request: title: Pull Request type: object @@ -166993,7 +169628,7 @@ x-webhooks: - draft reason: type: string - repository: *740 + repository: *739 sender: *4 required: - action @@ -167090,13 +169725,13 @@ x-webhooks: type: string enum: - closed - enterprise: *737 - installation: *738 - number: *790 - organization: *739 - pull_request: &791 + enterprise: *736 + installation: *737 + number: *789 + organization: *738 + pull_request: &790 allOf: - - *595 + - *594 - type: object properties: allow_auto_merge: @@ -167158,7 +169793,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *740 + repository: *739 sender: *4 required: - action @@ -167239,12 +169874,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *737 - installation: *738 - number: *790 - organization: *739 - pull_request: *791 - repository: *740 + enterprise: *736 + installation: *737 + number: *789 + organization: *738 + pull_request: *790 + repository: *739 sender: *4 required: - action @@ -167324,11 +169959,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *737 - milestone: *579 - number: *790 - organization: *739 - pull_request: &792 + enterprise: *736 + milestone: *578 + number: *789 + organization: *738 + pull_request: &791 title: Pull Request type: object properties: @@ -169655,7 +172290,7 @@ x-webhooks: - active_lock_reason - draft version: '2026-03-10' - repository: *740 + repository: *739 sender: *4 required: - action @@ -169734,11 +172369,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 number: type: integer - organization: *739 + organization: *738 pull_request: title: Pull Request type: object @@ -172042,7 +174677,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *740 + repository: *739 sender: *4 required: - action @@ -172174,12 +174809,12 @@ x-webhooks: type: string required: - from - enterprise: *737 - installation: *738 - number: *790 - organization: *739 - pull_request: *791 - repository: *740 + enterprise: *736 + installation: *737 + number: *789 + organization: *738 + pull_request: *790 + repository: *739 sender: *4 required: - action @@ -172259,11 +174894,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 number: type: integer - organization: *739 + organization: *738 pull_request: title: Pull Request type: object @@ -174552,7 +177187,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *740 + repository: *739 sender: *4 required: - action @@ -174640,11 +177275,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *737 - installation: *738 - label: *758 - number: *790 - organization: *739 + enterprise: *736 + installation: *737 + label: *757 + number: *789 + organization: *738 pull_request: title: Pull Request type: object @@ -176948,7 +179583,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *740 + repository: *739 sender: *4 required: - action @@ -177044,10 +179679,10 @@ x-webhooks: type: string enum: - locked - enterprise: *737 - installation: *738 - number: *790 - organization: *739 + enterprise: *736 + installation: *737 + number: *789 + organization: *738 pull_request: title: Pull Request type: object @@ -179349,7 +181984,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *740 + repository: *739 sender: *4 required: - action @@ -179444,12 +182079,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *737 - milestone: *579 - number: *790 - organization: *739 - pull_request: *792 - repository: *740 + enterprise: *736 + milestone: *578 + number: *789 + organization: *738 + pull_request: *791 + repository: *739 sender: *4 required: - action @@ -179528,12 +182163,12 @@ x-webhooks: type: string enum: - opened - enterprise: *737 - installation: *738 - number: *790 - organization: *739 - pull_request: *791 - repository: *740 + enterprise: *736 + installation: *737 + number: *789 + organization: *738 + pull_request: *790 + repository: *739 sender: *4 required: - action @@ -179614,12 +182249,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *737 - installation: *738 - number: *790 - organization: *739 - pull_request: *791 - repository: *740 + enterprise: *736 + installation: *737 + number: *789 + organization: *738 + pull_request: *790 + repository: *739 sender: *4 required: - action @@ -179699,12 +182334,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *737 - installation: *738 - number: *790 - organization: *739 - pull_request: *791 - repository: *740 + enterprise: *736 + installation: *737 + number: *789 + organization: *738 + pull_request: *790 + repository: *739 sender: *4 required: - action @@ -180070,9 +182705,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 pull_request: type: object properties: @@ -182264,7 +184899,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *740 + repository: *739 sender: *4 required: - action @@ -182359,7 +184994,7 @@ x-webhooks: type: string enum: - deleted - comment: &794 + comment: &793 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -182644,9 +185279,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 pull_request: type: object properties: @@ -184826,7 +187461,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *740 + repository: *739 sender: *4 required: - action @@ -184921,11 +187556,11 @@ x-webhooks: type: string enum: - edited - changes: *793 - comment: *794 - enterprise: *737 - installation: *738 - organization: *739 + changes: *792 + comment: *793 + enterprise: *736 + installation: *737 + organization: *738 pull_request: type: object properties: @@ -187108,7 +189743,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *740 + repository: *739 sender: *4 required: - action @@ -187204,9 +189839,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 pull_request: title: Simple Pull Request type: object @@ -189401,7 +192036,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *740 + repository: *739 review: description: The review that was affected. type: object @@ -189663,9 +192298,9 @@ x-webhooks: type: string required: - from - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 pull_request: title: Simple Pull Request type: object @@ -191719,8 +194354,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *740 - review: &795 + repository: *739 + review: &794 description: The review that was affected. type: object properties: @@ -191961,12 +194596,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 number: description: The pull request number. type: integer - organization: *739 + organization: *738 pull_request: title: Pull Request type: object @@ -194271,7 +196906,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *740 + repository: *739 requested_reviewer: title: User type: object @@ -194355,12 +196990,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 number: description: The pull request number. type: integer - organization: *739 + organization: *738 pull_request: title: Pull Request type: object @@ -196672,7 +199307,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *740 + repository: *739 requested_team: title: Team description: Groups of organization members that gives permissions @@ -196887,12 +199522,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 number: description: The pull request number. type: integer - organization: *739 + organization: *738 pull_request: title: Pull Request type: object @@ -199199,7 +201834,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *740 + repository: *739 requested_reviewer: title: User type: object @@ -199284,12 +201919,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *737 - installation: *738 + enterprise: *736 + installation: *737 number: description: The pull request number. type: integer - organization: *739 + organization: *738 pull_request: title: Pull Request type: object @@ -201587,7 +204222,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *740 + repository: *739 requested_team: title: Team description: Groups of organization members that gives permissions @@ -201791,9 +204426,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 pull_request: title: Simple Pull Request type: object @@ -203990,8 +206625,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *740 - review: *795 + repository: *739 + review: *794 sender: *4 required: - action @@ -204086,9 +206721,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 pull_request: title: Simple Pull Request type: object @@ -206180,7 +208815,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *740 + repository: *739 sender: *4 thread: type: object @@ -206575,9 +209210,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 pull_request: title: Simple Pull Request type: object @@ -208655,7 +211290,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *740 + repository: *739 sender: *4 thread: type: object @@ -209053,10 +211688,10 @@ x-webhooks: type: string before: type: string - enterprise: *737 - installation: *738 - number: *790 - organization: *739 + enterprise: *736 + installation: *737 + number: *789 + organization: *738 pull_request: title: Pull Request type: object @@ -211349,7 +213984,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *740 + repository: *739 sender: *4 required: - action @@ -211446,11 +214081,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *796 - enterprise: *737 - installation: *738 - number: *790 - organization: *739 + assignee: *795 + enterprise: *736 + installation: *737 + number: *789 + organization: *738 pull_request: title: Pull Request type: object @@ -213755,7 +216390,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *740 + repository: *739 sender: *4 required: - action @@ -213849,11 +216484,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *737 - installation: *738 - label: *758 - number: *790 - organization: *739 + enterprise: *736 + installation: *737 + label: *757 + number: *789 + organization: *738 pull_request: title: Pull Request type: object @@ -216148,7 +218783,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *740 + repository: *739 sender: *4 required: - action @@ -216244,10 +218879,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *737 - installation: *738 - number: *790 - organization: *739 + enterprise: *736 + installation: *737 + number: *789 + organization: *738 pull_request: title: Pull Request type: object @@ -218534,7 +221169,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *740 + repository: *739 sender: *4 required: - action @@ -218749,7 +221384,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *737 + enterprise: *736 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -218841,8 +221476,8 @@ x-webhooks: - url - author - committer - installation: *738 - organization: *739 + installation: *737 + organization: *738 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -219428,9 +222063,9 @@ x-webhooks: type: string enum: - published - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 registry_package: type: object properties: @@ -219876,7 +222511,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *777 + items: *776 summary: type: string tag_name: @@ -219930,7 +222565,7 @@ x-webhooks: - owner - package_version - registry - repository: *740 + repository: *739 sender: *4 required: - action @@ -220008,9 +222643,9 @@ x-webhooks: type: string enum: - updated - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 registry_package: type: object properties: @@ -220318,7 +222953,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *777 + items: *776 summary: type: string tag_name: @@ -220367,7 +223002,7 @@ x-webhooks: - owner - package_version - registry - repository: *740 + repository: *739 sender: *4 required: - action @@ -220444,10 +223079,10 @@ x-webhooks: type: string enum: - created - enterprise: *737 - installation: *738 - organization: *739 - release: &797 + enterprise: *736 + installation: *737 + organization: *738 + release: &796 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -220765,7 +223400,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *740 + repository: *739 sender: *4 required: - action @@ -220842,11 +223477,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *737 - installation: *738 - organization: *739 - release: *797 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + release: *796 + repository: *739 sender: *4 required: - action @@ -220963,11 +223598,11 @@ x-webhooks: type: boolean required: - to - enterprise: *737 - installation: *738 - organization: *739 - release: *797 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + release: *796 + repository: *739 sender: *4 required: - action @@ -221045,9 +223680,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -221369,7 +224004,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *740 + repository: *739 sender: *4 required: - action @@ -221445,10 +224080,10 @@ x-webhooks: type: string enum: - published - enterprise: *737 - installation: *738 - organization: *739 - release: &798 + enterprise: *736 + installation: *737 + organization: *738 + release: &797 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -221767,7 +224402,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *740 + repository: *739 sender: *4 required: - action @@ -221843,11 +224478,11 @@ x-webhooks: type: string enum: - released - enterprise: *737 - installation: *738 - organization: *739 - release: *797 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + release: *796 + repository: *739 sender: *4 required: - action @@ -221923,11 +224558,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *737 - installation: *738 - organization: *739 - release: *798 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + release: *797 + repository: *739 sender: *4 required: - action @@ -222003,11 +224638,11 @@ x-webhooks: type: string enum: - published - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 - repository_advisory: *659 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 + repository_advisory: *658 sender: *4 required: - action @@ -222083,11 +224718,11 @@ x-webhooks: type: string enum: - reported - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 - repository_advisory: *659 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 + repository_advisory: *658 sender: *4 required: - action @@ -222163,10 +224798,10 @@ x-webhooks: type: string enum: - archived - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -222243,10 +224878,10 @@ x-webhooks: type: string enum: - created - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -222324,10 +224959,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -222411,10 +225046,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -222526,10 +225161,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -222601,10 +225236,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 status: type: string @@ -222685,10 +225320,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -222765,10 +225400,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -222862,10 +225497,10 @@ x-webhooks: - name required: - repository - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -222945,11 +225580,11 @@ x-webhooks: type: string enum: - created - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 - repository_ruleset: *326 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 + repository_ruleset: *325 sender: *4 required: - action @@ -223027,11 +225662,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 - repository_ruleset: *326 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 + repository_ruleset: *325 sender: *4 required: - action @@ -223109,11 +225744,11 @@ x-webhooks: type: string enum: - edited - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 - repository_ruleset: *326 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 + repository_ruleset: *325 changes: type: object properties: @@ -223132,16 +225767,16 @@ x-webhooks: properties: added: type: array - items: *300 + items: *299 deleted: type: array - items: *300 + items: *299 updated: type: array items: type: object properties: - condition: *300 + condition: *299 changes: type: object properties: @@ -223174,16 +225809,16 @@ x-webhooks: properties: added: type: array - items: *615 + items: *614 deleted: type: array - items: *615 + items: *614 updated: type: array items: type: object properties: - rule: *615 + rule: *614 changes: type: object properties: @@ -223417,10 +226052,10 @@ x-webhooks: - from required: - owner - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -223498,10 +226133,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -223579,7 +226214,7 @@ x-webhooks: type: string enum: - create - alert: &799 + alert: &798 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -223701,10 +226336,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -223910,10 +226545,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -223991,11 +226626,11 @@ x-webhooks: type: string enum: - reopen - alert: *799 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + alert: *798 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -224194,10 +226829,10 @@ x-webhooks: enum: - fixed - open - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -224275,11 +226910,11 @@ x-webhooks: type: string enum: - assigned - alert: &800 + alert: &799 type: object properties: - number: *179 - created_at: *180 + number: *178 + created_at: *179 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -224287,8 +226922,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *182 - html_url: *183 + url: *181 + html_url: *182 locations_url: type: string format: uri @@ -224394,10 +227029,10 @@ x-webhooks: required: *21 nullable: true assignee: *4 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -224475,11 +227110,11 @@ x-webhooks: type: string enum: - created - alert: *800 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + alert: *799 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -224560,11 +227195,11 @@ x-webhooks: type: string enum: - created - alert: *800 - installation: *738 - location: *801 - organization: *739 - repository: *740 + alert: *799 + installation: *737 + location: *800 + organization: *738 + repository: *739 sender: *4 required: - location @@ -224802,11 +227437,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *800 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + alert: *799 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -224884,11 +227519,11 @@ x-webhooks: type: string enum: - reopened - alert: *800 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + alert: *799 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -224966,11 +227601,11 @@ x-webhooks: type: string enum: - resolved - alert: *800 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + alert: *799 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -225048,12 +227683,12 @@ x-webhooks: type: string enum: - unassigned - alert: *800 + alert: *799 assignee: *4 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -225131,11 +227766,11 @@ x-webhooks: type: string enum: - validated - alert: *800 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + alert: *799 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -225261,10 +227896,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *740 - enterprise: *737 - installation: *738 - organization: *739 + repository: *739 + enterprise: *736 + installation: *737 + organization: *738 sender: *4 required: - action @@ -225342,11 +227977,11 @@ x-webhooks: type: string enum: - published - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 - security_advisory: &802 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 + security_advisory: &801 description: The details of the security advisory, including summary, description, and severity. type: object @@ -225547,11 +228182,11 @@ x-webhooks: type: string enum: - updated - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 - security_advisory: *802 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 + security_advisory: *801 sender: *4 required: - action @@ -225624,10 +228259,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -225819,11 +228454,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *299 - enterprise: *737 - installation: *738 - organization: *739 - repository: *347 + security_and_analysis: *298 + enterprise: *736 + installation: *737 + organization: *738 + repository: *346 sender: *4 required: - changes @@ -225901,12 +228536,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 - sponsorship: &803 + sponsorship: &802 type: object properties: created_at: @@ -226207,12 +228842,12 @@ x-webhooks: type: string enum: - created - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 - sponsorship: *803 + sponsorship: *802 required: - action - sponsorship @@ -226300,12 +228935,12 @@ x-webhooks: type: string required: - from - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 - sponsorship: *803 + sponsorship: *802 required: - action - changes @@ -226382,17 +229017,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &804 + effective_date: &803 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: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 - sponsorship: *803 + sponsorship: *802 required: - action - sponsorship @@ -226466,7 +229101,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &805 + changes: &804 type: object properties: tier: @@ -226510,13 +229145,13 @@ x-webhooks: - from required: - tier - effective_date: *804 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + effective_date: *803 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 - sponsorship: *803 + sponsorship: *802 required: - action - changes @@ -226593,13 +229228,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *805 - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + changes: *804 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 - sponsorship: *803 + sponsorship: *802 required: - action - changes @@ -226673,10 +229308,10 @@ x-webhooks: type: string enum: - created - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -226759,10 +229394,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -227182,15 +229817,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *737 + enterprise: *736 id: description: The unique identifier of the status. type: integer - installation: *738 + installation: *737 name: type: string - organization: *739 - repository: *740 + organization: *738 + repository: *739 sender: *4 sha: description: The Commit SHA. @@ -227305,9 +229940,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *85 - installation: *738 - organization: *739 - repository: *740 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -227397,9 +230032,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *85 - installation: *738 - organization: *739 - repository: *740 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -227489,9 +230124,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *85 - installation: *738 - organization: *739 - repository: *740 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -227581,9 +230216,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *85 - installation: *738 - organization: *739 - repository: *740 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -227660,12 +230295,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 - team: &806 + team: &805 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -227888,9 +230523,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 repository: title: Repository description: A git repository @@ -228348,7 +230983,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *806 + team: *805 required: - action - team @@ -228424,9 +231059,9 @@ x-webhooks: type: string enum: - created - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 repository: title: Repository description: A git repository @@ -228884,7 +231519,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *806 + team: *805 required: - action - team @@ -228961,9 +231596,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 repository: title: Repository description: A git repository @@ -229421,7 +232056,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *806 + team: *805 required: - action - team @@ -229565,9 +232200,9 @@ x-webhooks: - from required: - permissions - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 repository: title: Repository description: A git repository @@ -230025,7 +232660,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *806 + team: *805 required: - action - changes @@ -230103,9 +232738,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *737 - installation: *738 - organization: *739 + enterprise: *736 + installation: *737 + organization: *738 repository: title: Repository description: A git repository @@ -230563,7 +233198,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *806 + team: *805 required: - action - team @@ -230639,10 +233274,10 @@ x-webhooks: type: string enum: - started - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 required: - action @@ -230715,16 +233350,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *737 + enterprise: *736 inputs: type: object nullable: true additionalProperties: true - installation: *738 - organization: *739 + installation: *737 + organization: *738 ref: type: string - repository: *740 + repository: *739 sender: *4 workflow: type: string @@ -230806,10 +233441,10 @@ x-webhooks: type: string enum: - completed - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 workflow_job: allOf: @@ -231046,7 +233681,7 @@ x-webhooks: type: string required: - conclusion - deployment: *505 + deployment: *504 required: - action - repository @@ -231125,10 +233760,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 workflow_job: allOf: @@ -231388,7 +234023,7 @@ x-webhooks: required: - status - steps - deployment: *505 + deployment: *504 required: - action - repository @@ -231467,10 +234102,10 @@ x-webhooks: type: string enum: - queued - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 workflow_job: type: object @@ -231605,7 +234240,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *505 + deployment: *504 required: - action - repository @@ -231684,10 +234319,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 workflow_job: type: object @@ -231823,7 +234458,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *505 + deployment: *504 required: - action - repository @@ -231903,12 +234538,12 @@ x-webhooks: type: string enum: - completed - enterprise: *737 - installation: *738 - organization: *739 - repository: *740 + enterprise: *736 + installation: *737 + organization: *738 + repository: *739 sender: *4 - workflow: *754 + workflow: *753 workflow_run: title: Workflow Run type: object @@ -232907,12 +23{"code":"deadline_exceeded","msg":"operation timed out"}